Packageorg.restfulx.services
Interfacepublic interface IVersioningServiceProvider extends IServiceProvider

This interface adds versioning to the contract between service providers (such as HTTP, AIR, etc) and the rest of the framework.


Public Properties
 PropertyDefined by
 Inheritedid : int
ID uniquely identifies this service provider.
IServiceProvider
Public Methods
 MethodDefined by
 Inherited
canLazyLoad():Boolean
Indicates if this service provider can perform lazy loading.
IServiceProvider
  
cleanup(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void
Removes all versions of this object except the most recent one
IVersioningServiceProvider
 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
 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
 Inherited
show(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void
RESTful CRUD contract: show method.
IServiceProvider
 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
  
versions(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void
Idenfies existing versions for this object
IVersioningServiceProvider
Method detail
cleanup()method
public function cleanup(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void

Removes all versions of this object except the most recent one

Parameters
object:Object — object to find versions for (typically a model 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.
versions()method 
public function versions(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void

Idenfies existing versions for this object

Parameters
object:Object — object to find versions for (typically a model 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.