com.filenet.rm.bds
Interface BulkDisposeService
All Superinterfaces:
- public interface BulkDisposeService
- extends BaseBulkService
Method Summary
Modifier and Type | Method and Description |
---|---|
|
dispose(java.lang.String externalOpIdent,java.lang.String queryCondition,int entityType)
Runs the given queryCondition to get the result RM entities and dipose them.
|
|
dispose(java.lang.String externalOpIdent,java.util.Vector entityIds,int entityType)
Disposes of the Records Manager entities specified by the
entityIds
parameter.
|
|
startBatch(java.lang.String batchName,java.util.Map disposeOption)
Called to designate the start of a new batching operation and optionally provide options for disposal.
|
Methods inherited from interface com.filenet.rm.bds.BaseBulkService |
---|
cancelBatch, executeBatch, getBatchResultItems, getConfigurationInfo, getContextInfo, isInBatch, reexecuteBatch, startBatch |
Method Detail
dispose
- void dispose(java.lang.String externalOpIdent,
- java.util.Vector entityIds,
- int entityType)
Parameters:
externalOpIdent
- Optional operation identifier used to correlate with
eventual BatchResultItem instances. Can be null
.
See BaseBulkService.executeBatch()
. entityIds
- contains list of Ids and types of RM entities to be deleted. entityType
- contains type of entity to be deleted as follows:
Throws:
a
- BDSException
if any validation fails. dispose
- void dispose(java.lang.String externalOpIdent,
- java.lang.String queryCondition,
- int entityType)
Runs the given queryCondition to get the result RM entities and dipose them.
A validation exception prevents this operation from being added to the batch. Any previously contained batch operations are unaffected.
A parameter validation exception prevents this operation from being added to the batch. Any previously contained batch operations are unaffected.
Parameters:
externalOpIdent
- Optional operation identifier used to correlate with
eventual BatchResultItem instances. Can be null
.
See BaseBulkService.executeBatch()
. queryCondition
- query to be run to get result entities to be deleted.
The following strings represent valid queries.
Use the INFOLDER
keyword only to dispose of direct containees of the specified entity type.
Use the INSUBFOLDER
keyword to dispose of all containees of the specified
entity type recursively.
"Id IN(<entity id>, <entity id>, ...)"
"Id INFOLDER(<entity id>)"
"Id INSUBFOLDER(<entity id>)"
entityType
- contains type of entity to be deleted as follows:
Throws:
a
- BDSException
if any validation fails. startBatch
- void startBatch(java.lang.String batchName,
- java.util.Map disposeOption)
Called to designate the start of a new batching operation and optionally provide options for disposal.
Subsequent batch operations will be accumulated into this batch.
until either an
executeBatch
or resetBatch
call is made.
The disposeOption
parameter is a hash map that specifies the dispose options
for the batch as shown in the following example:
HashMap disposeOptions = new HashMap();
// use default option BDSConstants.DISPOSAL_TYPE_AUTO_DESTROY
disposeOptions.put (BDSConstants.DISPOSAL_TYPES_OPTION, null);
// perform operation in 4 threads
disposeOptions.put (BDSConstants.THREAD_COUNT_OPTION, 4);
disposeService.startBatch("MyBatch", disposeOptions);
Parameters:
batchName
- optional name for this batch. Can be null
. disposeOption
- optional hash map that specifies the dispose options for this batch.
Can be null
. Throws:
entityIds
parameter.The
entityIds
parameter contains the ID and type of each entity that this method is to process.If a validation exception or parameter validation exception occurs, the BDS API prevents the dispose action from being added to the batch operation. Any previously contained batch operations are unaffected.