Index

A

addDiagnostic(Diagnostic) - Method in class com.filenet.rm.bds.exception.ErrorFrame
Appends a new Diagnosticinstance to this ErrorFrame.
addErrorFrame(ErrorFrame) - Method in class com.filenet.rm.bds.exception.ErrorStack
Appends a new ErrorFrameto this ErrorStack.
APPEND_CURRENT_USER_PERMISSION - Static variable in class com.filenet.rm.bds.ConfigItemType
Deprecated.
APPEND_CURRENT_USER_PERMISSION_AS_INT - Static variable in class com.filenet.rm.bds.ConfigItemType
Deprecated.

B

BAD_CONTEXTINFO_VALUE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Bad value for a BDS ContextInfo Map entry.
BaseBulkService - Interface in com.filenet.rm.bds
This base interface exposes the major public entry points offered by the Bulk Base Service.
BaseDefinition - Interface in com.filenet.rm.bds
This abstract interface definition represents the common methods belonging to both the RecordDefinition and DocumentDefinition interfaces.
BATCH_EXECUTION_ERROR - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Represents some error occurance during batch execution.
BATCH_EXECUTION_ERROR_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
BatchResultItem - Interface in com.filenet.rm.bds
This interface is used to represent the result of a single member operation that is executed using the BulkDeclarationService batching mechanism.
BDP_NOT_AVAILABLE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
A Bulk Data Provider DataReader is not available.
BDP_NOT_AVAILABLE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
BDP_NOT_SUPPORTED - Static variable in class com.filenet.rm.bds.exception.ErrorCode
BDP Transport option is not currently supported.
BDP_NOT_SUPPORTED_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
BDSConstants - Class in com.filenet.rm.bds
Public constant definitions for Bulk Declaration Service.
BDSException - Exception in com.filenet.rm.bds.exception
BDSException is the main exception thrown by the public BDS API entry points.
BDSException(ErrorCode) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, Object) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, Object, Object) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, Object, Object, Object) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, Object[]) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, Throwable) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, Throwable, Object) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, Throwable, Object, Object) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, Throwable, Object, Object, Object) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, Throwable, Object[]) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, ErrorStack) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, Throwable, ErrorStack) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, ErrorStack, Object) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, Throwable, ErrorStack, Object) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, ErrorStack, Object, Object) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, Throwable, ErrorStack, Object, Object) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, ErrorStack, Object, Object, Object) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BDSException(ErrorCode, ErrorStack, Object[]) - Constructor for exception com.filenet.rm.bds.exception.BDSException
Constructor.
BULK_DECLARATION_SERVICE_CREATE_FAILURE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Represents error during instantiation of BulkDeclarationService.
BULK_DECLARATION_SERVICE_CREATE_FAILURE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
BulkDeclarationFactory - Class in com.filenet.rm.bds.impl
This factory class provides various static methods required to instantiate various interface implementations needed by the BDS API.
BulkDeclarationService - Interface in com.filenet.rm.bds
This interface exposes the major public entry points offered by the Bulk Declaration Service.
BulkDisposeFactory - Class in com.filenet.rm.bds.impl
This factory class provides various static methods required to instantiate various interface implementations for dispose service needed by the BDS API.
BulkDisposeService - Interface in com.filenet.rm.bds
This interface defines the major public entry points offered by the Bulk Dispose Service.

C

CACHE_TTL - Static variable in class com.filenet.rm.bds.ConfigItemType
Designates the integer configuration item concerning the BDS Cache Time-To-Live value (in minutes)
CACHE_TTL_AS_INT - Static variable in class com.filenet.rm.bds.ConfigItemType
cancelBatch() - Method in interface com.filenet.rm.bds.BaseBulkService
Cancels any current batch for this BulkDeclarationService instance so that a subsequent BaseBulkService.startBatch(String) call can be made.
CANT_ACCESS_DOC_CONTENT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Failure during attempt to access document ContentTransfer InputStream.
CANT_ACCESS_DOC_CONTENT_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_CHECK_FILING_STATUS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to check filing status.
CANT_CHECK_FILING_STATUS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_CONNECT_TO_CE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Failure to connect to the CE.
CANT_CONNECT_TO_CE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_CREATE_CONNREG - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Failure during attempt to create new ConnectorRegistration CE instance.
CANT_CREATE_CONNREG_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_DEL_STRONG_LINK_REC - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to delete strong-linked record.
CANT_DEL_SUB_CONTAINER - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to delete sub containers.
CANT_DEL_VOLUME - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to delete sub-volume.
CANT_DO_UNFILE_PREPROCESSING - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to unfile record.
CANT_DO_UNFILE_PREPROCESSING_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_ACTION - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to retrieve desired Action from specified fpos.
CANT_GET_ACTION_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_ACTIONS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Failure attempting to retrieve Action objects from an ObjectStore.
CANT_GET_ACTIONS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_CLASSDESC - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Failure to retrieve a specific P8 ClassDescription from CE.
CANT_GET_CLASSDESC_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_CONNECTOR_REGS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Failure attempting to retrieve ConnectorRegistration objects from an ObjectStore.
CANT_GET_CONNECTOR_REGS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_CONTAINER - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to get container id from record or sub-container.
CANT_GET_CONTAINER_TO_UNFILE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to retrieve containers to unfile.
CANT_GET_CONTAINER_TO_UNFILE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_CONTAINERS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to retrieve containers.
CANT_GET_CONTAINERS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_DISPOSALTRIGGER - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to retrieve desired DisposalTrigger from specified fpos.
CANT_GET_DISPOSALTRIGGER_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_DISPOSALTRIGGERS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Failure attempting to retrieve DisposalTrigger objects from an ObjectStore.
CANT_GET_DISPOSALTRIGGERS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_EMAIL_DOC - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to retrieve email documents.
CANT_GET_FILEPLAN_NAME - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to get file plan name from the entity.
CANT_GET_HEAD_TAIL_LINKS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to retrieve head/tail link.
CANT_GET_HEAD_TAIL_LINKS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_MARKINGSETS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
All document/document versions of a single commit & declare operation are not targeting the same ROS.
CANT_GET_MARKINGSETS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_OBJECTSTORE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Failure to retrieve a specific P8 ObjectStore from CE.
CANT_GET_OBJECTSTORE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_ONHOLD_CONTAINERS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to retrieve all on-hold containers.
CANT_GET_ONHOLD_CONTAINERS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_ORPHANED_RECORD - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to retrieve orphaned documents.
CANT_GET_P8DOMAIN - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Failure to retrieve P8 Domain information from CE.
CANT_GET_P8DOMAIN_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_PHASE_OBJECT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to retrieve phase object.
CANT_GET_PHASE_OBJECT_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_PROPERTY - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to retrieve a property.
CANT_GET_PROPERTY_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_REC_CONTAINEES - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to get record containees for auto-destroy.
CANT_GET_RECORDCONTAINERS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Failure during batch retrieval of RecordContainers.
CANT_GET_RECORDCONTAINERS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_REFERENCED_CONTAINER - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Cannot access referenced record container
CANT_GET_REFERENCED_CONTAINER_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_REFERENCED_DOCUMENT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Cannot access referenced document.
CANT_GET_REFERENCED_DOCUMENT_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_RETAIN_METADATA - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to get retain metadata info from the object store's file plans.
CANT_GET_SERVICECLIENT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Failure to get a valid Systinet WSI ServiceClient instance.
CANT_GET_SERVICECLIENT_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_SUB_CONTAINERS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to get record containees for auto-destroy.
CANT_GET_SYSTEM_CONFIGS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Failure attempting to retrieve SystemConfiguration objects from an ObjectStore.
CANT_GET_SYSTEM_CONFIGS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_GET_WSIPROXY - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Failure to get a valid Systinet WSI Proxy instance.
CANT_GET_WSIPROXY_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_QUERY_MULTIFILED_REC - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to query for multi-filed record.
CANT_QUERY_MULTIFILED_REC_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_USE_PHYSICAL_FOR_DOCS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Use of physical record class when documents are associated with the new record.
CANT_USE_PHYSICAL_FOR_DOCS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CANT_VALIDATE_CONTAINEE_ON_HOLD - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to validate if any containee is on-hold.
CANT_VALIDATE_CONTAINEE_WITH_SCHEDULE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to validate if any containee is controlled by other schedule.
clone() - Method in class com.filenet.rm.bds.GUID
Overrides the protected Object.clone() in order to implement the Cloneable interface.
clone() - Method in interface com.filenet.rm.bds.ObjectReference
Defined in order to support the extended Clonable interface.
com.filenet.rm.bds - package com.filenet.rm.bds
This package contains the majority of interfaces and classes that makeup the public API of the RM Bulk Declaration Service.
com.filenet.rm.bds.exception - package com.filenet.rm.bds.exception
This package contains the classes that implement the exception construct that is generated by the Bulk Declaration Service API.
ConfigItemType - Class in com.filenet.rm.bds
ConfigItemType is an enumerated constant object class that defines the allowed Configuration collection item members.
Configuration - Interface in com.filenet.rm.bds
This interface represents the collection of Bulk Declaration Service configuration items that are used to control its runtime behavior.
ConstantObject - Class in com.filenet.rm.bds
ConstantObject is the abstract base class for all enumerated type classes.
CONTAINER_CANT_HAVE_VOLUME - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Record Container can not contain a Record Volume.
CONTAINER_CANT_HAVE_VOLUME_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CONTAINER_DISPOSED_CNT - Static variable in class com.filenet.rm.bds.BDSConstants
Returned results: container disposed count.
CONTAINER_ENTITYTYPE_MISMATCH - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Record Container/Record Definition RMEntityType mismatch.
CONTAINER_ENTITYTYPE_MISMATCH_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CONTAINER_IS_CLOSED - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Record Container is closed.
CONTAINER_IS_CLOSED_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CONTAINER_IS_DELETED - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Record Container is marked as deleted.
CONTAINER_IS_DELETED_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
CONTAINER_IS_INACTIVE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Record Container is inactive.
CONTAINER_IS_INACTIVE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ContainerReference - Interface in com.filenet.rm.bds
This interface represents a container of either record or document objects.
CONTENT_SIZE_UNDEFINED - Static variable in interface com.filenet.rm.bds.ContentElement
Constant that is used to indicate that the content size is undefined.
ContentElement - Interface in com.filenet.rm.bds
This abstract interface represents a single content element for a document.
ContentReference - Interface in com.filenet.rm.bds
This interface represents URL-based document content.
ContentTransfer - Interface in com.filenet.rm.bds
This interface represents stream-based document content.
CONTEXT_BINDING - Static variable in class com.filenet.rm.bds.BDSConstants
Context Info Binding key.
CONTEXT_ENDPOINT - Static variable in class com.filenet.rm.bds.BDSConstants
Context Info Endpoint key.
CONTEXT_HTTP_REQUEST_CHUNKING - Static variable in class com.filenet.rm.bds.BDSConstants
Context Info Http allow request chunking flag.
CONTEXT_OBJECT_STORE - Static variable in class com.filenet.rm.bds.BDSConstants
Context Info object store.
CONTEXT_PASSWORD - Static variable in class com.filenet.rm.bds.BDSConstants
Context Info Password key (Value is a String).
CONTEXT_PORT - Static variable in class com.filenet.rm.bds.BDSConstants
Context Info Port key.
CONTEXT_PROTOCOL - Static variable in class com.filenet.rm.bds.BDSConstants
Context Info Protocol key.
CONTEXT_SERVER - Static variable in class com.filenet.rm.bds.BDSConstants
Context Info Server key.
CONTEXT_SERVICE - Static variable in class com.filenet.rm.bds.BDSConstants
Context Info Service key.
CONTEXT_TRANSPORT_CONNECTION_TIMEOUT - Static variable in class com.filenet.rm.bds.BDSConstants
Context Info Transport Connection Timeout key.
CONTEXT_TRANSPORT_TYPE - Static variable in class com.filenet.rm.bds.BDSConstants
Context Info Integration Transport key Determines whether to use BDP or DirectWSI Transport mechanism.
CONTEXT_URI - Static variable in class com.filenet.rm.bds.BDSConstants
Context Info Uri key.
CONTEXT_USER_LOCALE - Static variable in class com.filenet.rm.bds.BDSConstants
Context Info user locale.
CONTEXT_USER_TZOFFSET - Static variable in class com.filenet.rm.bds.BDSConstants
Context Info user timezone offset from UTC.
CONTEXT_USERNAME - Static variable in class com.filenet.rm.bds.BDSConstants
Context Info Username key.
createDocument(String, DocumentDefinition) - Method in interface com.filenet.rm.bds.BulkDeclarationService
Places a document creation operation into the current batch.
createDocumentAndDeclareRecord(String, List, RecordDefinition) - Method in interface com.filenet.rm.bds.BulkDeclarationService
Places a combined document creation(s)/record declaration operation into the batch identified by the batchIdent parameter.
createGUID() - Static method in class com.filenet.rm.bds.GUID
Static method to create a new instance of a GUID and auto-generate its internal value.

