com.filenet.rm.bds

Class BDSConstants

  1. java.lang.Object
  2. extended bycom.filenet.rm.bds.BDSConstants

  1. public class BDSConstants
  2. extends java.lang.Object
Public constant definitions for Bulk Declaration Service.

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
CONTAINER_DISPOSED_CNT
Returned results: container disposed count.
  1. static
  2. java.lang.String
CONTEXT_BINDING
Context Info Binding key.
  1. static
  2. java.lang.String
CONTEXT_ENDPOINT
Context Info Endpoint key.
  1. static
  2. java.lang.String
CONTEXT_HTTP_REQUEST_CHUNKING
Context Info Http allow request chunking flag.
  1. static
  2. java.lang.String
CONTEXT_OBJECT_STORE
Context Info object store.
  1. static
  2. java.lang.String
CONTEXT_PASSWORD
Context Info Password key (Value is a String).
  1. static
  2. java.lang.String
CONTEXT_PORT
Context Info Port key.
  1. static
  2. java.lang.String
CONTEXT_PROTOCOL
Context Info Protocol key.
  1. static
  2. java.lang.String
CONTEXT_SERVER
Context Info Server key.
  1. static
  2. java.lang.String
CONTEXT_SERVICE
Context Info Service key.
  1. static
  2. java.lang.String
CONTEXT_TRANSPORT_CONNECTION_TIMEOUT
Context Info Transport Connection Timeout key.
  1. static
  2. java.lang.String
CONTEXT_TRANSPORT_TYPE
Context Info Integration Transport key Determines whether to use BDP or DirectWSI Transport mechanism.
  1. static
  2. java.lang.String
CONTEXT_URI
Context Info Uri key.
  1. static
  2. java.lang.String
CONTEXT_USER_LOCALE
Context Info user locale.
  1. static
  2. java.lang.String
CONTEXT_USER_TZOFFSET
Context Info user timezone offset from UTC.
  1. static
  2. java.lang.String
CONTEXT_USERNAME
Context Info Username key.
  1. static
  2. java.lang.String
DATA_MODEL_BASE
Name of RM Base Data Model.
  1. static
  2. java.lang.String
DATA_MODEL_DOD_VERSION_5015_2
Name of RM DoD Version 5015-2 Data Model.
  1. static
  2. java.lang.String
DATA_MODEL_DOD_VERSION_5015_2_CLASSIFIED
A String value that defines the DOD Classified Data Model.
  1. static
  2. java.lang.String
DATA_MODEL_DOD_VERSION_5015_2CHAPTER4
Deprecated. please use DATA_MODEL_DOD_VERSION_5015_2_CLASSIFIED
  1. static
  2. java.lang.String
DATA_MODEL_PRO_VERION_2002
Name of RM PRO-2002 Data Model.
  1. static
  2. java.lang.String
DELETE_BATCH_SIZE_OPTION
Delete batch size option for Bulk Disposal Service.
  1. static
  2. java.lang.Integer
DISPOSAL_TYPE_AUTO_DESTROY
Legal value for DISPOSAL_TYPES_OPTION.
  1. static
  2. java.lang.Integer
DISPOSAL_TYPE_GENERAL_DELETE
Legal value for DISPOSAL_TYPES_OPTION.
  1. static
  2. java.lang.String
DISPOSAL_TYPES_OPTION
Disposal types.
  1. static
  2. java.lang.String
ENTITIES_DISPOSED_CNT
Returned results: delete count.
  1. static
  2. java.lang.String
ENTITIES_ONHOLD_CNT
Returned results: onhold count.
  1. static
  2. java.lang.String
ENTITIES_UNFILE_CNT
Returned results: unfile count.
  1. static
  2. java.lang.String
ERROR_CNT
Returned results: error count.
  1. static
  2. java.lang.String
FAILED_DELETE_CONTAINER_IDS
Returned results: IDs of containers that have failed to delete.
  1. static
  2. java.lang.String
