X2 Framework for Node.js

Class: CollectionResourceHandler

x2node-ws-resources~ CollectionResourceHandler

Standard collection resource web wervice endpoint handler.

new CollectionResourceHandler(ds, dboFactory, rsrcPath [, options])

Create new handler.
Parameters:
Name Type Argument Description
ds module:x2node-dbos.DataSource Data source.
dboFactory module:x2node-dbos~DBOFactory DBO factory.
rsrcPath string Resource path.
options Object <optional>
 Options.
Implements:

Extends

Members

_dboFactory :module:x2node-dbos~DBOFactory

The DBO factory.
Type:
Inherited From:
Overrides:

_log :function

Debug logger.
Type:
  • function
Inherited From:
Overrides:

_options :Object

Options. Always present, always has sections for the methods.
Type:
  • Object
Inherited From:
Overrides:

_recordTypeDesc :module:x2node-records~RecordTypeDescriptor

Record type descriptor.
Type:
Inherited From:
Overrides:

_recordTypeName :string

Record type name.
Type:
  • string
Inherited From:
Overrides:

_recordTypes :module:x2node-records~RecordTypesLibrary

Record types library.
Type:
Inherited From:
Overrides:

_txFactory :module:x2node-dbos~TxFactory

The transaction factory.
Type:
Inherited From:
Overrides:

Methods

_createTransactionContext(call)

Create new transaction context object.
Parameters:
Name Type Description
call module:x2node-ws~ServiceCall The call.
Inherited From:
Overrides:
Returns:
New context.
Type
module:x2node-ws-resources~TransactionContext

enableBulkUpdate()

Enable bulk update operation by allowing PATCH method for the collection. Can be called from the handler extension's configure() method.