D

DATA_MODEL_BASE - Static variable in class com.filenet.rm.bds.BDSConstants
Name of RM Base Data Model.
DATA_MODEL_DOD_VERSION_5015_2 - Static variable in class com.filenet.rm.bds.BDSConstants
Name of RM DoD Version 5015-2 Data Model.
DATA_MODEL_DOD_VERSION_5015_2_CLASSIFIED - Static variable in class com.filenet.rm.bds.BDSConstants
A String value that defines the DOD Classified Data Model.
DATA_MODEL_DOD_VERSION_5015_2CHAPTER4 - Static variable in class com.filenet.rm.bds.BDSConstants
Deprecated. please use DATA_MODEL_DOD_VERSION_5015_2_CLASSIFIED
DATA_MODEL_PRO_VERION_2002 - Static variable in class com.filenet.rm.bds.BDSConstants
Name of RM PRO-2002 Data Model.
DataType - Class in com.filenet.rm.bds
DataType is an enumerated constant object class that defines a set of allowed data types for PropertyValue and ConfigItemType.
declareRecord(String, RecordDefinition) - Method in interface com.filenet.rm.bds.BulkDeclarationService
Places a physical record declaration operation into the batch identified by the batchIdent parameter.
declareRecord(String, RecordDefinition, List) - Method in interface com.filenet.rm.bds.BulkDeclarationService
Places an electronic record declaration operation into the batch identified by the batchIdent parameter.
DEFAULT_CACHE_TTL - Static variable in class com.filenet.rm.bds.ConfigItemType
Default cache time-to-live value in minutes.
DEFAULT_EXCEPTION_LOG_DETAIL - Static variable in class com.filenet.rm.bds.ConfigItemType
Default exception logging value.
DEFAULT_MAX_DECLASSIFY - Static variable in class com.filenet.rm.bds.ConfigItemType
Default DoDCh4 max declassify timeframe in years.
DELETE_BATCH_SIZE_OPTION - Static variable in class com.filenet.rm.bds.BDSConstants
Delete batch size option for Bulk Disposal Service.
DELETE_VALIDATION_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
DELETE_VALIDATION_ERROR - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Validation error occurred during delete operation.
Diagnostic - Class in com.filenet.rm.bds.exception
This class represents the Diagnostic portion of the transport error/exception reporting mechanism.
Diagnostic(String, String) - Constructor for class com.filenet.rm.bds.exception.Diagnostic
Constructor.
DIFFERENT_DOC_OBJSTORES - Static variable in class com.filenet.rm.bds.exception.ErrorCode
All document/document versions of a single commit & declare operation are not targeting the same ROS.
DIFFERENT_DOC_OBJSTORES_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
DISPOSAL_TYPE_AUTO_DESTROY - Static variable in class com.filenet.rm.bds.BDSConstants
Legal value for BDSConstants.DISPOSAL_TYPES_OPTION.
DISPOSAL_TYPE_GENERAL_DELETE - Static variable in class com.filenet.rm.bds.BDSConstants
Legal value for BDSConstants.DISPOSAL_TYPES_OPTION.
DISPOSAL_TYPES_OPTION - Static variable in class com.filenet.rm.bds.BDSConstants
Disposal types.
dispose(String, Vector, int) - Method in interface com.filenet.rm.bds.BulkDisposeService
Disposes of the Records Manager entities specified by the entityIds parameter.
dispose(String, String, int) - Method in interface com.filenet.rm.bds.BulkDisposeService
Runs the given queryCondition to get the result RM entities and dipose them.
DOCUMENT_ALREADY_DECLARED - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Document is already declared (i.e., its RecordInformation property is non-null).
DOCUMENT_ALREADY_DECLARED_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
DOCUMENT_CANDECLARE_FALSE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Cannot access referenced document.
DOCUMENT_CANDECLARE_FALSE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
DOCUMENT_IS_RESERVED - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Document is in the reserved state (i.e., is checked out).
DOCUMENT_IS_RESERVED_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
DocumentDefinition - Interface in com.filenet.rm.bds
This interface represents the definition of a single document to be committed.
DocumentReference - Interface in com.filenet.rm.bds
This interface represents an existing document/document version that is to be associated with a new record.
DODCHAPTER4_DECLASSIFY_TIMELIMIT - Static variable in class com.filenet.rm.bds.ConfigItemType
Designates the integer configuration item concerning the DoD Chapter 4 maximum declassify time limit value (in years).
DODCHAPTER4_DECLASSIFY_TIMELIMIT_AS_INT - Static variable in class com.filenet.rm.bds.ConfigItemType
dumpBDSException(StringBuffer) - Method in exception com.filenet.rm.bds.exception.BDSException
Dumps textual information concerning a BDSExcpeption into the form of a StringBuffer.
dumpBDSException(int, StringBuffer) - Method in exception com.filenet.rm.bds.exception.BDSException
Dumps textual information concerning a BDSExcpeption into the form of a StringBuffer.