FAILED_DELETE_RECORD_IDS
Returned results: IDs of record that have failed to delete.
  1. static
  2. java.lang.String
FORMERLY_RESTRICTED_DATA
Supplemental Marking Set value used for DoD Chapter 4 validation.
  1. static
  2. java.lang.String
INDIRECT_ON_HOLD_CONTAINER_IDS
Returned results: IDs of sub-containers whose parent is on-hold.
  1. static
  2. java.lang.String
INDIRECT_ON_HOLD_RECORD_IDS
Returned results: IDs of records whose container is on-hold.
  1. static
  2. java.lang.String
MULTIFILED_CACHE_SIZE_OPTION
Multi-filed records cache size option for Bulk Disposal Service.
  1. static
  2. java.lang.String
ON_HOLD_CONTAINER_IDS
Returned results: onhold container ids.
  1. static
  2. java.lang.String
ON_HOLD_RECORD_IDS
Returned results: IDs of on-hold records.
  1. static
  2. java.lang.String
QUERY_BATCH_SIZE_OPTION
Query or read batch size option for Bulk Disposal Service.
  1. static
  2. java.lang.String
RECORD_DISPOSED_CNT
Returned results: record disposed count.
  1. static
  2. java.lang.String
RECORD_MIMETYPE_ELECT
MimeType string for electronic record.
  1. static
  2. java.lang.String
RECORD_MIMETYPE_EMAIL
MimeType string for email record.
  1. static
  2. java.lang.String
RECORD_MIMETYPE_PHY
MimeType string for physical (marker) record.
  1. static
  2. java.lang.String
RESTRICTED_DATA
Supplemental Marking Set value used for DoD Chapter 4 validation.
  1. static
  2. int
RMENTITY_TYPE_BOX
Entity type for box container.
  1. static
  2. int
RMENTITY_TYPE_CONTAINER
Entity type for generic RM container.
  1. static
  2. int
RMENTITY_TYPE_ELECTRONICRECORD
Entity type for electronic record instances.
  1. static
  2. int
RMENTITY_TYPE_ELECTRONICRECORDFOLDER
Entity type for electronic record folder container.
  1. static
  2. int
RMENTITY_TYPE_EMAILRECORD
Entity type for email record instances.
  1. static
  2. int
RMENTITY_TYPE_HYBRIDRECORDFOLDER
Entity type for hybrid record folder container.
  1. static
  2. int
RMENTITY_TYPE_MARKER
Entity type for physical (marker) record instances.
  1. static
  2. int
RMENTITY_TYPE_PHYSICALCONTAINER
Entity type for physical container.
  1. static
  2. int
RMENTITY_TYPE_PHYSICALRECORDFOLDER
Entity type for physical record folder container.
  1. static
  2. int
RMENTITY_TYPE_RECORD
Entity type for generic record instances.
  1. static
  2. int
RMENTITY_TYPE_RECORDCATEGORY
Entity type for record category container.
  1. static
  2. int
RMENTITY_TYPE_RECORDFOLDER
Entity type for record folder container.
  1. static
  2. int
RMENTITY_TYPE_RECORDVOLUME
Entity type for record volume container.
  1. static
  2. java.lang.String
SCHEDULECHANGED_ENTITIES
Returned results: list of entity IDs whose schedule has been changed.
  1. static
  2. java.lang.String
SECURITY_LEVEL_MARKINGSET_NAME
Name of DoD Classified Marking Set
  1. static
  2. java.lang.String
SUPPLEMENTAL_MARKINGSET_NAME
Name of Supplemental Marking Set
  1. static
  2. java.lang.String
THREAD_COUNT_OPTION
Specifying number of threads for disposition processing.
  1. static
  2. java.lang.String
TRANSCRIPT_WRITER_FOR_AUTODEL_OPTION
Transcript writer for auto destroy
Used to control auto destroy transcript for optimal performance.
  1. static
  2. java.lang.String
