com.filenet.rm.bds

Class BDSConstants

  • java.lang.Object
    • com.filenet.rm.bds.BDSConstants


  • public class BDSConstants
    extends java.lang.Object
    Public constant definitions for Bulk Declaration Service.
    • Field Detail

      • CONTEXT_USERNAME

        public static final java.lang.String CONTEXT_USERNAME
        Context Info Username key. (Value is a String).
        See Also:
        Constant Field Values
      • CONTEXT_PASSWORD

        public static final java.lang.String CONTEXT_PASSWORD
        Context Info Password key (Value is a String).
        See Also:
        Constant Field Values
      • CONTEXT_USE_AMBIENT_SUBJECT

        public static final java.lang.String CONTEXT_USE_AMBIENT_SUBJECT
        Context Info Use Ambient JAAS Subject flag. (Value is a Boolean). (For internal use only).
        See Also:
        Constant Field Values
      • CONTEXT_SERVER

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

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

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

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

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

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

        public static final java.lang.String CONTEXT_URI
        Context Info Uri key. Used for Jace transport types. (Value is a String).
        See Also:
        Constant Field Values
      • CONTEXT_OBJECT_STORE

        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:
        Constant Field Values
      • CONTEXT_TRANSPORT_CONNECTION_TIMEOUT

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

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

        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:
        Constant Field Values
      • TRANSPORT_TYPE_BDP40_WSI

        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:
        Constant Field Values
      • TRANSPORT_TYPE_BDP40_JACE

        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:
        Constant Field Values
      • CONTEXT_USER_LOCALE

        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:
        Constant Field Values
      • CONTEXT_USER_TZOFFSET

        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:
        Constant Field Values
      • ENTITIES_ONHOLD_CNT

        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:
        Constant Field Values
      • ON_HOLD_RECORD_IDS

        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:
        Constant Field Values
      • ON_HOLD_CONTAINER_IDS

        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:
        Constant Field Values
      • INDIRECT_ON_HOLD_RECORD_IDS

        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:
        Constant Field Values
      • INDIRECT_ON_HOLD_CONTAINER_IDS

        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:
        Constant Field Values
      • CONTAINEE_ON_HOLD_CONTAINER_IDS

        public static final java.lang.String CONTAINEE_ON_HOLD_CONTAINER_IDS
        Returned results: IDs of containers whose containee is on-hold.
        Used to return the number of container IDs whose containee is on-hold. (Value is a Vector).
        See Also:
        Constant Field Values
      • FAILED_DELETE_RECORD_ID_REASON_MAP

        public static final java.lang.String FAILED_DELETE_RECORD_ID_REASON_MAP
        Returned results: ID and failure reason of records that have failed to delete.
        Used to return the number of record IDs and failure reasons that the BDS is unable to delete. (Value is a Map, key is the entity's id and value is the failure reason).
        See Also:
        Constant Field Values
      • FAILED_DELETE_CONTAINER_ID_REASON_MAP

        public static final java.lang.String FAILED_DELETE_CONTAINER_ID_REASON_MAP
        Returned results: ID and failure reason of containers that have failed to delete.
        Used to the return number of container IDs and failure reasons that the BDS is unable to delete. (Value is a Map, key is the entity's id and value is the failure reason).
        See Also:
        Constant Field Values
      • SCHEDULECHANGED_ENTITIES

        public static final java.lang.String SCHEDULECHANGED_ENTITIES
        Returned results: list of entity IDs whose schedule have been changed.
        Used to return the entity IDs whose schedule have been changed. (Value is a HashMap).
        See Also:
        Constant Field Values
      • CONTAINEEHASDIFFSCHEDULE_CONTAINERS

        public static final java.lang.String CONTAINEEHASDIFFSCHEDULE_CONTAINERS
        Returned results: set of container IDs whose containees are controlled by different schedule.
        Used to return the container IDs whose containees are controlled by different schedule. (Value is a Set).
        See Also:
        Constant Field Values
      • ENTITIES_DISPOSED_CNT

        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:
        Constant Field Values
      • ENTITIES_UNFILE_CNT

        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:
        Constant Field Values
      • UNFILE_ENTITY_IDS

        public static final java.lang.String UNFILE_ENTITY_IDS
        See Also:
        Constant Field Values
      • ERROR_CNT

        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:
        Constant Field Values
      • RECORD_DISPOSED_CNT

        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:
        Constant Field Values
      • CONTAINER_DISPOSED_CNT

        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:
        Constant Field Values
      • UPDATE_BATCH_SIZE_OPTION

        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:
        Constant Field Values
      • DELETE_BATCH_SIZE_OPTION

        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:
        Constant Field Values
      • MULTIFILED_CACHE_SIZE_OPTION

        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:
        Constant Field Values
      • TRANSCRIPT_WRITER_FOR_AUTODEL_OPTION

        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 BufferedWriter).
        See Also:
        Constant Field Values
      • SERVICE_TERMINATOR

        public static final java.lang.String SERVICE_TERMINATOR
        Auto destroy terminator
        Used to check the termination flag for auto destroy (Value is a Terminator).
        See Also:
        Constant Field Values
      • ALLOW_MULTI_FILED_RECORDS

        public static final java.lang.String ALLOW_MULTI_FILED_RECORDS
        The option for allow multi-filed record
        Used to check the flag for enabling multi-filed record (Value is a Boolean).
        See Also:
        Constant Field Values
      • QUERY_BATCH_SIZE_OPTION

        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:
        Constant Field Values
      • THREAD_COUNT_OPTION

        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:
        Constant Field Values
      • DISPOSAL_TYPES_OPTION

        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:
        Constant Field Values
      • DISPOSAL_TYPE_AUTO_DESTROY

        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

        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

        public static final int RMENTITY_TYPE_RECORD
        Entity type for generic record instances. This is for Bulk Dispose Service
        See Also:
        Constant Field Values
      • RMENTITY_TYPE_ELECTRONICRECORD

        public static final int RMENTITY_TYPE_ELECTRONICRECORD
        Entity type for electronic record instances.
        See Also:
        Constant Field Values
      • RMENTITY_TYPE_EMAILRECORD

        public static final int RMENTITY_TYPE_EMAILRECORD
        Entity type for email record instances.
        See Also:
        Constant Field Values
      • RMENTITY_TYPE_MARKER

        public static final int RMENTITY_TYPE_MARKER
        Entity type for physical (marker) record instances.
        See Also:
        Constant Field Values
      • RMENTITY_TYPE_FILEPLAN

        public static final int RMENTITY_TYPE_FILEPLAN
        Entity type for ClassificationSchemes(a.k.a. Records Management), ClassificationScheme(a.k.a. File Plan) and LocationContainer
        See Also:
        Constant Field Values
      • RMENTITY_TYPE_RECORDCATEGORY

        public static final int RMENTITY_TYPE_RECORDCATEGORY
        Entity type for record category container.
        See Also:
        Constant Field Values
      • RMENTITY_TYPE_RECORDFOLDER

        public static final int RMENTITY_TYPE_RECORDFOLDER
        Entity type for record folder container.
        See Also:
        Constant Field Values
      • RMENTITY_TYPE_RECORDVOLUME

        public static final int RMENTITY_TYPE_RECORDVOLUME
        Entity type for record volume container.
        See Also:
        Constant Field Values
      • RMENTITY_TYPE_ELECTRONICRECORDFOLDER

        public static final int RMENTITY_TYPE_ELECTRONICRECORDFOLDER
        Entity type for electronic record folder container.
        See Also:
        Constant Field Values
      • RMENTITY_TYPE_PHYSICALCONTAINER

        public static final int RMENTITY_TYPE_PHYSICALCONTAINER
        Entity type for physical container.
        See Also:
        Constant Field Values
      • RMENTITY_TYPE_BOX

        public static final int RMENTITY_TYPE_BOX
        Entity type for box container.
        See Also:
        Constant Field Values
      • RMENTITY_TYPE_HYBRIDRECORDFOLDER

        public static final int RMENTITY_TYPE_HYBRIDRECORDFOLDER
        Entity type for hybrid record folder container.
        See Also:
        Constant Field Values
      • RMENTITY_TYPE_PHYSICALRECORDFOLDER

        public static final int RMENTITY_TYPE_PHYSICALRECORDFOLDER
        Entity type for physical record folder container.
        See Also:
        Constant Field Values
      • RMENTITY_TYPE_CONTAINER

        public static final int RMENTITY_TYPE_CONTAINER
        Entity type for generic RM container. This is used for Bulk Dispose Service
        See Also:
        Constant Field Values
      • RECORD_MIMETYPE_ELECT

        public static final java.lang.String RECORD_MIMETYPE_ELECT
        MimeType string for electronic record.
        See Also:
        Constant Field Values
      • RECORD_MIMETYPE_EMAIL

        public static final java.lang.String RECORD_MIMETYPE_EMAIL
        MimeType string for email record.
        See Also:
        Constant Field Values
      • RECORD_MIMETYPE_PHY

        public static final java.lang.String RECORD_MIMETYPE_PHY
        MimeType string for physical (marker) record.
        See Also:
        Constant Field Values
      • SECURITY_LEVEL_MARKINGSET_NAME

        public static final java.lang.String SECURITY_LEVEL_MARKINGSET_NAME
        Name of DoD Classified Marking Set
        See Also:
        Constant Field Values
      • SUPPLEMENTAL_MARKINGSET_NAME

        public static final java.lang.String SUPPLEMENTAL_MARKINGSET_NAME
        Name of Supplemental Marking Set
        See Also:
        Constant Field Values
      • FORMERLY_RESTRICTED_DATA

        public static final java.lang.String FORMERLY_RESTRICTED_DATA
        Supplemental Marking Set value used for DoD Chapter 4 validation.
        See Also:
        Constant Field Values
      • RESTRICTED_DATA

        public static final java.lang.String RESTRICTED_DATA
        Supplemental Marking Set value used for DoD Chapter 4 validation.
        See Also:
        Constant Field Values
      • DATA_MODEL_BASE

        public static final java.lang.String DATA_MODEL_BASE
        Name of RM Base Data Model.
        See Also:
        Constant Field Values
      • DATA_MODEL_PRO_VERION_2002

        public static final java.lang.String DATA_MODEL_PRO_VERION_2002
        Name of RM PRO-2002 Data Model.
        See Also:
        Constant Field Values
      • DATA_MODEL_DOD_VERSION_5015_2

        public static final java.lang.String DATA_MODEL_DOD_VERSION_5015_2
        Name of RM DoD Version 5015-2 Data Model.
        See Also:
        Constant Field Values
      • DATA_MODEL_DOD_VERSION_5015_2CHAPTER4

        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:
        Constant Field Values
      • DATA_MODEL_DOD_VERSION_5015_2_CLASSIFIED

        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:
        Constant Field Values
      • WORKFLOW_STATUS_NOT_STARTED

        public static final int WORKFLOW_STATUS_NOT_STARTED
        Record workflow status value used during validation.
        See Also:
        Constant Field Values
      • EXTERNALLY_MANAGED_BY_PSSATLAS

        public static final java.lang.String EXTERNALLY_MANAGED_BY_PSSATLAS
        Used for internal testing purposes.
        See Also:
        Constant Field Values

© Copyright IBM Corp. 2006, 2013. All Rights Reserved.