E

EMPTY_GUID - Static variable in class com.filenet.rm.bds.GUID
Default empty GUID String value.
ENTITIES_DISPOSED_CNT - Static variable in class com.filenet.rm.bds.BDSConstants
Returned results: delete count.
ENTITIES_ONHOLD_CNT - Static variable in class com.filenet.rm.bds.BDSConstants
Returned results: onhold count.
ENTITIES_UNFILE_CNT - Static variable in class com.filenet.rm.bds.BDSConstants
Returned results: unfile count.
equals(Object) - Method in class com.filenet.rm.bds.GUID
ERR_BAD_CONTEXTINFO_VALUE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_CANT_DEL_REC - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to delete record.
ERR_CANT_DEL_REC_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_CANT_DEL_REC_ON_EDM_HOLD - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to delete record on EDM HOLD for auto-destroy.
ERR_CANT_DEL_REC_ON_EDM_HOLD_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_CANT_DEL_STRONG_LINK_REC_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_CANT_DEL_SUB_CONTAINER_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_CANT_DEL_VOLUME_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_CANT_GET_CONTAINER_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_CANT_GET_EMAIL_DOC_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_CANT_GET_FILEPLAN_NAME_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_CANT_GET_ORPHANED_RECORD_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_CANT_GET_REC_CONTAINEES_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_CANT_GET_RETAIN_METADATA_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_CANT_GET_SUB_CONTAINERS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_CANT_VALIDATE_CONTAINEE_ON_HOLD_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_CANT_VALIDATE_CONTAINEE_WITH_SCHEDULE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_FOLDER_HAS_OTHER_SCHEDULE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_ILLEGAL_CONTAINMENTNAME_CHAR_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERR_RECORD_HAS_OTHER_SCHEDULE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ERROR_CNT - Static variable in class com.filenet.rm.bds.BDSConstants
Returned results: error count.
ErrorCode - Class in com.filenet.rm.bds.exception
ErrorCode is an enumerated constant object class that defines the allowed error codes reported by the BDSException class.
ErrorFrame - Class in com.filenet.rm.bds.exception
This class represents the error frame portion of the transport error/exception reporting mechanism.
ErrorFrame(String, String) - Constructor for class com.filenet.rm.bds.exception.ErrorFrame
Constructor.
ErrorFrame(String, String, Collection) - Constructor for class com.filenet.rm.bds.exception.ErrorFrame
Constructor.
ErrorStack - Class in com.filenet.rm.bds.exception
This class represents the error stack portion of the transport error/exception reporting mechanism.
ErrorStack(String) - Constructor for class com.filenet.rm.bds.exception.ErrorStack
Constructor.
ErrorStack(String, Collection) - Constructor for class com.filenet.rm.bds.exception.ErrorStack
Constructor.
EXCEPTION_LOG_INCLUDE_DIAG_STACKTRACES - Static variable in class com.filenet.rm.bds.ConfigItemType
Exception logging includes localized message string and ErrorStack with Diagnostic stacktraces.
EXCEPTION_LOG_INCLUDE_ERRORSTACK - Static variable in class com.filenet.rm.bds.ConfigItemType
Exception logging includes localized message string and abbreviated ErrorStack.
EXCEPTION_LOG_MSG_ONLY - Static variable in class com.filenet.rm.bds.ConfigItemType
Exception logging only includes localized message string.
EXCEPTION_LOGGING_DETAIL - Static variable in class com.filenet.rm.bds.ConfigItemType
Designates the amount of textual detail to log for instances of BDSException.
EXCEPTION_LOGGING_DETAIL_AS_INT - Static variable in class com.filenet.rm.bds.ConfigItemType
EXECUTE_INACTIVE_BATCH - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Represents attempt to execute an inactive batch.
EXECUTE_INACTIVE_BATCH_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
executeBatch() - Method in interface com.filenet.rm.bds.BaseBulkService
Executes all operations that have been placed in the current batch since the previous BaseBulkService.startBatch(String) call.
EXECUTION_FAILED - Static variable in class com.filenet.rm.bds.ResultItemStatus
Execution of associated operation failed.
EXECUTION_FAILED_AS_INT - Static variable in class com.filenet.rm.bds.ResultItemStatus
EXECUTION_INPROGRESS - Static variable in class com.filenet.rm.bds.ResultItemStatus
Execution of associated operation is in progress.
EXECUTION_INPROGRESS_AS_INT - Static variable in class com.filenet.rm.bds.ResultItemStatus
EXECUTION_SUCCEEDED - Static variable in class com.filenet.rm.bds.ResultItemStatus
Execution of associated operation succeeded.
EXECUTION_SUCCEEDED_AS_INT - Static variable in class com.filenet.rm.bds.ResultItemStatus
EXECUTION_UNABLE_TO_DISPOSE_ENTITIES - Static variable in class com.filenet.rm.bds.ResultItemStatus
Execution of associated operation cannot dispose entities due to various reasons.
EXECUTION_UNABLE_TO_DISPOSE_ENTITIES_AS_INT - Static variable in class com.filenet.rm.bds.ResultItemStatus

F

FAILED_DELETE_CONTAINER_IDS - Static variable in class com.filenet.rm.bds.BDSConstants
Returned results: IDs of containers that have failed to delete.
FAILED_DELETE_RECORD_IDS - Static variable in class com.filenet.rm.bds.BDSConstants
Returned results: IDs of record that have failed to delete.
FOLDER_HAS_OTHER_SCHEDULE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to delete folder when it is controlled by another schedule.
FORMERLY_RESTRICTED_DATA - Static variable in class com.filenet.rm.bds.BDSConstants
Supplemental Marking Set value used for DoD Chapter 4 validation.
fromInteger(int) - Static method in class com.filenet.rm.bds.DataType
Returns appropriate DataType instance based upon its corresponding integer value.
fromObjectIdent(Object) - Static method in class com.filenet.rm.bds.DataType
Returns appropriate DataType instance based upon its an identifying Integer or String.

G