TRANSPORT_TYPE_BDP
Deprecated. As of RM-4.0, replaced by TRANSPORT_TYPE_BDP40_WSI.
  1. static
  2. java.lang.String
TRANSPORT_TYPE_BDP40_JACE
Legal value for Context Info CONTEXT_TRANSPORT_TYPE.
  1. static
  2. java.lang.String
TRANSPORT_TYPE_BDP40_WSI
Legal value for Context Info CONTEXT_TRANSPORT_TYPE.
  1. static
  2. java.lang.String
UPDATE_BATCH_SIZE_OPTION
Update batch size option for the Bulk Disposal Service.
  1. static
  2. int
WORKFLOW_STATUS_NOT_STARTED
Record workflow status value used during validation.

Method Summary

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTEXT_USERNAME

  1. public static final java.lang.String CONTEXT_USERNAME
Context Info Username key. (Value is a String).
See Also:

CONTEXT_PASSWORD

  1. public static final java.lang.String CONTEXT_PASSWORD
Context Info Password key (Value is a String).
See Also:

CONTEXT_SERVER

  1. public static final java.lang.String CONTEXT_SERVER
Context Info Server key. Used for WSI transport types. (Value is a String).
See Also:

CONTEXT_PORT

  1. public static final java.lang.String CONTEXT_PORT
Context Info Port key. Used for WSI transport types. (Value is a String).
See Also:

CONTEXT_PROTOCOL

  1. public static final java.lang.String CONTEXT_PROTOCOL
Context Info Protocol key. Used for WSI transport types. (Value is a String).
See Also:

CONTEXT_SERVICE

  1. public static final java.lang.String CONTEXT_SERVICE
Context Info Service key. Used for WSI transport types. (Value is a String).
See Also:

CONTEXT_ENDPOINT

  1. public static final java.lang.String CONTEXT_ENDPOINT
Context Info Endpoint key. Used for WSI transport types. (Value is a String).
See Also:

CONTEXT_BINDING

  1. public static final java.lang.String CONTEXT_BINDING
Context Info Binding key. Used for WSI transport types. (Value is a String).
See Also:

CONTEXT_URI

  1. public static final java.lang.String CONTEXT_URI
Context Info Uri key. Used for JACE transport types. (Value is a String).
See Also:

CONTEXT_OBJECT_STORE

  1. public static final java.lang.String CONTEXT_OBJECT_STORE
Context Info object store.
Specifies the record object store for used by the Bulk Disposal service. (Value is a String).
See Also:

CONTEXT_TRANSPORT_CONNECTION_TIMEOUT

  1. public static final java.lang.String CONTEXT_TRANSPORT_CONNECTION_TIMEOUT
Context Info Transport Connection Timeout key. (Value is an Integer representing milliseconds).
See Also:

CONTEXT_HTTP_REQUEST_CHUNKING

  1. public static final java.lang.String CONTEXT_HTTP_REQUEST_CHUNKING
Context Info Http allow request chunking flag. (Value is a Boolean).
See Also:

CONTEXT_TRANSPORT_TYPE

  1. public static final java.lang.String CONTEXT_TRANSPORT_TYPE
Context Info Integration Transport key Determines whether to use BDP or DirectWSI Transport mechanism.
See Also:

TRANSPORT_TYPE_BDP

  1. public static final java.lang.String TRANSPORT_TYPE_BDP
Deprecated. As of RM-4.0, replaced by TRANSPORT_TYPE_BDP40_WSI.
Legal value for Context Info CONTEXT_TRANSPORT_TYPE. Specifies that the BulkDataProvider transport be used in RM-3.7.
See Also:

TRANSPORT_TYPE_BDP40_WSI

  1. public static final java.lang.String TRANSPORT_TYPE_BDP40_WSI
Legal value for Context Info CONTEXT_TRANSPORT_TYPE. Specifies that the BulkDataProvider WSI transport be used in RM-4.0.
See Also:

