com.filenet.rm.bds
Interface BulkDeclarationService
- public interface BulkDeclarationService
- extends BaseBulkService
Method Summary
Modifier and Type | Method and Description |
---|---|
|
createDocument(java.lang.String operationIdent,DocumentDefinition documentDef)
Places a document creation operation into the current batch.
|
|
createDocumentAndDeclareRecord(java.lang.String operationIdent,java.util.List documentDefs,RecordDefinition recordDef)
Places a combined document creation(s)/record declaration operation into the batch
identified by the
batchIdent parameter.
|
|
declareRecord(java.lang.String operationIdent,RecordDefinition recordDef)
Places a physical record declaration operation into the batch identified by
the
batchIdent parameter.
|
|
declareRecord(java.lang.String operationIdent,RecordDefinition recordDef,java.util.List documentRefs)
Places an electronic record declaration operation into the batch identified by
the
batchIdent parameter.
|
Methods inherited from interface com.filenet.rm.bds.BaseBulkService |
---|
cancelBatch, executeBatch, getBatchResultItems, getConfigurationInfo, getContextInfo, isInBatch, reexecuteBatch, startBatch |
Method Detail
createDocument
- void createDocument(java.lang.String operationIdent,
- DocumentDefinition documentDef)
operationIdent
- Optional operation identifier used to correlate with
eventual BatchResultItem
instances. Can be null
.
See BaseBulkService.executeBatch()
. documentDef
- defines the document to be created. a
- BDSException
if any validation fails. declareRecord
- void declareRecord(java.lang.String operationIdent,
- RecordDefinition recordDef)
batchIdent
parameter. The recordDef
parameter
defines all aspects of the new RM physical record.
Immediate validation is performed upon the recordDef
parameter.
This includes validating the specified record class, any RM business logic
property validation (e.g., DoD Ch4) and all specified record containers.
A parameter validation exception prevents this operation from being added to the batch. Any previously contained batch operations are unaffected.
operationIdent
- Optional operation identifier used to correlate with
eventual BatchResultItem instances. Can be null
.
See BaseBulkService.executeBatch()
. recordDef
- defines the record to be declared. a
- BDSException
if any immediate validation fails. declareRecord
- void declareRecord(java.lang.String operationIdent,
- RecordDefinition recordDef,
- java.util.List documentRefs)
batchIdent
parameter. The recordDef
parameter
defines all aspects of the new RM electronic record.
Immediate validation is performed upon the recordDef
parameter.
This includes validating the specified record class, any RM business logic
property validation (e.g., DoD Ch4) and all specified record containers.
The record will be associated with the existing CE
document(s)/document version(s) defined by the documentDefs
parameter.
A parameter validation exception prevents this operation from being added to the batch. Any previously contained batch operations are unaffected.
operationIdent
- Optional operation identifier used to correlate with
eventual BatchResultItem
instances. Can be null
.
See BaseBulkService.executeBatch()
. recordDef
- defines the record to be declared. documentRefs
- List
of DocumentReference
instances each of which
represents an existing CE document or document version. a
- BDSException
if any immediate validation fails. createDocumentAndDeclareRecord
- void createDocumentAndDeclareRecord( java.lang.String operationIdent,
- java.util.List documentDefs,
- RecordDefinition recordDef)
batchIdent
parameter.
Each member of the documentDefs
List
is an instance of DocumentDefinition
and completely defines all aspects of a new CE document. All CE documents defined by this
List
shall be associated with the newly declared RM record.
The recordDef
parameter defines all aspects of the electronic record to be declared.
A parameter validation exception prevents this operation from being added to the batch. Any previously contained batch operations are unaffected.
Important: When creating a document on a WebLogic-based P8 Content Engine,
include the following JVM system property definition in order to disable TCP
chunking during the actual document content MTOM attachment transfer. This is needed
to avoid BEA Defect 8211809 found on WebLogic 9.2/10.0 :
operationIdent
- Optional operation identifier used to correlate with
eventual BatchResultItem instances. Can be null
.
See BaseBulkService.executeBatch()
. documentDefs
- defines each of the documents to be created. recordDef
- defines the record to be declared. a
- BDSException
if any immediate validation fails.
documentDef
parameter defines all aspects of the new CE document.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.
Important: When creating a document on a WebLogic-based P8 Content Engine, include the following JVM system property definition in order to disable TCP chunking during the actual document content MTOM attachment transfer. This is needed to avoid BEA Defect 8211809 found on WebLogic 9.2/10.0 :