getAccessMask() - Method in interface com.filenet.rm.bds.PermissionValue
Returns an integer representing the type of permission assigned to a user or group.
getAccessType() - Method in interface com.filenet.rm.bds.PermissionValue
Returns an integer that indicates whether a user or group is allowed or denied access.
getAutoClassify() - Method in interface com.filenet.rm.bds.DocumentDefinition
Controls whether or not auto classification will be performed on the newly created CE document defined by this DocumentDefinition.
getAutoUniqueNaming() - Method in interface com.filenet.rm.bds.ContainerReference
Reflects the current state of the auto-unique containment naming option for this ContainerReference.
getBatchResultItems() - Method in interface com.filenet.rm.bds.BaseBulkService
Returns the array of BatchResultItems from the current active batch.
getBulkDeclarationService(Map) - Static method in class com.filenet.rm.bds.impl.BulkDeclarationFactory
Static method to return an instance of BulkDeclarationService that has been validated.
getBulkDisposeService(Map) - Static method in class com.filenet.rm.bds.impl.BulkDisposeFactory
Static method to return an instance of BulkDisposeService that has been validated.
getClassIdent() - Method in interface com.filenet.rm.bds.BaseDefinition
Returns the identifier (either Name or Id property) of the CE ClassDescription on which the object defined by this definition will be based upon.
getClassIdent() - Method in interface com.filenet.rm.bds.ObjectReference
Returns the identifier (either Name or ID property) of the class definition on which the object defined by this definition instance is to be based upon.
getConfigItemKeys() - Method in interface com.filenet.rm.bds.Configuration
Returns a Set of ConfigItemType that represent the keys of the Configuration collection.
getConfigurationInfo() - Method in interface com.filenet.rm.bds.BaseBulkService
Returns the current Configurationcollection belonging to this BulkDeclarationService instance.
getContainers() - Method in interface com.filenet.rm.bds.BaseDefinition
Returns a modifiable list of ContainerReference instances into which the object defined by this definition instance is to be filed.
getContainmentName() - Method in interface com.filenet.rm.bds.ContainerReference
Reflects the current state of the containment name value, if any, assigned to this ContainerReference instance.
getContentElements() - Method in interface com.filenet.rm.bds.DocumentDefinition
Returns a modifiable List of ContentElement instances associated with this DocumentDefinition instance.
getContentSize() - Method in interface com.filenet.rm.bds.ContentElement
Returns the (optional) size in bytes of this ContentElement.
getContextInfo() - Method in interface com.filenet.rm.bds.BaseBulkService
Returns the current connection context Map in use by this BulkDeclarationService instance.
getCreateAsMajorVersion() - Method in interface com.filenet.rm.bds.DocumentDefinition
Controls whether or not the newly created CE document defined by this DocumentDefinition instance is to be checked in initially as a major or as a minor version.
getDataType() - Method in class com.filenet.rm.bds.ConfigItemType
Returns the data type of the configuration item defined by this ConfigItemType instance.
getDataType() - Method in interface com.filenet.rm.bds.PropertyValue
Returns the enumerated DataTypemember describing the type of data contained by this PropertyValue instance.
getDefaultValue() - Method in class com.filenet.rm.bds.ConfigItemType
Returns the default value (if any) for this configuration item.
getDescription() - Method in class com.filenet.rm.bds.ConfigItemType
Returns the default locale description for this configuration item.
getDescription(Locale) - Method in class com.filenet.rm.bds.ConfigItemType
Returns the description for this configuration item for the given locale.
getDescription() - Method in class com.filenet.rm.bds.exception.ErrorFrame
The ErrorFrame description string.
getDiagnostics() - Method in class com.filenet.rm.bds.exception.ErrorFrame
The ErrorFrame contained Diagnostic collection.
getDiagnosticType() - Method in class com.filenet.rm.bds.exception.Diagnostic
The underlying diagnostic type.
getDiagnosticValue() - Method in class com.filenet.rm.bds.exception.Diagnostic
The underlying diagnostic value.
getEnumeratedList() - Method in class com.filenet.rm.bds.ConstantObject
Returns a list of the enumerated type members for this type.
getErrorCode() - Method in exception com.filenet.rm.bds.exception.BDSException
Returns the ErrorCodeconstant associated with this BDSException instance.
getErrorFrames() - Method in class com.filenet.rm.bds.exception.ErrorStack
The collection of ErrorFrameinstances contained by this ErrorStack.
getErrorStack() - Method in exception com.filenet.rm.bds.exception.BDSException
Returns the ErrorStackinstance associated with this BDSException instance.
getFault() - Method in class com.filenet.rm.bds.exception.ErrorStack
The ErrorStack instance's fault string.
getFileName() - Method in interface com.filenet.rm.bds.ContentTransfer
Returns the (optional) file name of this ContentTransfer.
getGranteeName() - Method in interface com.filenet.rm.bds.PermissionValue
Returns a String representing the name of the object being assigned permission.
getGranteeType() - Method in interface com.filenet.rm.bds.PermissionValue
Returns the type of the permission grantee.
getId() - Method in interface com.filenet.rm.bds.BaseDefinition
Returns the Id field of the BaseDefinition instance.
getInheritableDepth() - Method in interface com.filenet.rm.bds.PermissionValue
Returns an integer that represents the maximum number of levels (depth) through which this permission can be inherited.
getInputStream() - Method in interface com.filenet.rm.bds.ContentTransfer
Returns the InputStreamof this ContentTransfer.
getIntValue() - Method in class com.filenet.rm.bds.ConstantObject
Returns the enumerated type's int representation.
getItemDataType(ConfigItemType) - Method in interface com.filenet.rm.bds.Configuration
Returns the enumberated DataType value corresponding to the specified ConfigItemType.
getItemDescription(ConfigItemType, Locale) - Method in interface com.filenet.rm.bds.Configuration
Returns the localized description String of the specified configuration item for the specified Locale.
getItemDescription(ConfigItemType) - Method in interface com.filenet.rm.bds.Configuration
Returns the localized description String of the specified configuration item for the default Locale.
getItemValueAsBool(ConfigItemType) - Method in interface com.filenet.rm.bds.Configuration
Returns the boolean value for a configuration item of type DataType.TYPE_BOOLEAN.
getItemValueAsInt(ConfigItemType) - Method in interface com.filenet.rm.bds.Configuration
Returns the int value for a configuration item of type DataType.TYPE_INTEGER.
getItemValueAsString(ConfigItemType) - Method in interface com.filenet.rm.bds.Configuration
Returns the String value for a configuration item of type DataType.TYPE_STRING.
getLocalizedMessage() - Method in exception com.filenet.rm.bds.exception.BDSException
getLocalizedMessage(Locale) - Method in exception com.filenet.rm.bds.exception.BDSException
Returns message string localized for the specified Locale.
getLocalizedStringValue() - Method in class com.filenet.rm.bds.ConstantObject
Returns the enumerated type's localized String representation based upon the default Locale.
getLocalizedStringValue(Locale) - Method in class com.filenet.rm.bds.ConstantObject
Returns the enumerated type's localized String representation based upon the specified Locale.
getLocationURL() - Method in interface com.filenet.rm.bds.ContentReference
Returns the location URL of this ContentReference.
getMimeType() - Method in interface com.filenet.rm.bds.ContentElement
Returns the MimeType of this ContentElement.
getObjectIdent() - Method in interface com.filenet.rm.bds.ObjectReference
Returns the identifier (either Name, Id or Path) of the CE object to which this ObjectReference instance refers to.
getObjectStoreIdent() - Method in interface com.filenet.rm.bds.BaseDefinition
Returns the identifier (either Name or Id property) of the ObjectStore onto which the item defined by this definition will reside upon.
getObjectStoreIdent() - Method in interface com.filenet.rm.bds.ObjectReference
Returns the identifier (either Name or ID property) of the ObjectStore onto which the referred object resides.
getOperationIdent() - Method in interface com.filenet.rm.bds.BatchResultItem
Returns the identifier of the operation that this BatchResultItem represents.
getPermissionSource() - Method in interface com.filenet.rm.bds.PermissionValue
Returns the source of this permission.
getPermissionValues() - Method in interface com.filenet.rm.bds.BaseDefinition
Returns a modifiable list of PermissionValue instances to be assigned to the object defined by this definition instance.
getPropertyValues() - Method in interface com.filenet.rm.bds.BaseDefinition
Returns a modifiable list of PropertyValue instances to be assigned to the object defined by this definition instance.
getResultStatus() - Method in interface com.filenet.rm.bds.BatchResultItem
Returns the current status of the operation associated with this BatchResultItem instance.
getResultValue() - Method in interface com.filenet.rm.bds.BatchResultItem
Returns the result of an associated operation as an Object.
getSource() - Method in class com.filenet.rm.bds.exception.ErrorFrame
The ErrorFrame source string.
getStringValue() - Method in class com.filenet.rm.bds.ConstantObject
Returns the enumerated type's non-localized String representation.
getSymbolicName() - Method in interface com.filenet.rm.bds.PropertyValue
Returns the SymbolicName String assigned to this PropertyValue instance.
getValue() - Method in interface com.filenet.rm.bds.PropertyValue
Returns this PropertyValue instance's current value as an Object.
getVersion() - Static method in class com.filenet.rm.bds.impl.BulkDeclarationFactory
Returns the implementation version string as found in the JAR manifest.
getVersion() - Static method in class com.filenet.rm.bds.impl.BulkDisposeFactory
Returns the implementation version string as found in the JAR manifest.
GRANTEE_TYPE_GROUP - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 2001; specifies that the grantee is a group.
GRANTEE_TYPE_USER - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 2000; specifies that the grantee is a user.
GUID - Class in com.filenet.rm.bds
This class encapsulates the concept of a GUID
GUID(String) - Constructor for class com.filenet.rm.bds.GUID
Constructor for GUID class.
GUID(byte[]) - Constructor for class com.filenet.rm.bds.GUID
Constructor for GUID class.

H

hashCode() - Method in class com.filenet.rm.bds.GUID

I

ILLEGAL_CONTAINMENTNAME_CHAR - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Illegal containment name character.
INDIRECT_ON_HOLD_CONTAINER_IDS - Static variable in class com.filenet.rm.bds.BDSConstants
Returned results: IDs of sub-containers whose parent is on-hold.
INDIRECT_ON_HOLD_RECORD_IDS - Static variable in class com.filenet.rm.bds.BDSConstants
Returned results: IDs of records whose container is on-hold.
INHERITABLE_DEPTH_NO_INHERITANCE - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0; specifies that this permission cannot be inherited.
INHERITABLE_DEPTH_ONE_LEVEL - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 1; specifies that this permission can be inherited by immediate security children but no further.
INHERITABLE_DEPTH_UNLIMITED - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of -1; specifies that this permission can be inherited by security children to any depth.
INVALID_CACHETTL_VALUE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Invalid CacheTTL configuration value.
INVALID_CACHETTL_VALUE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
INVALID_CONTEXTINFO_KEY - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Represents an invalid key in a ContextInfo map.
INVALID_CONTEXTINFO_KEY_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
INVALID_PARAMETER - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Represents invalid parameter error.
INVALID_PARAMETER_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
INVALID_VITAL_ACTION - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Invalid Vital Action property for a vital record.
INVALID_VITAL_ACTION_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
INVALID_VITAL_TRIGGER - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Invalid Vital Disposal Trigger property for a vital record.
INVALID_VITAL_TRIGGER_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
isInBatch() - Method in interface com.filenet.rm.bds.BaseBulkService
Indicates whether or not a batch is currently active for this BulkDeclarationService instance.
isMultiValued() - Method in interface com.filenet.rm.bds.PropertyValue
Returns multi-valued nature of this PropertyValue instance.
isValidGuidString(String) - Static method in class com.filenet.rm.bds.GUID
Helper method to determine if a given string is a valid GUID string.
isValueAnException() - Method in interface com.filenet.rm.bds.BatchResultItem
Identifies whether or not the corresponding result value represents an exception.

J

JOB_RESPONSE_DISTRIBUTION_ERROR - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Exception during distribution of a Job execution response set.
JOB_RESPONSE_DISTRIBUTION_ERROR_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode

L

LEVEL_ADD_TO_FOLDER - Static variable in interface com.filenet.rm.bds.PermissionValue
An alias for LEVEL_LINK_FOLDER.
LEVEL_FULL_CONTROL - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies full access rights to an object for base level permissions and Web Content Management (WCM) extended permissions (deploy and archive).
LEVEL_FULL_CONTROL_ANNOTATION - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies full access rights to functions that can be performed on an Annotation object.
LEVEL_FULL_CONTROL_CLASSDEF - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies full access rights to functions that can be performed on a ClassDefinition object.
LEVEL_FULL_CONTROL_CUSTOM - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies full access rights to functions that can be performed on a CustomObject object.
LEVEL_FULL_CONTROL_DEFAULT - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies a combination of access rights to an object that grant or deny a user or group the permission to make most types of changes to a Content Engine object.
LEVEL_FULL_CONTROL_DOCUMENT - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies full access rights to functions that can be performed on a Document object.
LEVEL_FULL_CONTROL_FOLDER - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies full access rights to functions that can be performed on a Folder object.
LEVEL_FULL_CONTROL_FOLDER_INHERITABLE - Static variable in interface com.filenet.rm.bds.PermissionValue
Same as LEVEL_FULL_CONTROL_FOLDER, but with the addition of rights that are used only by those containees of the folder that inherit security from that folder.
LEVEL_FULL_CONTROL_MARKING - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies full access rights to an object for performing marking operations on an object.
LEVEL_LINK_CLASSDEF - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies that the user or group is granted or denied permission to link to and view a ClassDefinition object's properties and security.
LEVEL_LINK_CUSTOM - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies that the user or group is granted or denied permission to link to and view a CustomObject object's properties and security.
LEVEL_LINK_FOLDER - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies that the user or group is granted or denied permission to link to and unlink from a Folder object.
LEVEL_MAJOR_VERSION_DOCUMENT - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies that the user or group is granted or denied permission to create a new major version of a Document object's content.
LEVEL_MINOR_VERSION_DOCUMENT - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies that the user or group is granted or denied permission to create a new minor version of a Document object's content.
LEVEL_MODIFY_CONTENT_DOCUMENT - Static variable in interface com.filenet.rm.bds.PermissionValue
An alias for LEVEL_MAJOR_VERSION_DOCUMENT.
LEVEL_MODIFY_PROPERTIES_ANNOTATION - Static variable in interface com.filenet.rm.bds.PermissionValue
An alias for LEVEL_WRITE_ANNOTATION.
LEVEL_MODIFY_PROPERTIES_CLASSDEF - Static variable in interface com.filenet.rm.bds.PermissionValue
An alias for LEVEL_WRITE_CLASSDEF.
LEVEL_MODIFY_PROPERTIES_CUSTOM - Static variable in interface com.filenet.rm.bds.PermissionValue
An alias for LEVEL_WRITE_CUSTOM.
LEVEL_MODIFY_PROPERTIES_DEFAULT - Static variable in interface com.filenet.rm.bds.PermissionValue
An alias for LEVEL_WRITE_DEFAULT.
LEVEL_MODIFY_PROPERTIES_DOCUMENT - Static variable in interface com.filenet.rm.bds.PermissionValue
An alias for LEVEL_WRITE_DOCUMENT.
LEVEL_MODIFY_PROPERTIES_FOLDER - Static variable in interface com.filenet.rm.bds.PermissionValue
An alias for LEVEL_WRITE_FOLDER.
LEVEL_MODIFY_PROPERTIES_FOLDER_INHERITABLE - Static variable in interface com.filenet.rm.bds.PermissionValue
Same as LEVEL_WRITE_FOLDER, but with the addition of rights that are used only by containees of the folder that inherit security from that folder.
LEVEL_PUBLISH - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies that the user or group is granted or denied permission to publish the object; view its properties, security, and content; and link to the object.
LEVEL_PUBLISH_DOCUMENT - Static variable in interface com.filenet.rm.bds.PermissionValue
An alias for LEVEL_PUBLISH.
LEVEL_READ - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies that the user or group is granted or denied permission to view an object's properties and security.
LEVEL_VIEW - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies that the user or group is granted or denied permission to view an object's properties, security, and content.
LEVEL_VIEW_CONTENT - Static variable in interface com.filenet.rm.bds.PermissionValue
An alias for LEVEL_VIEW.
LEVEL_VIEW_PROPERTIES - Static variable in interface com.filenet.rm.bds.PermissionValue
An alias for LEVEL_READ.
LEVEL_WRITE_ANNOTATION - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies that the user or group is granted or denied permission to view an Annotation object's content; modify its properties; and create a new instance of an object.
LEVEL_WRITE_CLASSDEF - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies that the user or group is granted or denied permission to create an instance of the object; modify the object's properties; link to the object; and create an instance of the object.
LEVEL_WRITE_CUSTOM - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies that the user or group is granted or denied permission to link to a CustomObject object; view and modify its properties; and create a new instance of the object.
LEVEL_WRITE_DEFAULT - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies that the user or group is granted or denied permission to modify the object's properties and create a new instance of the object.
LEVEL_WRITE_DOCUMENT - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies that the user or group is granted or denied permission to link to a Document object; create a new instance of the object; change the object's lifecycle state; view its content; and modify its properties.
LEVEL_WRITE_FOLDER - Static variable in interface com.filenet.rm.bds.PermissionValue
Specifies that the user or group is granted or denied permission to create a subfolder under a Folder object.

M

MINIMUM_CACHE_TTL - Static variable in class com.filenet.rm.bds.ConfigItemType
Minimum cache time-to-live value in minutes.
MISSING_CONTEXTINFO_KEY - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Represents one or more missing keys in a ContextInfo map.
MISSING_CONTEXTINFO_KEY_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
MISSING_VITAL_ACTION - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Missing Vital Action property for a vital record.
MISSING_VITAL_ACTION_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
MISSING_VITAL_TRIGGER - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Missing Vital Disposal Trigger property for a vital record.
MISSING_VITAL_TRIGGER_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
MULTIFILED_CACHE_SIZE_OPTION - Static variable in class com.filenet.rm.bds.BDSConstants
Multi-filed records cache size option for Bulk Disposal Service.

N