TRANSPORT_TYPE_BDP40_JACE

  1. public static final java.lang.String TRANSPORT_TYPE_BDP40_JACE
Legal value for Context Info CONTEXT_TRANSPORT_TYPE. Specifies that the BulkDataProvider Jace transport be used in RM-4.0.

Primarily intended for use of the BDS from within a CE-4.0 event handler.

See Also:

CONTEXT_USER_LOCALE

  1. public static final java.lang.String CONTEXT_USER_LOCALE
Context Info user locale. (Value is a String in the form: "<language code>[_<country code>[_<variant code>]]").
See Also:

CONTEXT_USER_TZOFFSET

  1. public static final java.lang.String CONTEXT_USER_TZOFFSET
Context Info user timezone offset from UTC. (Value is a String in the form: "+|-HH:MM").
See Also:

ENTITIES_ONHOLD_CNT

  1. public static final java.lang.String ENTITIES_ONHOLD_CNT
Returned results: onhold count.
Used to return the number of on-hold entities by the Bulk Disposal Service. (Value is a Integer).
See Also:

ON_HOLD_RECORD_IDS

  1. public static final java.lang.String ON_HOLD_RECORD_IDS
Returned results: IDs of on-hold records.
Used to return the number of on-hold record IDs found by the Bulk Disposal Service. (Value is a Vector).
See Also:

ON_HOLD_CONTAINER_IDS

  1. public static final java.lang.String ON_HOLD_CONTAINER_IDS
Returned results: onhold container ids.
Used to return the number of on-hold container IDs found by the Bulk Disposal Service. (Value is a Vector).
See Also:

INDIRECT_ON_HOLD_RECORD_IDS

  1. public static final java.lang.String INDIRECT_ON_HOLD_RECORD_IDS
Returned results: IDs of records whose container is on-hold.
Used to return the number of record IDs filed under an on-hold container. (Value is a Vector).
See Also:

INDIRECT_ON_HOLD_CONTAINER_IDS

  1. public static final java.lang.String INDIRECT_ON_HOLD_CONTAINER_IDS
Returned results: IDs of sub-containers whose parent is on-hold.
Used to return the number of container IDs filed under an on-hold parent container. (Value is a Vector).
See Also:

FAILED_DELETE_RECORD_IDS

  1. public static final java.lang.String FAILED_DELETE_RECORD_IDS
Returned results: IDs of record that have failed to delete.
Used to return the number of record IDs that the BDS is unable to delete. (Value is a Vector).
See Also:

FAILED_DELETE_CONTAINER_IDS

  1. public static final java.lang.String FAILED_DELETE_CONTAINER_IDS
Returned results: IDs of containers that have failed to delete.
Used to the return number of container IDs that the BDS is unable to delete. (Value is a Vector).
See Also:

SCHEDULECHANGED_ENTITIES

  1. public static final java.lang.String SCHEDULECHANGED_ENTITIES
Returned results: list of entity IDs whose schedule has been changed.
Used to return the number of entity IDs whose schedule has been changed. (Value is a HashMap).
See Also:

ENTITIES_DISPOSED_CNT

  1. public static final java.lang.String ENTITIES_DISPOSED_CNT
Returned results: delete count.
Used to return the number of records disposed by the Bulk Disposal Service. (Value is a Integer).
See Also:

ENTITIES_UNFILE_CNT

  1. public static final java.lang.String ENTITIES_UNFILE_CNT
Returned results: unfile count.
Used to return the number of records unfiled by the Bulk Disposal Service. (Value is a Integer).
See Also:

ERROR_CNT

  1. public static final java.lang.String ERROR_CNT
Returned results: error count.
Used to return the number of error found by the Bulk Disposal Service. (Value is a Integer).
See Also:

RECORD_DISPOSED_CNT

  1. public static final java.lang.String RECORD_DISPOSED_CNT
Returned results: record disposed count.
Used to return the number of records deleted by the Bulk Disposal Service. (Value is a Integer).
See Also:

