com.ibm.xdms.function
Interface DatastoreDelete

All Superinterfaces:
Function

public interface DatastoreDelete
extends Function

Datastore Implementation for Get functions


Field Summary
static java.lang.String ATTR_REQUEST_PATCH_OPS
          Request attribute to store the Patch Operations Request Attribute
static java.lang.String ATTR_REQUEST_UPDATED_DOC
          Request attribute to store the updated document from a Node Selector PUT or DELETE
static java.lang.String ATTR_USER_TRANSACTION
          Request attribute to store the datastore's UserTransaction object
static java.lang.String PATCH_OPS_ADD
          Patch Operations Add Value
static java.lang.String PATCH_OPS_REMOVE
          Patch Operations Remove Value
static java.lang.String PATCH_OPS_REPLACE
          Path Operations Replace Value
 
Fields inherited from interface com.ibm.xdms.function.Function
COPYRIGHT
 
Method Summary
 long deleteNodeSelector(XcapServerRequest request, XcapServerResponse response, java.lang.String documentSelector, com.ibm.xcap.NodeSelector nodeSelector, javax.sql.DataSource dataSource, java.lang.String table, ApplicationUsage appUsage)
           
 void deleteWholeDocument(XcapServerRequest request, XcapServerResponse response, java.lang.String documentSelector, javax.sql.DataSource dataSource)
           
 java.lang.String getPwsUpdateSql(java.lang.String table, java.lang.String documentString)
          Provides Update SQL method that preserves whitespace.
 boolean init(ApplicationUsage appUsage)
          Initializes the function.
 
Methods inherited from interface com.ibm.xdms.function.Function
getApplicationUsage
 

Field Detail

ATTR_REQUEST_PATCH_OPS

static final java.lang.String ATTR_REQUEST_PATCH_OPS
Request attribute to store the Patch Operations Request Attribute

See Also:
Constant Field Values

PATCH_OPS_ADD

static final java.lang.String PATCH_OPS_ADD
Patch Operations Add Value

See Also:
Constant Field Values

PATCH_OPS_REMOVE

static final java.lang.String PATCH_OPS_REMOVE
Patch Operations Remove Value

See Also:
Constant Field Values

PATCH_OPS_REPLACE

static final java.lang.String PATCH_OPS_REPLACE
Path Operations Replace Value

See Also:
Constant Field Values

ATTR_REQUEST_UPDATED_DOC

static final java.lang.String ATTR_REQUEST_UPDATED_DOC
Request attribute to store the updated document from a Node Selector PUT or DELETE

See Also:
Constant Field Values

ATTR_USER_TRANSACTION

static final java.lang.String ATTR_USER_TRANSACTION
Request attribute to store the datastore's UserTransaction object

See Also:
Constant Field Values
Method Detail

init

boolean init(ApplicationUsage appUsage)
Description copied from interface: Function
Initializes the function.

Specified by:
init in interface Function
Parameters:
appUsage - The ApplicationUsage information.
Returns:
Returns true if the function successfully initialized.

deleteWholeDocument

void deleteWholeDocument(XcapServerRequest request,
                         XcapServerResponse response,
                         java.lang.String documentSelector,
                         javax.sql.DataSource dataSource)
                         throws XcapException
Parameters:
request -
response -
documentSelector -
dataSource -
Throws:
XcapException

deleteNodeSelector

long deleteNodeSelector(XcapServerRequest request,
                        XcapServerResponse response,
                        java.lang.String documentSelector,
                        com.ibm.xcap.NodeSelector nodeSelector,
                        javax.sql.DataSource dataSource,
                        java.lang.String table,
                        ApplicationUsage appUsage)
                        throws XcapException
Parameters:
request -
response -
documentSelector -
nodeSelector -
dataSource -
table -
appUsage -
Returns:
Throws:
XcapException

getPwsUpdateSql

java.lang.String getPwsUpdateSql(java.lang.String table,
                                 java.lang.String documentString)
Provides Update SQL method that preserves whitespace. IMPORTANT: This method needs to be overwritten in database specific DeleteImpl

Parameters:
table -
documentString -
Returns: