Packageorg.restfulx.serializers
Interfacepublic interface ISerializer
ImplementorsGenericSerializer

Serves as a contract between various serializers and the rest of the framework. Serializers are really expected to expose 2 methods only:


Public Methods
 MethodDefined by
  
marshall(object:Object, recursive:Boolean = false):Object
Produces serialized model representation.
ISerializer
  
unmarshall(object:Object, disconnected:Boolean = false, defaultType:String = null):Object
The reverse of marshall.
ISerializer
Method detail
marshall()method
public function marshall(object:Object, recursive:Boolean = false):Object

Produces serialized model representation. For example, XMLSerializer would return XML.

Parameters
object:Object — object to marshall into serialized form
 
recursive:Boolean (default = false) — flag indicating if entire object graph should be serialized inline

Returns
Object
unmarshall()method 
public function unmarshall(object:Object, disconnected:Boolean = false, defaultType:String = null):Object

The reverse of marshall. Takes a serialized form and turns it into an object graph of models.

Parameters
object:Object — source object from the service provider/responder
 
disconnected:Boolean (default = false) — if true the object will not be reconnected with anything in the cache
 
defaultType:String (default = null) — if no known type can be inferred, use the type given as a fallback

Returns
Object — connected object graph of the model corresponding to the response