Module: x2node-ws-resources

Persistent resources for the web services module.

Requires

Classes

CollectionResourceHandler
IndividualResourceHandler
AbstractResourceHandler
ResourceHandlersFactory
TransactionContext

Mixins

HandlerExtension

Methods


<static> createResourceHandlersFactory(ds, dboFactory [, defaultOptions])

Create resource handlers factory.
Parameters:
Name Type Argument Description
ds module:x2node-dbos.DataSource Data source.
dboFactory module:x2node-dbos~DBOFactory DBO factory.
defaultOptions Object <optional>
Default options for handlers.

Type Definitions


CreateTransactionContext

Context object for a new record creation operation.
Type:
Properties:
Name Type Description
recordTmpl Object

DeleteTransactionContext

Context object for a record deletion operation.
Type:
Properties:
Name Type Description
selectionFilter Object
queryParams Object.<string, *>
deleteResult module:x2node-dbos~DeleteDBO~Result

ReadTransactionContext

Context object for a single record read operation.
Type:
Properties:
Name Type Description
querySpec Object
queryParams Object.<string, *>

SearchTransactionContext

Context object for a record search operation.
Type:
Properties:
Name Type Description
querySpec Object Query specification built from the search parameters. Can be modified by the hook.
queryParams Object.<string, *>

UpdateTransactionContext

Context object for a record update operation.
Type:
Properties:
Name Type Description
patchSpec Object
patch module:x2node-patches~RecordPatch
selectionFilter Object
queryParams Object.<string, *>
updateResult module:x2node-dbos~UpdateDBO~Result