org.restfulx.services.as3http.DirectCouchDBHTTPServiceProvider

	Property	Defined by
		id : int [read-only] ID uniquely identifies this service provider.	DirectCouchDBHTTPServiceProvider

	Property	Defined by
		contentType : String	DirectCouchDBHTTPServiceProvider
		dbName : String	DirectCouchDBHTTPServiceProvider
		rootUrl : String	DirectCouchDBHTTPServiceProvider
		serializer : ISerializer	DirectCouchDBHTTPServiceProvider
		state : ModelsMetadata	DirectCouchDBHTTPServiceProvider

	Method	Defined by
		DirectCouchDBHTTPServiceProvider(couchDbRootUrl:String = null, couchDbName:String = null)	DirectCouchDBHTTPServiceProvider
		canLazyLoad():Boolean Indicates if this service provider can perform lazy loading.	DirectCouchDBHTTPServiceProvider
		create(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void RESTful CRUD contract: create method.	DirectCouchDBHTTPServiceProvider
		createDatabase(callback:Function):void	DirectCouchDBHTTPServiceProvider
		deleteDatabase(callback:Function):void	DirectCouchDBHTTPServiceProvider
		destroy(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void RESTful CRUD contract: destroy method.	DirectCouchDBHTTPServiceProvider
		getDatabaseInfo(callback:Function):void	DirectCouchDBHTTPServiceProvider
		hasErrors(object:Object):Boolean Indicates to the ServiceResponder that this particular run (typically create/update or destroy) has produced errors.	DirectCouchDBHTTPServiceProvider
		index(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void RESTful CRUD contract: index method.	DirectCouchDBHTTPServiceProvider
		listDatabases(callback:Function):void	DirectCouchDBHTTPServiceProvider
		marshall(object:Object, recursive:Boolean = false):Object Produces service provider specific model representation suitable for being serialized.	DirectCouchDBHTTPServiceProvider
		show(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void RESTful CRUD contract: show method.	DirectCouchDBHTTPServiceProvider
		unmarshall(object:Object, disconnected:Boolean = false, defaultType:String = null):Object The reverse of marshall.	DirectCouchDBHTTPServiceProvider
		update(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void RESTful CRUD contract: update method.	DirectCouchDBHTTPServiceProvider

	Method	Defined by
		getCouchDBURI(url:String):URI	DirectCouchDBHTTPServiceProvider
		getCreateOrUpdateHttpClient(object:Object, responder:IResponder, metadata:Object, nestedBy:Array, recursive:Boolean = false, undoRedoFlag:int = 0, creating:Boolean = false):HttpClient	DirectCouchDBHTTPServiceProvider
		getHttpClient(onDataComplete:Function, onError:Function = null):HttpClient	DirectCouchDBHTTPServiceProvider
		getModelDestroyURI(object:Object):URI	DirectCouchDBHTTPServiceProvider
		getShowHttpClient(object:Object, responder:IResponder):HttpClient	DirectCouchDBHTTPServiceProvider
		marshallToJSON(object:Object, recursive:Boolean = false):String	DirectCouchDBHTTPServiceProvider
		marshallToJSONAndConvertToByteArray(object:Object):ByteArray	DirectCouchDBHTTPServiceProvider
		modelCanBeUpdatedOrDestroyed(model:Object):Boolean	DirectCouchDBHTTPServiceProvider

	Constant	Defined by
		ID : int [static] service id	DirectCouchDBHTTPServiceProvider

Property detail

contentType

property

protected var contentType:String

dbName

property

protected var dbName:String

property

id:int [read-only]

ID uniquely identifies this service provider. This is typically obtained from ServiceManager like so: public static const ID:int = ServiceManager.generateId(); You can then wrap around this with a getter: public function get id():int { return ID; }

Implementation
public function get id():int

rootUrl

property

protected var rootUrl:String

serializer

property

protected var serializer:ISerializer

state

property

protected var state:ModelsMetadata

Constructor detail

DirectCouchDBHTTPServiceProvider

()

constructor

public function DirectCouchDBHTTPServiceProvider(couchDbRootUrl:String = null, couchDbName:String = null)Parameters

	`couchDbRootUrl:String` (default = `null`)

	`couchDbName:String` (default = `null`)

Method detail

canLazyLoad

()

method

public function canLazyLoad():Boolean

Indicates if this service provider can perform lazy loading. RxModelsController will then skip pre-fetching of the lazy dependencies and it's the responsibility of the provider to make sure that the data that was requested is loaded (perhaps via nesting, etc).

Returns

Boolean — true if the service provider can lazy load, false otherwise

create

()

method

public function create(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void

RESTful CRUD contract: create method. Same semantics as Rails RESTful controller create.

Parameters

	`object:Object` — object to create (typically a new model instance)

	`responder:IResponder` — the responder that must be called on index

	`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 recursive create (object + all children) should be performed

	`undoRedoFlag:int` (default = `0`) — indicates if it's a normal invocation, undo invocation or redo invocation

createDatabase

()

method

public function createDatabase(callback:Function):voidParameters

callback:Function

deleteDatabase

()

method

public function deleteDatabase(callback:Function):voidParameters

callback:Function

destroy

()

method

public function destroy(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void

RESTful CRUD contract: destroy method. Same semantics as Rails RESTful controller destroy.

Parameters

	`object:Object` — object to destroy (typically an existing model instance)

	`responder:IResponder` — the responder that must be called on index

	`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 recursive create (object + all children) should be performed

	`undoRedoFlag:int` (default = `0`) — indicates if it's a normal invocation, undo invocation or redo invocation

getCouchDBURI

()

method

protected function getCouchDBURI(url:String):URIParameters

url:String

Returns

URI

getCreateOrUpdateHttpClient

()

method

protected function getCreateOrUpdateHttpClient(object:Object, responder:IResponder, metadata:Object, nestedBy:Array, recursive:Boolean = false, undoRedoFlag:int = 0, creating:Boolean = false):HttpClient

Parameters

	`object:Object`

	`responder:IResponder`

	`metadata:Object`

	`nestedBy:Array`

	`recursive:Boolean` (default = `false`)

	`undoRedoFlag:int` (default = `0`)

	`creating:Boolean` (default = `false`)

Returns

HttpClient

getDatabaseInfo

()

method

public function getDatabaseInfo(callback:Function):voidParameters

callback:Function

getHttpClient

()

method

protected function getHttpClient(onDataComplete:Function, onError:Function = null):HttpClientParameters

	`onDataComplete:Function`

	`onError:Function` (default = `null`)

Returns

HttpClient

getModelDestroyURI

()

method

protected function getModelDestroyURI(object:Object):URIParameters

object:Object

Returns

URI

getShowHttpClient

()

method

protected function getShowHttpClient(object:Object, responder:IResponder):HttpClientParameters

	`object:Object`

	`responder:IResponder`

Returns

HttpClient

hasErrors

()

method

public function hasErrors(object:Object):Boolean

Indicates to the ServiceResponder that this particular run (typically create/update or destroy) has produced errors. This typically means that response processing must be terminated and instead errors should be displayed.

Parameters

object:Object — the response object being processed

Returns

Boolean — true if there are errors false otherwise

index

()

method

public function index(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void

RESTful CRUD contract: index method. Same semantics as Rails RESTful controller index.

Parameters

	`object:Object` — object to index (typically a class like Project, etc)

	`responder:IResponder` — the responder that must be called on index

	`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.

listDatabases

()

method

public function listDatabases(callback:Function):voidParameters

callback:Function

marshall

()

method

public function marshall(object:Object, recursive:Boolean = false):Object

Produces service provider specific model representation suitable for being serialized. For example, XMLHTTPServiceProvider 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

marshallToJSON

()

method

protected function marshallToJSON(object:Object, recursive:Boolean = false):StringParameters

	`object:Object`

	`recursive:Boolean` (default = `false`)

Returns

String

marshallToJSONAndConvertToByteArray

()

method

protected function marshallToJSONAndConvertToByteArray(object:Object):ByteArrayParameters

object:Object

Returns

ByteArray

modelCanBeUpdatedOrDestroyed

()

method

protected function modelCanBeUpdatedOrDestroyed(model:Object):BooleanParameters

model:Object

Returns

Boolean

show

()

method

public function show(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null):void

RESTful CRUD contract: show method. Same semantics as Rails RESTful controller show.

Parameters

	`object:Object` — object to show (typically a model instance as opposed to class)

	`responder:IResponder` — the responder that must be called on index

	`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.

unmarshall

()

method

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

The reverse of marshall. Takes a response from the underlying service provider and turns it into an object graph of models.

Parameters

	`object:Object` — source object from the service provider/responder

	`disconnected:Boolean` (default = `false`) — a flag indicating that the object should not be reconnected with the cache

	`defaultType:String` (default = `null`) — default type to use if the type cannot be determined by the serializer

Returns

Object — (dis)connected object graph of the model corresponding to the response

update

()

method

public function update(object:Object, responder:IResponder, metadata:Object = null, nestedBy:Array = null, recursive:Boolean = false, undoRedoFlag:int = 0):void

RESTful CRUD contract: update method. Same semantics as Rails RESTful controller update.

Parameters

	`object:Object` — object to update (typically an existing model instance)

	`responder:IResponder` — the responder that must be called on index

	`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 recursive create (object + all children) should be performed

	`undoRedoFlag:int` (default = `0`) — indicates if it's a normal invocation, undo invocation or redo invocation

Constant detail

constant

public static const ID:int

service id

"RestfulX Framework 1.3.1 API Documenation"	All Packages \| All Classes \| Index \| Frames No Frames
Class DirectCouchDBHTTPServiceProvider	Properties \| Methods \| Constants

Package	org.restfulx.services.as3http
Class	public class DirectCouchDBHTTPServiceProvider
Implements	IServiceProvider
Subclasses	MockDirectCouchDBHTTPServiceProvider