newContainerReference(String, String, String) - Static method in class com.filenet.rm.bds.impl.BulkDeclarationFactory
Static method to return a new instance of a ContainerReference.
newContentReference(String, String) - Static method in class com.filenet.rm.bds.impl.BulkDeclarationFactory
Static method to return a new instance of ContentReference.
newContentTransfer(InputStream, String) - Static method in class com.filenet.rm.bds.impl.BulkDeclarationFactory
Static method to return a new instance of ContentTransfer.
newDocumentDefinition(String, String) - Static method in class com.filenet.rm.bds.impl.BulkDeclarationFactory
Static method to return a new instance of a DocumentDefinition.
newDocumentReference(String, String, String) - Static method in class com.filenet.rm.bds.impl.BulkDeclarationFactory
Static method to return a new instance of DocumentReference that references an existing CE document or document version.
newObjectReference(String, String, String) - Static method in class com.filenet.rm.bds.impl.BulkDeclarationFactory
Static method to return a new instance of an ObjectReference.
newPermissionValue(int, int, String, int, int) - Static method in class com.filenet.rm.bds.impl.BulkDeclarationFactory
Static method to return a new instance of a PermissionValue.
newPermissionValue(int, int, String, int, int, int) - Static method in class com.filenet.rm.bds.impl.BulkDeclarationFactory
Static method to return a new instance of a PermissionValue.
newPropertyValue(String, DataType, boolean) - Static method in class com.filenet.rm.bds.impl.BulkDeclarationFactory
Static method to return a new instance of a PropertyValue.
newRecordDefinition(String, String) - Static method in class com.filenet.rm.bds.impl.BulkDeclarationFactory
Static method to return a new instance of a RecordDefinition.
NO_ACTIVEVOLUME_AVAILABLE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
No active volume available for specified container.
NO_ACTIVEVOLUME_AVAILABLE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
NO_CURRENT_BATCH - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Attempt to define an operation when no current batch is available.
NO_CURRENT_BATCH_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
NO_DOCUMENTS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Cannot access referenced document.
NO_DOCUMENTS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
NO_RECORD_CONTAINERS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Record Definition has no Record Container specified.
NO_RECORD_CONTAINERS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
NOT_EXECUTED - Static variable in class com.filenet.rm.bds.ResultItemStatus
Associated operation has not been executed yet.
NOT_EXECUTED_AS_INT - Static variable in class com.filenet.rm.bds.ResultItemStatus
NULL_CONFIGURATION_ITEM - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Represents null configuration item error.
NULL_CONFIGURATION_ITEM_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
NULL_PARAMETER - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Represents null parameter error.
NULL_PARAMETER_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode

O

ObjectReference - Interface in com.filenet.rm.bds
The ObjectReference interface represents an existing CE object.
OBJECTSTORE_NOT_AN_FPOS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Target object store for a new declarable document is not a valid ROS.
OBJECTSTORE_NOT_AN_FPOS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
OBJECTSTORE_NOT_AN_ROS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Target object store for a new declarable document is not a valid ROS.
OBJECTSTORE_NOT_AN_ROS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
ON_HOLD_CONTAINER_IDS - Static variable in class com.filenet.rm.bds.BDSConstants
Returned results: onhold container ids.
ON_HOLD_RECORD_IDS - Static variable in class com.filenet.rm.bds.BDSConstants
Returned results: IDs of on-hold records.
ONE_OR_MORE_DODCH4_ERRORS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
All document/document versions of a single commit & declare operation are not targeting the same ROS.
ONE_OR_MORE_DODCH4_ERRORS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
OPERATION_ERROR_RESPONSE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
A response error was received for a particular operation.
OPERATION_ERROR_RESPONSE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode

P

PERMISSION_SOURCE_DEFAULT - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 1; specifies that the permission was acquired by default.
PERMISSION_SOURCE_DIRECT - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0; specifies that the permission was directly added.
PERMISSION_SOURCE_PARENT - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 3; specifies that the permission was acquired from a security parent.
PERMISSION_SOURCE_TEMPLATE - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 2; specifies that the permission was acquired from a security template.
PermissionValue - Interface in com.filenet.rm.bds
This interface represents an individual CE security permission.
PRINCIPAL_NAME_AUTHENTICATED_USERS - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of "#AUTHENTICATED-USERS"; specifies that the security principal name is the built-in group called AUTHENTICATED-USERS.
PRINCIPAL_NAME_CREATOR_OWNER - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of "#CREATOR-OWNER"; specifies that the security principal name is the built-in group called CREATOR-OWNER.
PRINCIPAL_NAME_SPECIAL - Static variable in interface com.filenet.rm.bds.PermissionValue
A String array that specifies the security principal name as the two built-in groups called CREATOR-OWNER and AUTHENTICATED-USERS.
PropertyValue - Interface in com.filenet.rm.bds
This interface defines a value for a specified property that will apply to a new document or record object.
PROPVALUE_MV_INTO_SV - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Represents one or more missing keys in a ContextInfo map.
PROPVALUE_MV_INTO_SV_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode

Q

QUERY_BATCH_SIZE_OPTION - Static variable in class com.filenet.rm.bds.BDSConstants
Query or read batch size option for Bulk Disposal Service.

R

RECORD_DISPOSED_CNT - Static variable in class com.filenet.rm.bds.BDSConstants
Returned results: record disposed count.
RECORD_HAS_OTHER_SCHEDULE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Unable to delete record when it is controlled by another schedule.
RECORD_MIMETYPE_ELECT - Static variable in class com.filenet.rm.bds.BDSConstants
MimeType string for electronic record.
RECORD_MIMETYPE_EMAIL - Static variable in class com.filenet.rm.bds.BDSConstants
MimeType string for email record.
RECORD_MIMETYPE_PHY - Static variable in class com.filenet.rm.bds.BDSConstants
MimeType string for physical (marker) record.
RecordDefinition - Interface in com.filenet.rm.bds
This interface represents the definition of a single record object that is to be declared on a FilePlan ObjectStore.
reexecuteBatch(boolean) - Method in interface com.filenet.rm.bds.BaseBulkService
Re-executes the current batch.
RESTRICTED_DATA - Static variable in class com.filenet.rm.bds.BDSConstants
Supplemental Marking Set value used for DoD Chapter 4 validation.
ResultItemStatus - Class in com.filenet.rm.bds
ResultItemStatus is an enumerated constant object class that defines the set of possible return values for the for the BatchResultItem.getResultStatus() method.
RIGHT_ADD_MARKING - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x2000000; specifies that the user or group is granted or denied permission to assign a Marking object to an object.
RIGHT_ARCHIVE - Static variable in interface com.filenet.rm.bds.PermissionValue
Deprecated.
RIGHT_CHANGE_STATE - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x00000400; specifies that the user or group is granted or denied permission to change the lifecycle state of an object.
RIGHT_CREATE_CHILD - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x00000200; specifies that the user or group is granted or denied permission to create a child object.
RIGHT_CREATE_INSTANCE - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x00000100; specifies that the user or group is granted or denied permission to create a new instance of an object.
RIGHT_DELETE - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x00010000; specifies that the user or group is granted or denied permission to delete an object.
RIGHT_DEPLOY - Static variable in interface com.filenet.rm.bds.PermissionValue
Deprecated.
RIGHT_LINK - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x00000010; specifies that the user or group is granted or denied permission to link to an object.
RIGHT_MAJOR_VERSION - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x00000004; specifies that the user or group is granted or denied permission to create a document major version.
RIGHT_MINOR_VERSION - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x00000040; specifies that the user or group is granted or denied permission to create a new document minor version.
RIGHT_PUBLISH - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x00000800; specifies that the user or group is granted or denied permission to publish an object.
RIGHT_READ - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x00000001; specifies that the user or group is granted or denied permission to view the properties of an object.
RIGHT_READ_ACL - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x00020000; specifies that the user or group is granted or denied permission to view an object's security (that is, its Permissions collection).
RIGHT_REMOVE_MARKING - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x4000000; specifies that the user or group is granted or denied permission to remove a Marking object from an object.
RIGHT_UNLINK - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x00000020; specifies that the user or group is granted or denied permission to unlink from an object.
RIGHT_USE_MARKING - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x8000000; determines whether or not the constraint mask will be applied.
RIGHT_VIEW_CONTENT - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x00000080; specifies that the user or group is granted or denied permission to view the content of an object.
RIGHT_WRITE - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x00000002; specifies that the user or group is granted or denied permission to modify the properties of an object.
RIGHT_WRITE_ACL - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x00040000; specifies that the user or group is granted or denied permission to modify an object's security (that is, its Permissions collection).
RIGHT_WRITE_OWNER - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 0x00080000; specifies that the user or group is granted or denied permission to change an object's ownership.
RMENTITY_TYPE_BOX - Static variable in class com.filenet.rm.bds.BDSConstants
Entity type for box container.
RMENTITY_TYPE_CONTAINER - Static variable in class com.filenet.rm.bds.BDSConstants
Entity type for generic RM container.
RMENTITY_TYPE_ELECTRONICRECORD - Static variable in class com.filenet.rm.bds.BDSConstants
Entity type for electronic record instances.
RMENTITY_TYPE_ELECTRONICRECORDFOLDER - Static variable in class com.filenet.rm.bds.BDSConstants
Entity type for electronic record folder container.
RMENTITY_TYPE_EMAILRECORD - Static variable in class com.filenet.rm.bds.BDSConstants
Entity type for email record instances.
RMENTITY_TYPE_HYBRIDRECORDFOLDER - Static variable in class com.filenet.rm.bds.BDSConstants
Entity type for hybrid record folder container.
RMENTITY_TYPE_MARKER - Static variable in class com.filenet.rm.bds.BDSConstants
Entity type for physical (marker) record instances.
RMENTITY_TYPE_PHYSICALCONTAINER - Static variable in class com.filenet.rm.bds.BDSConstants
Entity type for physical container.
RMENTITY_TYPE_PHYSICALRECORDFOLDER - Static variable in class com.filenet.rm.bds.BDSConstants
Entity type for physical record folder container.
RMENTITY_TYPE_RECORD - Static variable in class com.filenet.rm.bds.BDSConstants
Entity type for generic record instances.
RMENTITY_TYPE_RECORDCATEGORY - Static variable in class com.filenet.rm.bds.BDSConstants
Entity type for record category container.
RMENTITY_TYPE_RECORDFOLDER - Static variable in class com.filenet.rm.bds.BDSConstants
Entity type for record folder container.
RMENTITY_TYPE_RECORDVOLUME - Static variable in class com.filenet.rm.bds.BDSConstants
Entity type for record volume container.