CONTAINER_DISPOSED_CNT

  1. public static final java.lang.String CONTAINER_DISPOSED_CNT
Returned results: container disposed count.
Used to return the number of containers deleted by the Bulk Disposal Service. (Value is a Integer).
See Also:

UPDATE_BATCH_SIZE_OPTION

  1. public static final java.lang.String UPDATE_BATCH_SIZE_OPTION
Update batch size option for the Bulk Disposal Service.
Used to control the number of entities to update in a batch for optimal performance. (Value is a Integer).
See Also:

DELETE_BATCH_SIZE_OPTION

  1. public static final java.lang.String DELETE_BATCH_SIZE_OPTION
Delete batch size option for Bulk Disposal Service.
Used to control the number of entities to delete in a batch for optimal performance. (Value is a Integer).
See Also:

MULTIFILED_CACHE_SIZE_OPTION

  1. public static final java.lang.String MULTIFILED_CACHE_SIZE_OPTION
Multi-filed records cache size option for Bulk Disposal Service.
Used to control the number of mult-filed records to cache for optimal performance. (Value is a Integer).
See Also:

TRANSCRIPT_WRITER_FOR_AUTODEL_OPTION

  1. public static final java.lang.String TRANSCRIPT_WRITER_FOR_AUTODEL_OPTION
Transcript writer for auto destroy
Used to control auto destroy transcript for optimal performance. (Value is a Boolean).
See Also:

QUERY_BATCH_SIZE_OPTION

  1. public static final java.lang.String QUERY_BATCH_SIZE_OPTION
Query or read batch size option for Bulk Disposal Service.
Used to control the number of entities to query in a batch for optimal performance. (Value is a Integer).
See Also:

THREAD_COUNT_OPTION

  1. public static final java.lang.String THREAD_COUNT_OPTION
Specifying number of threads for disposition processing.
Used to control the number of threads to use when processing disposal for optimal performance. (Value is a Integer).
See Also:

DISPOSAL_TYPES_OPTION

  1. public static final java.lang.String DISPOSAL_TYPES_OPTION
Disposal types. Used to specify type of disposal to process:

- DISPOSAL_TYPE_AUTO_DESTROY: Auto destroy without requiring any RM WFL.
- DISPOSAL_TYPE_GENERAL_DELETE: General delete of the entities without involved in the disposition process. (Value is a Integer).

See Also:

DISPOSAL_TYPE_AUTO_DESTROY

  1. public static final java.lang.Integer DISPOSAL_TYPE_AUTO_DESTROY
Legal value for DISPOSAL_TYPES_OPTION.
Specifies that the BDS perform auto destroy of the entites without requiring any RM WFL.

DISPOSAL_TYPE_GENERAL_DELETE

  1. public static final java.lang.Integer DISPOSAL_TYPE_GENERAL_DELETE
Legal value for DISPOSAL_TYPES_OPTION.
Specifies that the BDS can delete the entites without requiring any disposition process.

RMENTITY_TYPE_RECORD

  1. public static final int RMENTITY_TYPE_RECORD
Entity type for generic record instances. This is for Bulk Dispose Service
See Also:

RMENTITY_TYPE_ELECTRONICRECORD

  1. public static final int RMENTITY_TYPE_ELECTRONICRECORD
Entity type for electronic record instances.
See Also:

RMENTITY_TYPE_EMAILRECORD

  1. public static final int RMENTITY_TYPE_EMAILRECORD
Entity type for email record instances.
See Also:

RMENTITY_TYPE_MARKER

  1. public static final int RMENTITY_TYPE_MARKER
Entity type for physical (marker) record instances.
See Also:

RMENTITY_TYPE_RECORDCATEGORY

  1. public static final int RMENTITY_TYPE_RECORDCATEGORY
Entity type for record category container.
See Also:

RMENTITY_TYPE_RECORDFOLDER

  1. public static final int RMENTITY_TYPE_RECORDFOLDER
Entity type for record folder container.
See Also:

RMENTITY_TYPE_RECORDVOLUME

  1. public static final int RMENTITY_TYPE_RECORDVOLUME
Entity type for record volume container.
See Also:

RMENTITY_TYPE_ELECTRONICRECORDFOLDER

  1. public static final int RMENTITY_TYPE_ELECTRONICRECORDFOLDER
Entity type for electronic record folder container.
See Also:

RMENTITY_TYPE_PHYSICALCONTAINER

  1. public static final int RMENTITY_TYPE_PHYSICALCONTAINER
Entity type for physical container.
See Also:

RMENTITY_TYPE_BOX

  1. public static final int RMENTITY_TYPE_BOX
Entity type for box container.
See Also:

RMENTITY_TYPE_HYBRIDRECORDFOLDER

  1. public static final int RMENTITY_TYPE_HYBRIDRECORDFOLDER
Entity type for hybrid record folder container.
See Also:

RMENTITY_TYPE_PHYSICALRECORDFOLDER

  1. public static final int RMENTITY_TYPE_PHYSICALRECORDFOLDER
Entity type for physical record folder container.
See Also:

RMENTITY_TYPE_CONTAINER

  1. public static final int RMENTITY_TYPE_CONTAINER
Entity type for generic RM container. This is used for Bulk Dispose Service
See Also:

RECORD_MIMETYPE_ELECT

  1. public static final java.lang.String RECORD_MIMETYPE_ELECT
MimeType string for electronic record.
See Also:

RECORD_MIMETYPE_EMAIL

  1. public static final java.lang.String RECORD_MIMETYPE_EMAIL
MimeType string for email record.
See Also:

RECORD_MIMETYPE_PHY

  1. public static final java.lang.String RECORD_MIMETYPE_PHY
MimeType string for physical (marker) record.
See Also:

SECURITY_LEVEL_MARKINGSET_NAME

  1. public static final java.lang.String SECURITY_LEVEL_MARKINGSET_NAME
Name of DoD Classified Marking Set
See Also:

SUPPLEMENTAL_MARKINGSET_NAME

  1. public static final java.lang.String SUPPLEMENTAL_MARKINGSET_NAME
Name of Supplemental Marking Set
See Also:

FORMERLY_RESTRICTED_DATA

  1. public static final java.lang.String FORMERLY_RESTRICTED_DATA
Supplemental Marking Set value used for DoD Chapter 4 validation.
See Also:

RESTRICTED_DATA

  1. public static final java.lang.String RESTRICTED_DATA
Supplemental Marking Set value used for DoD Chapter 4 validation.
See Also:

DATA_MODEL_BASE

  1. public static final java.lang.String DATA_MODEL_BASE
Name of RM Base Data Model.
See Also:

DATA_MODEL_PRO_VERION_2002

  1. public static final java.lang.String DATA_MODEL_PRO_VERION_2002
Name of RM PRO-2002 Data Model.
See Also:

DATA_MODEL_DOD_VERSION_5015_2

  1. public static final java.lang.String DATA_MODEL_DOD_VERSION_5015_2
Name of RM DoD Version 5015-2 Data Model.
See Also:

DATA_MODEL_DOD_VERSION_5015_2CHAPTER4

  1. public static final java.lang.String DATA_MODEL_DOD_VERSION_5015_2CHAPTER4
Deprecated. please use DATA_MODEL_DOD_VERSION_5015_2_CLASSIFIED
Name of RM DoD Version 5015-2/Chapter 4 Data Model.
See Also:

DATA_MODEL_DOD_VERSION_5015_2_CLASSIFIED

  1. public static final java.lang.String DATA_MODEL_DOD_VERSION_5015_2_CLASSIFIED
A String value that defines the DOD Classified Data Model.
See Also:

WORKFLOW_STATUS_NOT_STARTED

  1. public static final int WORKFLOW_STATUS_NOT_STARTED
Record workflow status value used during validation.
See Also: