Packageorg.restfulx.services
Interfacepublic interface ISyncingServiceProvider extends IServiceProvider
ImplementorsAIRServiceProvider

This interface identifies Service Providers that are capable of tracking synchronization related metadata.


Public Properties
 PropertyDefined by
 Inheritedid : int
ID uniquely identifies this service provider.
IServiceProvider
Public Methods
 MethodDefined by
  
beginTransaction():void
If the service provider supports it, this begins a transaction
ISyncingServiceProvider
 Inherited
canLazyLoad():Boolean
Indicates if this service provider can perform lazy loading.
IServiceProvider
  
commitTransaction(responder:IResponder = null):void
If the service provider supports it, this commits the currently active transaction
ISyncingServiceProvider
 Inherited
create(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void
RESTful CRUD contract: create method.
IServiceProvider
 Inherited
destroy(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void
RESTful CRUD contract: destroy method.
IServiceProvider
  
dirty(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void
Idenfies all the instances for a particular class of models that need to be synchronized
ISyncingServiceProvider
  
getLastPullTimeStamp(object:Object, responder:IResponder):void
Gets the last time (timestamp originates on the server) a sync was performed with the central server
ISyncingServiceProvider
 Inherited
hasErrors(object:Object):Boolean
Indicates to the ServiceResponder that this particular run (typically create/update or destroy) has produced errors.
IServiceProvider
 Inherited
index(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void
RESTful CRUD contract: index method.
IServiceProvider
 Inherited
marshall(object:Object, recursive:Boolean = false):Object
Produces service provider specific model representation suitable for being serialized.
IServiceProvider
  
purge(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false):void
Tries to eallydelete an object as opposed to just mark it for deletion.
ISyncingServiceProvider
 Inherited
show(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void
RESTful CRUD contract: show method.
IServiceProvider
  
sync(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void
Mark a specific model object as synced
ISyncingServiceProvider
 Inherited
unmarshall(object:Object, disconnected:Boolean = false, defaultType:String = null):Object
The reverse of marshall.
IServiceProvider
 Inherited
update(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void
RESTful CRUD contract: update method.
IServiceProvider
  
updateLastPullTimeStamp(object:Object, value:String):void
Updates the last time (timestamp originates on the server) a sync was performed with the central server
ISyncingServiceProvider
Method detail
beginTransaction()method
public function beginTransaction():void

If the service provider supports it, this begins a transaction

commitTransaction()method 
public function commitTransaction(responder:IResponder = null):void

If the service provider supports it, this commits the currently active transaction

Parameters
responder:IResponder (default = null)
dirty()method 
public function dirty(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void

Idenfies all the instances for a particular class of models that need to be synchronized

Parameters
object:Object — object to find versions for (typically a model class)
 
responder:IResponder — the responder that must be called on versions
 
metadata:Object (default = null) — any metadata that must be appended with the index request
 
nestedBy:Array (default = null) — an array of model instances that will be used to nest this request, e.g.: [project, user] where project is some Project model instance and user is some User model instance. In case of XMLHTTPServiceProvider nesting may require additional configuration on the server. If you are using Rails see config/routes.rb for more details.
getLastPullTimeStamp()method 
public function getLastPullTimeStamp(object:Object, responder:IResponder):void

Gets the last time (timestamp originates on the server) a sync was performed with the central server

Parameters
object:Object — object to get timestamp for (typically a model class)
 
responder:IResponder
purge()method 
public function purge(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false):void

Tries to eallydelete an object as opposed to just mark it for deletion.

Parameters
object:Object — object to find versions for (typically a model class)
 
responder:IResponder — the responder that must be called on versions
 
metadata:Object (default = null) — any metadata that must be appended with the index request
 
nestedBy:Array (default = null) — an array of model instances that will be used to nest this request, e.g.: [project, user] where project is some Project model instance and user is some User model instance. In case of XMLHTTPServiceProvider nesting may require additional configuration on the server. If you are using Rails see config/routes.rb for more details.
 
recursive:Boolean (default = false) — indicates if a purge operations should be recusrive
sync()method 
public function sync(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void

Mark a specific model object as synced

Parameters
object:Object — object to find versions for (typically a model class instance)
 
responder:IResponder — the responder that must be called on versions
 
metadata:Object (default = null) — any metadata that must be appended with the index request
 
nestedBy:Array (default = null) — an array of model instances that will be used to nest this request, e.g.: [project, user] where project is some Project model instance and user is some User model instance. In case of XMLHTTPServiceProvider nesting may require additional configuration on the server. If you are using Rails see config/routes.rb for more details.
updateLastPullTimeStamp()method 
public function updateLastPullTimeStamp(object:Object, value:String):void

Updates the last time (timestamp originates on the server) a sync was performed with the central server

Parameters
object:Object — object object to update timestamp for (typically a model class)
 
value:String