S

SCHEDULECHANGED_ENTITIES - Static variable in class com.filenet.rm.bds.BDSConstants
Returned results: list of entity IDs whose schedule has been changed.
SEARCH_REQUEST_FAILED - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Search request failed.
SEARCH_REQUEST_FAILED_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
SECURITY_LEVEL_MARKINGSET_NAME - Static variable in class com.filenet.rm.bds.BDSConstants
Name of DoD Classified Marking Set
setAutoClassify(boolean) - Method in interface com.filenet.rm.bds.DocumentDefinition
Controls whether or not auto classification will be performed on the newly created CE document defined by this DocumentDefinition.
setAutoUniqueNaming(boolean) - Method in interface com.filenet.rm.bds.ContainerReference
Controls whether naming collisions are to be automatically resolved for containment names.
setContainmentName(String) - Method in interface com.filenet.rm.bds.ContainerReference
Defines an optional string to be used as the containment name of the record or document object to be filed in the container defined by this ContainerReference.
setContentSize(long) - Method in interface com.filenet.rm.bds.ContentElement
Sets the (optional) size in bytes for this ContentElement.
setCreateAsMajorVersion(boolean) - Method in interface com.filenet.rm.bds.DocumentDefinition
Controls whether or not the newly created CE document defined by this DocumentDefinition instance is to be checked in initially as a major or minor version.
setFileName(String) - Method in interface com.filenet.rm.bds.ContentTransfer
Sets the (optional) file name for this ContentTransfer.
setId(String) - Method in interface com.filenet.rm.bds.BaseDefinition
Sets the Id field of the BaseDefinition instance.
setItemValue(ConfigItemType, boolean) - Method in interface com.filenet.rm.bds.Configuration
Sets the value for a configuration item of type DataType.TYPE_BOOLEAN.
setItemValue(ConfigItemType, int) - Method in interface com.filenet.rm.bds.Configuration
Sets the value for a configuration item of type DataType.TYPE_INTEGER.
setItemValue(ConfigItemType, String) - Method in interface com.filenet.rm.bds.Configuration
Sets the value for a configuration item of type DataType.TYPE_STRING.
setLogDetail(int) - Static method in exception com.filenet.rm.bds.exception.BDSException
Sets static log detail level for the BDSException class.
setMimeType(String) - Method in interface com.filenet.rm.bds.ContentElement
Sets the MimeType for this ContentElement.
setValue(byte[]) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a single-valued DataType.TYPE_BINARYPropertyValue instance.
setValue(byte[][]) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a multi-valued DataType.TYPE_BINARYPropertyValue instance.
setValue(boolean) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a single-valued DataType.TYPE_BOOLEANPropertyValue instance.
setValue(boolean[]) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a multi-valued DataType.TYPE_BOOLEANPropertyValue instance.
setValue(Calendar) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a single-valued DataType.TYPE_DATEPropertyValue instance.
setValue(Calendar[]) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a multi-valued DataType.TYPE_DATEPropertyValue instance.
setValue(Date) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a single-valued DataType.TYPE_DATEPropertyValue instance.
setValue(Date[]) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a multi-valued DataType.TYPE_DATEPropertyValue instance.
setValue(double) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a single-valued DataType.TYPE_DOUBLEPropertyValue instance.
setValue(double[]) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a multi-valued DataType.TYPE_DOUBLEPropertyValue instance.
setValue(GUID) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a single-valued DataType.TYPE_GUIDPropertyValue instance.
setValue(GUID[]) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a multi-valued DataType.TYPE_GUIDPropertyValue instance.
setValue(int) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a single-valued DataType.TYPE_INTEGERPropertyValue instance.
setValue(int[]) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a multi-valued DataType.TYPE_INTEGERPropertyValue instance.
setValue(ObjectReference) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a single-valued DataType.TYPE_OBJECTPropertyValue instance.
setValue(ObjectReference[]) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a multi-valued DataType.TYPE_OBJECTPropertyValue instance.
setValue(String) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a single-valued DataType.TYPE_STRINGPropertyValue instance.
setValue(String[]) - Method in interface com.filenet.rm.bds.PropertyValue
Populates a multi-valued DataType.TYPE_STRINGPropertyValue instance.
setValueNull() - Method in interface com.filenet.rm.bds.PropertyValue
Sets the PropertyValue instance's contained value to null.
startBatch(String) - Method in interface com.filenet.rm.bds.BaseBulkService
Called to designate the start of a new batching operation.
startBatch(String, Map) - Method in interface com.filenet.rm.bds.BulkDisposeService
Called to designate the start of a new batching operation and optionally provide options for disposal.
STARTBATCH_ON_ALREADY_ACTIVE_BATCH - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Represents attempt to call startBatch() when an already-active batch exists.
STARTBATCH_ON_ALREADY_ACTIVE_BATCH_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
STOP_ON_FIRST_ERROR - Static variable in class com.filenet.rm.bds.ConfigItemType
Designates the boolean configuration item concerning whether or not an error during declaration and/or committal should terminate the entire job.
STOP_ON_FIRST_ERROR_AS_INT - Static variable in class com.filenet.rm.bds.ConfigItemType
SUPPLEMENTAL_MARKINGSET_NAME - Static variable in class com.filenet.rm.bds.BDSConstants
Name of Supplemental Marking Set
SYMNAME_ACCESS_MASK - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_ACCESS_PERMISSION - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_ACCESS_TYPE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_ACTION_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_ACTION_TYPE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_ADDRESSEE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_ALIAS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_ALLOWED_RMCONTAINEES - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_ALLOWED_RMTYPES - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_AUTHOR - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_BARCODE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_BCCADDRESS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CAN_DECLARE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CLASS_IDENT - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CLASSIFIED_BY - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CLASSIFIEDON - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CLASSIFYING_AGENCY - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CONSTRAINT_MASK - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CONTAINERS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CONTAINMENT_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CONTENT - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CONTENT_ELEMENTS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CONTENT_LOCATION - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CONTENT_SIZE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CONTENT_TYPE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CURRENT_ACTION_TYPE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CURRENT_CLASSIFICATION - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CURRENT_PHASE_ACTION - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CURRENT_PHASE_EXE_DATE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CURRENT_PHASE_ID - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CURRENT_USER - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CUTOFF_DATE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_CUTOFF_INHERITED_FROM - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DATA_TYPE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DATE_CLOSED - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DATE_DECLARED - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DATE_LAST_MODIFIED - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DATE_OPENED - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DATE_RECEIVED - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DECLARED_BY - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DECLASSIFIED_BY - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DECLASSIFIED_ON - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DECLASSIFYON_DATE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DECLASSIFYON_EVENTS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DEFAULT_INSTANCE_PERMISSIONS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DERIVED_FROM - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DESCRIPTION - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DISPLAY_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DISPOSAL_PHASES - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DISPOSAL_SCHEDULE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DISPOSAL_TRIGGER_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DISPOSITION_AUTHORITY - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DISTINGUISHED_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DOC_URI - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DOCUMENT_TITLE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DOWNGRADE_INSTRUCTIONS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DOWNGRADED_BY - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DOWNGRADED_ON - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DOWNGRADEON_DATE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_DOWNGRADEON_EVENTS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_EVENT_TYPE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_EXEMPTIONS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_FOLDER_FILED_IN - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_FOLDER_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_FORMAT - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_GRANTEE_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_GRANTEE_TYPE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_HEAD - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_HOME_LOCATION - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_ID - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_IMPLEMENTING_CLASS_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_INACTIVE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_INHERITABLE_DEPTH - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_INITIAL_CLASSIFICATION - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_IS_DELETED - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_IS_FINAL_PHASE_COMPLETED - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_IS_HIERARCHICAL - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_IS_VITAL_RECORD - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_LANGUAGE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_LAST_SWEEP_DATE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_LOCAL_DOMAIN - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_LOCATION - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_MARKINGS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_MARKINGSET - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_MARKINGSETS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_MARKINGVALUE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_MEDIATYPE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_MIME_TYPE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_NONPAGEDQUERYMAXSIZE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_OBJECTSTORE_IDENT - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_ONHOLD - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_OPERATOR - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_OTHER_ADDRESSEE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_PARENT - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_PART_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_PATH_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_PERMISSION_SOURCE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_PERMISSIONS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_PROPERTY_DEFAULT_BOOLEAN - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_PROPERTY_DEFAULT_INTEGER32 - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_PROPERTY_DEFAULT_STRING - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_PROPERTY_DESCRIPTIONS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_PROPERTY_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_PROPERTY_VALUE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_PUBLICATION_DATE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_QUERYPAGEDMAXSIZE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_REASONS_FOR_SECURITY_CLASSIFICATION - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_RECALCULATE_PHASE_RETENTION - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_RECEIPT_STATUS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_RECEIPTOF - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_RECEIPTS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_RECORD_CATEGORY_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_RECORD_FOLDER_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_RECORD_INFORMATION - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_RECORD_TYPE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_RECORD_VOLUME_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_RECORDED_DOCUMENT - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_REMARKS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_REOPENED_DATE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_REPOSITORY_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_REPOSITORY_TYPE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_RETAIN_METADATA - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_RETRIEVAL_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_REVIEWEDBY - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_REVIEWEDON - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_REVIEWER - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_RMENTITY_TYPE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_SECURITY_FOLDER - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_SECURITY_PARENT - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_SERVER_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_SHORT_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_SUBJECT - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_SUBSYSTEM_CONFIGURATIONS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_SUPERCLASSES - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_SUPPLEMENTAL_MARKINGS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_SYMBOLIC_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_TAIL - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_THIS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_UPGRADE_REASONS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_UPGRADED_BY - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_UPGRADED_ON - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_VERSION_STATUS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_VITAL_RECORD_DECLARE_DATE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_VITAL_RECORD_DISPOSAL_TRIGGER - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_VITAL_RECORD_REVIEW_ACTION - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_VITAL_RECORD_REVIEW_DATE - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_VITAL_WORKFLOW_STATUS - Static variable in interface com.filenet.rm.bds.PropertyValue
SYMNAME_VOLUME_NAME - Static variable in interface com.filenet.rm.bds.PropertyValue

T

THREAD_COUNT_OPTION - Static variable in class com.filenet.rm.bds.BDSConstants
Specifying number of threads for disposition processing.
TOO_MANY_PHYSICAL_CONTAINERS - Static variable in class com.filenet.rm.bds.exception.ErrorCode
More than one physical Record Container specified.
TOO_MANY_PHYSICAL_CONTAINERS_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
toString() - Method in class com.filenet.rm.bds.GUID
Returns GUID value as a String in the format "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}" where each 'x' character is a hexidecimal digit ([0-9A-F]).
TRANSCRIPT_WRITER_FOR_AUTODEL_OPTION - Static variable in class com.filenet.rm.bds.BDSConstants
Transcript writer for auto destroy
Used to control auto destroy transcript for optimal performance.
TRANSPORT_TYPE_BDP - Static variable in class com.filenet.rm.bds.BDSConstants
Deprecated. As of RM-4.0, replaced by BDSConstants.TRANSPORT_TYPE_BDP40_WSI.
TRANSPORT_TYPE_BDP40_JACE - Static variable in class com.filenet.rm.bds.BDSConstants
Legal value for Context Info BDSConstants.CONTEXT_TRANSPORT_TYPE.
TRANSPORT_TYPE_BDP40_WSI - Static variable in class com.filenet.rm.bds.BDSConstants
Legal value for Context Info BDSConstants.CONTEXT_TRANSPORT_TYPE.
TYPE_ALLOW - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 1; specifies that the user or group has permission for the given access to a specified object.
TYPE_BINARY - Static variable in class com.filenet.rm.bds.DataType
Represents binary (e.g., byte[]) data.
TYPE_BINARY_AS_INT - Static variable in class com.filenet.rm.bds.DataType
TYPE_BOOLEAN - Static variable in class com.filenet.rm.bds.DataType
Represents boolean data.
TYPE_BOOLEAN_AS_INT - Static variable in class com.filenet.rm.bds.DataType
TYPE_CONVERSION_FAILURE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Represents type conversion error.
TYPE_CONVERSION_FAILURE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
TYPE_DATE - Static variable in class com.filenet.rm.bds.DataType
Represents Calendar data.
TYPE_DATE_AS_INT - Static variable in class com.filenet.rm.bds.DataType
TYPE_DENY - Static variable in interface com.filenet.rm.bds.PermissionValue
Value of 2; specifies that the user or group does not have the given access to a specified object.
TYPE_DOUBLE - Static variable in class com.filenet.rm.bds.DataType
Represents double data.
TYPE_DOUBLE_AS_INT - Static variable in class com.filenet.rm.bds.DataType
TYPE_GUID - Static variable in class com.filenet.rm.bds.DataType
Represents GUID data.
TYPE_GUID_AS_INT - Static variable in class com.filenet.rm.bds.DataType
TYPE_INTEGER - Static variable in class com.filenet.rm.bds.DataType
Represents int data.
TYPE_INTEGER_AS_INT - Static variable in class com.filenet.rm.bds.DataType
TYPE_OBJECT - Static variable in class com.filenet.rm.bds.DataType
Represents ObjectReference data.
TYPE_OBJECT_AS_INT - Static variable in class com.filenet.rm.bds.DataType
TYPE_STRING - Static variable in class com.filenet.rm.bds.DataType
Represents String data.
TYPE_STRING_AS_INT - Static variable in class com.filenet.rm.bds.DataType

U

UNKNOWN - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Represents unknown error.
UNKNOWN_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
UPDATE_BATCH_SIZE_OPTION - Static variable in class com.filenet.rm.bds.BDSConstants
Update batch size option for the Bulk Disposal Service.

V

VALIDATE_RECORD_CONTAINERS - Static variable in class com.filenet.rm.bds.ConfigItemType
Designates the boolean configuration item concerning whether or not record container validation is performed during record declaration.
VALIDATE_RECORD_CONTAINERS_AS_INT - Static variable in class com.filenet.rm.bds.ConfigItemType
VALIDATE_RECORDS - Static variable in class com.filenet.rm.bds.ConfigItemType
Designates the boolean value that determines whether record validation should or should not be performed during record declaration.
VALIDATE_RECORDS_AS_INT - Static variable in class com.filenet.rm.bds.ConfigItemType
VALIDATION_ERROR - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Validation error in one or more operations.
VALIDATION_ERROR_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
VALIDATION_FAILED - Static variable in class com.filenet.rm.bds.ResultItemStatus
Validation of associated operation failed.
VALIDATION_FAILED_AS_INT - Static variable in class com.filenet.rm.bds.ResultItemStatus
VALIDATION_INPROGRESS - Static variable in class com.filenet.rm.bds.ResultItemStatus
Operation validation is in progress.
VALIDATION_INPROGRESS_AS_INT - Static variable in class com.filenet.rm.bds.ResultItemStatus
VALIDATION_SUCCEEDED - Static variable in class com.filenet.rm.bds.ResultItemStatus
Validation of associated operation succeeded.
VALIDATION_SUCCEEDED_AS_INT - Static variable in class com.filenet.rm.bds.ResultItemStatus

W

WORKFLOW_STATUS_NOT_STARTED - Static variable in class com.filenet.rm.bds.BDSConstants
Record workflow status value used during validation.
WRONG_ELEMENT_TYPE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Represents one or more missing keys in a ContextInfo map.
WRONG_ELEMENT_TYPE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode
WRONG_PROPVALUE_DATATYPE - Static variable in class com.filenet.rm.bds.exception.ErrorCode
Represents one or more missing keys in a ContextInfo map.
WRONG_PROPVALUE_DATATYPE_AS_INT - Static variable in class com.filenet.rm.bds.exception.ErrorCode