Main Page | Packages | Class Tree | Index | Help

xp.data

class Connector

Object
  |
  +--xp.system.DispatcherObject
        |
        +--xp.data.Connector

Implemented Interfaces: IDataSource
All Known Subclasses: CSVConnector, RTDataConnector, WSConnector, XMLConnector

class Connector
extends DispatcherObject

Base class for all server connectors

The Connector class lets execute RPCCalls. The base class for all connectors
WSConnector,RSConnector,CSVConnector and XMLConnector
Event summary for the Connector class
The following table lists events of the Connector class.





EventTypeDescription
xp.events.ModelChangedEventmodeChangedBroadcast when the data model changes.
xp.events.EventresultBroadcast after a result param has been received from teh server.
xp.events.EventsendBroadcast after a send has been initiated.
xp.events.RPCStatusEventstatusBroadcast when the connector status changes.
xp.events.RPCValidateParamsEventvalidateBroadcast before a send when the call params need to be validated.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary

public
logEnabled: Boolean
Is logging enabled

public
multipleSimultaneousAllowed: Boolean
Indicates whether multiple calls can take place at the same time.

public
results: Object
Identifies data that was received from the server as a result of the trigger() operation.

public
suppressInvalidCalls: Boolean
Indicates whether to suppress a call if parameters are invalid.

Fields inherited from class xp.system.DispatcherObject

parent

Property Summary

public
callsInProgress: Number (read, write)
Gets/sets the number of calls currently in progress

public
currentItem: Object (read-only)
Returns the data that was received from the server as a result of the trigger() operation.

Constructor

public
Connector ( )
Create a new XMLConnector instance

Method Summary

public
onFault ( fault: Object ): Void
called by the pendingCall object when it has faults

public
onResult ( result: Object ): Void
called by the pendingCall object when it has results Despatches a result and modelChanged event

public
validateCall ( needsParams: Boolean, params: Object, operation: String ): Boolean
Validates a remote procedure call

Methods inherited from class xp.system.DispatcherObject

addEventListener, removeEventListener, routeEvent



Field Documentation

logEnabled

public var logEnabled: Boolean
Is logging enabled

multipleSimultaneousAllowed

public var multipleSimultaneousAllowed: Boolean
Indicates whether multiple calls can take place at the same time.

results

public var results: Object
Identifies data that was received from the server as a result of the trigger() operation.

suppressInvalidCalls

public var suppressInvalidCalls: Boolean
Indicates whether to suppress a call if parameters are invalid.


Property Documentation

callsInProgress

public callsInProgress: Number (read, write)
Gets/sets the number of calls currently in progress

currentItem

public currentItem: Object (read-only)
Returns the data that was received from the server as a result of the trigger() operation.


Constructor Documentation

Connector

public function Connector()
Create a new XMLConnector instance


Method Documentation

onFault

public function onFault(fault: Object): Void
called by the pendingCall object when it has faults

Parameters:
fault
The fault object

onResult

public function onResult(result: Object): Void
called by the pendingCall object when it has results Despatches a result and modelChanged event

Parameters:
result
The result of the call

validateCall

public function validateCall(needsParams: Boolean,
 params: Object,
 operation: String): Boolean
Validates a remote procedure call

Check whether the params are required and valid and other conditions

Parameters:
needsParams
Are params required
params
The params to be passed on the call
operation
The operation to be executed
Returns:
True if the call is valid, otherwise false


The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc