- ACCESSIONTO - Static variable in interface com.filenet.rm.api.RMProperty
-
Identifies the user or location to which the object has been transferred or is to be transferred.
- ACTION_AUTODELETE - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value represents the custom action.
- ACTION_CUTTOFF - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value that represents the cuttoff action.
- ACTION_DESTROY - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value that represents the destroy action.
- ACTION_EXPORT - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value that represents the export action.
- ACTION_INTRIMTRANSFER - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value that represents the interim transfer action.
- ACTION_NAME - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies a name for the disposal action that is to be taken on the object
after the cutoff date is reached or retention period in the disposal phase completes.
- ACTION_REVIEW - Static variable in interface com.filenet.rm.api.RMCustomObject
-
The integer variable represents the review action.
- ACTION_TRANSFER - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value represents the transfer action.
- ACTION_TYPE - Static variable in interface com.filenet.rm.api.RMProperty
-
Indicates the type of action that can be performed on the object
after the cutoff date occurs.
- ACTION_VITAL_REVIEW - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value that represents the vital review action.
- ActivableObject - Interface in com.filenet.rm.api
-
Defines the behavior of any Records Manager container object that can be activated or inactivated.
- activate(RMObjectStore, String[], String) - Method in class com.filenet.rm.api.util.RMBulkOperationsUtil
-
Activates all the RM entities whose IDs are specified in the
asArrObjectIDs input parameter.
- ACTIVE - Static variable in interface com.filenet.rm.api.RMProperty
-
Indicates whether a RecordHold
object is active or inactive.
- addAlternateRetention(String, Properties[]) - Method in interface com.filenet.rm.api.DispositionSchedule
-
Creates AlternateRetention
objects for each element in a specified Properties
collection and associates the new objects with a specified Phase
object.
- addClassDescription(ClassDescription, String[]) - Method in class com.filenet.rm.api.util.XmlHelper
-
- addGuideSection(String, String, Properties, Permissions) - Method in interface com.filenet.rm.api.GuideContainer
-
Adds a new
GuideSection
object to the hierarchy at the current level.
- addGuideTopic(String, String, Properties, Permissions) - Method in interface com.filenet.rm.api.GuideContainer
-
Adds a new
GuideTopic
object to the hierarchy at the current level.
- addLong(String, long) - Method in class com.filenet.rm.api.util.XmlHelper
-
- addNode(String, String, String) - Method in class com.filenet.rm.api.util.RMUtil
-
- addNode(String, Map) - Method in class com.filenet.rm.api.util.RMUtil
-
- addObjectStore(ObjectStore, String[], Object[]) - Method in class com.filenet.rm.api.util.XmlHelper
-
- addObjectStore(ObjectStore, String[], Object[], boolean) - Method in class com.filenet.rm.api.util.XmlHelper
-
- addPropertiestoSearchXml(String, String[], String) - Method in class com.filenet.rm.api.util.RMUtil
-
- addRecordCategory(String, Properties, Permissions) - Method in interface com.filenet.rm.api.RMRecordCategoryContainer
-
Adds a
RecordCategory
object to this container object and validates the
properties and permissions provided in the input parameters.
- addRecordFolder(String, Properties, Permissions) - Method in interface com.filenet.rm.api.RMRecordFolderContainer
-
Creates a new
RecordFolder
object with the specified properties and permissions
in this container object.
- addRecordFolder(String, String, Properties, Permissions) - Method in interface com.filenet.rm.api.RMRecordFolderContainer
-
Creates a new
RecordFolder
object with the specified properties and permissions
in this container object.
- ADDRESSEE - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies for an e-mail record the "To" address field, which represents
the recipient of the e-mail.
- addRMLog(RMObjectStore, Properties, Permissions) - Method in class com.filenet.rm.api.util.RMUtil
-
- addSearchRows(Object[], int, Object[], boolean, ObjectStore[]) - Method in class com.filenet.rm.api.util.XmlHelper
-
- addToDate(Date, int, int, int) - Method in class com.filenet.rm.api.util.RMUtil
-
- addVolume(Properties, Permissions) - Method in interface com.filenet.rm.api.RecordFolder
-
Creates a
Volume
object within this
RecordFolder
object using the
specified property and permission values.
- addVolumeWithName(Properties, Permissions) - Method in interface com.filenet.rm.api.RecordFolder
-
Adds the Volume object within this instance of a RecordFolder object.
- AGGREGATION - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the type of object that is to be created in a file plan.
- AGGREGATION_RECORD - Static variable in interface com.filenet.rm.api.RMObject
-
Specifies that this object represents a record.
- AGGREGATION_RECORD_CATEGORY - Static variable in interface com.filenet.rm.api.RMObject
-
Specifies that this object represents a record category.
- AGGREGATION_RECORD_FOLDER - Static variable in interface com.filenet.rm.api.RMObject
-
Specifies that this object represents a record folder.
- AGGREGATION_VOLUME - Static variable in interface com.filenet.rm.api.RMObject
-
Specifies that this object represents a volume.
- ALIAS - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies an alias or alternate name for a record.
- alias - Variable in class com.filenet.rm.api.util.QueryParser.SelectItem
-
- ALLOCATED_TO - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of the Allocatedto parameter.
- allocateDisposalSchedule(DispositionSchedule) - Method in interface com.filenet.rm.api.DispositionAllocatableObject
-
Associates the specified DispositionSchedule
object with this object.
- allocateRecordType(RecordType) - Method in interface com.filenet.rm.api.RecordInfo
-
Sets the AssociatedRecordType property for this
RecordInfo
object to the specified
RecordType
object.
- ALLOW_NORMAL_FOLDER - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of AllowNormalFolder.
- ALLOWED_RM_CONTAINEES - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of AllowedRMContainees for an RM object and specifies the type of
RM containees that can come within an RM entity.
- ALLOWED_RM_TYPES - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of AllowedRMTypes for an RM object and specifies the types of
RM entities that can come within this RM entity.
- ALTERNATE_RETENTION_NUMBER - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the number of intelligent retention associated with phase
- ALTERNATE_RETENTIONS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the property AlternateRetentions associated with Phase class.
- ANIMATION_ENABLED - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of the AnimationEnabled parameter.
- APPLICATIONID - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of the ApplicationID parameter.
- APPLIED_FOR - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the association between a pattern level and the objects
with which it is associated.
- APPLY_TO_NAME_OR_ID - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the pattern.It denotes whether the pattern is to be applied on Name or Id of the entity.
- applyDisposalScheduleInheritance(DispositionSchedule, int) - Method in interface com.filenet.rm.api.DispositionAllocatableObject
-
Associates a specified disposition schedule with the children of this object as indicated by
the aiApplyInheritTo
parameter.
- APPROVEDBY - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with several objects.
- ASSOCIATED_FOLDERS - Static variable in interface com.filenet.rm.api.RMProperty
-
Identifies the record folders that are associated with a
Hold
object.
- ASSOCIATED_PHASE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the property AssociatedPhase on the class DisposalSchedule.
- ASSOCIATED_PHASE_ID - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of AssociatedPhaseId for an RM object.
- ASSOCIATED_RECORD_CATEGORIES - Static variable in interface com.filenet.rm.api.RMProperty
-
- ASSOCIATED_RECORD_FOLDERS - Static variable in interface com.filenet.rm.api.RMProperty
-
- ASSOCIATED_RECORD_PTR - Static variable in interface com.filenet.rm.api.RMProperty
-
Identifies the records that are associated with a
RecordType
object.
- ASSOCIATED_RECORD_TYPES - Static variable in interface com.filenet.rm.api.RMProperty
-
- ASSOCIATED_RECORDS - Static variable in interface com.filenet.rm.api.RMProperty
-
Identifies the records that are associated with a
Hold
object.
- ASSOCIATED_RECORDTYPE - Static variable in interface com.filenet.rm.api.RMProperty
-
Identifies the
RecordType
object that is associated with a record.
- attachReceiptToParent(RecordInfo) - Method in interface com.filenet.rm.api.RecordInfo
-
Attaches this RecordInfo
object to the specified parent record as a receipt.
- AUDIT_ACTION_TYPE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of AuditActionType for an RM Audit object and specifies the type of
action that has been audited.
- auditEvent(RMObject, String, String, String, String, int) - Method in class com.filenet.rm.api.util.RMUtil
-
- AUTHOR - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies for an e-mail record the "From" address field, which represents
the author of the e-mail.
- AUTHORISING_STATUTE - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the agency or organization that defines the laws for regulating
the retention and maintenance of an object.
- AUTHORIZED_BY - Static variable in interface com.filenet.rm.api.RMProperty
-
- AUTHORIZED_ON - Static variable in interface com.filenet.rm.api.RMProperty
-
- CALENDAR_DATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of CalendarDate for a DisposalSchedule object.
- CALENDER_DATE - Static variable in interface com.filenet.rm.api.DispositionSchedule
-
An int
value that indicates that the triggering event for this
DispositionSchedule
object is a calendar date.
- CAN_DECLARE - Static variable in interface com.filenet.rm.api.RMProperty
-
Indicates whether a document can be declared as a record.
- canDeclare(String, String[]) - Method in interface com.filenet.rm.api.RMConnector
-
Validates the eligibility of a document for the declaration operation.
- canDeclare(String, String[]) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Verifies whether the specified documents or versions of a document can be declared as records
in this container object.
- CAPTION - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Digital Photograph Record Object.
- CAPTURE_DATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Web Record Object.
- CAPTURE_METHOD - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Web Record Object.
- CEMP_PREFIX - Static variable in class com.filenet.rm.api.util.RMUtil
-
Determines the cemp prefix string
- CHARGE_OUT_STATUS - Static variable in interface com.filenet.rm.api.RMProperty
-
Indicates the charged-out status of the object.
- CHARGE_OUT_TO - Static variable in interface com.filenet.rm.api.RMProperty
-
Identifies the user who has charged out the object.
- checkNull(String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Validates if passed String is null.
- checkPattern(String, String) - Method in class com.filenet.rm.api.util.RMUtil
-
- CLASSDESC - Static variable in class com.filenet.rm.api.util.XmlHelper
-
- CLASSIFICATION_DATE - Static variable in class com.filenet.rm.api.DODCH4Property
-
- CLASSIFICATION_GUIDE_NAME - Static variable in class com.filenet.rm.api.DODCH4Property
-
- CLASSIFICATION_SCHEME_NAME - Static variable in interface com.filenet.rm.api.RMProperty
-
- ClassificationGuide - Interface in com.filenet.rm.api
-
Represents a single classification guide.
- ClassificationGuides - Interface in com.filenet.rm.api
-
- ClassificationScheme - Interface in com.filenet.rm.api
-
Represents a file plan that enables a hierarchical grouping of various types of folders such as
record categories and record folders.
- ClassificationSchemes - Interface in com.filenet.rm.api
-
- CLASSIFICATIONSCHEMESROOTPTR - Static variable in interface com.filenet.rm.api.RMProperty
-
Provides a pointer to the ClassificationSchemeRoot
object
that is used by the system configuration object.
- CLASSIFIED_BY - Static variable in class com.filenet.rm.api.DODCH4Property
-
- CLASSIFIEDBY - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- CLASSIFIEDON - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- CLASSIFYING_AGENCY - Static variable in class com.filenet.rm.api.DODCH4Property
-
- CLASSIFYING_AGENCY - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- CLASSSUB - Static variable in class com.filenet.rm.api.util.XmlHelper
-
- CLEAR_INHERITED_CHILDREN - Static variable in interface com.filenet.rm.api.RMObject
-
Specifies that the disposition schedule is to be removed from all children that
that inherited the schedule from this object.
- clearDispositionData() - Method in interface com.filenet.rm.api.DisposableObject
-
Clears the disposition data from this object.
- clearDispositionData(RMObjectStore, String[]) - Method in class com.filenet.rm.api.util.RMBulkOperationsUtil
-
Performs the clear disposition properties operation on all RM entities whose Ids are specified in
the asArrObjectIDs input parameter.
- clearDispositionSchedule(int) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Clears the disposition schedule and disposition data from this container object and,
optionally, from its children.
- clearVitalData() - Method in interface com.filenet.rm.api.DisposableObject
-
Clears the vital data from this object.
- ClosableObject - Interface in com.filenet.rm.api
-
Defines the behavior of a Records Manager container object that can be closed.
- close(String) - Method in interface com.filenet.rm.api.ClosableObject
-
Closes this object.
- close(RMObjectStore, String[], String) - Method in class com.filenet.rm.api.util.RMBulkOperationsUtil
-
Performs the Close operation on all the RM objects whose IDs are specified in
the asArrObjectIDs input parameter.
- CLOSED_BY - Static variable in interface com.filenet.rm.api.RMProperty
-
Identifies the user who closed the object.
- CODE - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with several objects.
- COLOR_PROFILE - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Digital Photograph Record Object.
- com.filenet.rm.api - package com.filenet.rm.api
-
- com.filenet.rm.api.exception - package com.filenet.rm.api.exception
-
- com.filenet.rm.api.util - package com.filenet.rm.api.util
-
- completePhaseExecution(Date, boolean) - Method in interface com.filenet.rm.api.DisposableObject
-
Completes the currently executing phase for this object by updating the current
phase execution date metadata and cutoff metadata.
- completePhaseExecution(Date, boolean, boolean) - Method in interface com.filenet.rm.api.DisposableObject
-
Completes the currently executing phase for this object by updating the current
phase execution date and cutoff properties.
- COMPRESSION - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Digital Photograph Record Object.
- CONDITION_XML - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the property ConditionXML on the class AlternateRetention and Disposal Trigger.
- CONTACT - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Web Record Object.
- CONTAINER_TYPE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ContainerType for an RM object, the type of container.
- containsValue(int[], int) - Method in class com.filenet.rm.api.util.RMUtil
-
- CONTENT_MANAGEMENT_SYSTEM - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Web Record Object.
- copy(RMRecordContainer, Properties) - Method in interface com.filenet.rm.api.RecordInfo
-
Creates a copy of this
RecordInfo
object in the specified
RMRecordContainer
object within the same file plan.
- copy(RMObjectStore, String[], RMRecordContainer, String) - Method in class com.filenet.rm.api.util.RMBulkOperationsUtil
-
Performs the copy operation on all RecordInfo Objects whose Ids are specified in
asArrObjectIDs input parameter.
- copy(RMObjectStore, String[], RMRecordContainer, Properties) - Method in class com.filenet.rm.api.util.RMBulkOperationsUtil
-
Performs the copy operation on all RecordInfo Objects whose Ids are specified in
asArrObjectIDs input parameter.
- copyDocument(String, String, Properties, Permissions) - Method in interface com.filenet.rm.api.RMConnector
-
Creates a copy of a specified document with the specified property and permission values.
- COPYRIGHT - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Digital Photograph Record Object.
- COUNT - Static variable in class com.filenet.rm.api.util.XmlHelper
-
- createClassificationGuide(String, String, Properties, Permissions) - Method in interface com.filenet.rm.api.RMObjectStore
-
Creates a new
ClassificationGuide
object in the /Records Management/ClassificationGuides
folder within this object store.
- createClassificationScheme(String, Properties, Permissions) - Method in interface com.filenet.rm.api.RMObjectStore
-
Constructs a ClassificationScheme
object with the specified property and
permission values, and places the new object in this object store.
- createDispositionSchedule(Properties, Permissions) - Method in interface com.filenet.rm.api.RMObjectStore
-
Constructs a DispositionSchedule
object with the specified property and
permission values, and places the new object in this object store.
- createLocation(Properties, Permissions, String) - Method in interface com.filenet.rm.api.RMObjectStore
-
Creates a Location
object in the specified folder.
- createPattern(Properties, Permissions) - Method in interface com.filenet.rm.api.RMObjectStore
-
Creates a Pattern
object that specifies a naming pattern for file plans in the
object store.
- createPatternLevel(Properties, Permissions, String) - Method in interface com.filenet.rm.api.RMObjectStore
-
Creates a PatternLevel
object to be associated with the specified
Pattern
object in this object store.
- createPhase(Properties, Permissions) - Method in interface com.filenet.rm.api.DispositionSchedule
-
- createPhaseWithAlternateRetention(Properties, Permissions, Properties[]) - Method in interface com.filenet.rm.api.DispositionSchedule
-
Creates a Phase
object using the specified properties and permissions, and
adds the new object as the last entry in the Phase
collection associated with
this DipositionSchedule
object.
- createRecordType(Properties, Permissions) - Method in interface com.filenet.rm.api.RMObjectStore
-
Constructs a RecordType
object with the specified property and
permission values, and places the new object in this object store.
- createRMCustomObject(int, Properties, Permissions) - Method in interface com.filenet.rm.api.RMObjectStore
-
Constructs an RMCustomObject
object of the specified type
and places the new object in this object store.
- createRMException(int, int, Exception, Object[]) - Static method in exception com.filenet.rm.api.exception.RMException
-
Returns for an exception of type ERROR or FATAL an RMException
object that
contains a localized message derived from the specified Exception
object.
- createVolume(RecordFolder, String, String, String, Properties, Permissions) - Method in interface com.filenet.rm.api.Volume
-
Creates a Volume object with specified properties and permissions in a RecordFolder object.
- createXMLdoc(InputSource) - Method in class com.filenet.rm.api.util.RMUtil
-
- createXMLDoc(Reader) - Method in class com.filenet.rm.api.util.RMUtil
-
- createXMLDoc(String) - Method in class com.filenet.rm.api.util.RMUtil
-
- createXMLDoc(InputStream) - Method in class com.filenet.rm.api.util.RMUtil
-
- CREATING_APPLICATION - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the PDF Record Object.
- CTR_C4OBJECT_BASE - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a DoD Chapter 4 object.
- CTR_CONTAINER_BASE - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a folder.
- CTR_CUSTOMOBJECT_BASE - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a custom object.
- CTR_IMPL_BASE - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a setup; that is, the entity represents the
PRO, DOD or Base standard.
- CTR_IMPL_RMAUDIT_BASE - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a specific audit.
- CTR_LINK_BASE - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a link.
- CTR_OBJECTSTORE_BASE - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is an enabled object store.
- CTR_RECORD_BASE - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a record.
- CURRENT_ACTION_TYPE - Static variable in interface com.filenet.rm.api.RMProperty
-
Indicates the type of action that is associated with the current phase of
the object.
- CURRENT_CLASSIFICATION - Static variable in class com.filenet.rm.api.DODCH4Property
-
- CURRENT_CLASSIFICATION - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- CURRENT_PHASE_ACTION - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of CurrentPhaseAction for an RM object and specifies the action of the
current phase that is associated.
- CURRENT_PHASE_DECISION_DATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of CurrentPhaseDecisionDate.
- CURRENT_PHASE_EXECUTION_DATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the date when the action associated with a particular phase is
to be performed on the object.
- CURRENT_PHASE_EXECUTION_STATUS - Static variable in interface com.filenet.rm.api.RMProperty
-
Indicates the current phase execution status that is to be used by the
workflow for the object.
- CURRENT_PHASE_EXPORTDESTINATION - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of CurrentPhaseExportDestination.
- CURRENT_PHASE_EXPORTFORMAT - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of CurrentPhaseExportFormat for an RM object, the XSL format that
should be applied to export XML.
- CURRENT_PHASE_ID - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of CurrentPhaseId for an RM object and specifies the ID of the current
phase that is associated.
- CURRENT_PHASE_REVIEW_COMMENTS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the comments provided by the reviewer for the current disposition phase
of the object.
- CURRENT_PHASE_REVIEW_DECISION - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of CurrentPhaseReviewDecision.
- CUSTOMOBJECT - Static variable in class com.filenet.rm.api.util.XmlHelper
-
- CUT_OFF_INHERITED_FROM - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of CutoffInheritedFrom for an RM Entity and specifies GUID of the
parent from which cut off is inherited.
- CUTOFF_ACTION - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the cutoff action that triggers the disposition process of the object.
- CUTOFF_BASE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the property CutOffBase on the class Disposal Schedule.
- CUTOFF_DATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the cutoff date that was set by the disposal sweep for the object.
- CUTOFF_DISPOSAL_TRIGGER - Static variable in interface com.filenet.rm.api.RMProperty
-
Soecifies the disposal trigger that is executed when the cutoff of the object is reached.
- CUTOFF_OFFSET_DAYS - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies for a
DispositionSchedule
object the number of days after an event occurs
that the retention period should begin.
- CUTOFF_OFFSET_MONTHS - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies for a
DispositionSchedule
object the number of months after an event occurs
that the retention period should begin.
- CUTOFF_OFFSET_YEARS - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies for a
DispositionSchedule
object the number of years after an event occurs
that the retention period should begin.
- CUTOFF_REVIEW_COMMENTS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the comments provided by the reviewer for the cutoff review
of the object.
- CYCLE_DAYS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the number of days for which the iteration of an event is to reoccur
for a DisposalTrigger
object.
- CYCLE_MONTHS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the number of months for which the iteration of an event is to reoccur
for a DisposalTrigger
object.
- CYCLE_YEARS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the number of years for which the iteration of an event is to reoccur
for a DisposalTrigger
object.
- CYCLIC_EVENT - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value that represents the cyclic event.
- DATE_CLOSED - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the date that a record category, an electronic category, or a physical folder
was closed.
- DATE_DECLARED - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the date that a document was declared as record.
- DATE_ISSUED - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with several objects.
- DATE_LAST_DECLARATION - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the date that the latest record was declared in a record container.
- DATE_OF_LAST_FOI_DISCLOSABILITY_REVIEW - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the date that the latest Freedom of Information (FOI) disclosability review
was performed on the object.
- DATE_OF_LAST_REVIEW - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the date that the latest review was performed on the object.
- DATE_OPENED - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the date that the folder was first opened.
- DATE_RECEIVED - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies for an e-mail record the date on which the e-mail was received.
- DATETIME - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the date of a time-based event, including an event for which the date is predefined,
for a disposition trigger.
- DEBUG - Static variable in exception com.filenet.rm.api.exception.RMException
-
- debug(String) - Method in class com.filenet.rm.api.util.RMLogger
-
- debug(String, Throwable) - Method in class com.filenet.rm.api.util.RMLogger
-
- debug(String, String, Throwable) - Method in class com.filenet.rm.api.util.RMLogger
-
- declare(DocumentStore, String[], RMFolder[], Properties, String, Permissions, boolean) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Declares the specified documents as a single record and files the new record in the specified folders.
- declare(DocumentStore, String[], RMFolder[], Properties, String, Permissions, boolean, boolean) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Declares the specified documents as a single record and files the new record in the specified folders.
- declare(String, String[], RMFolder[], Properties, String, Permissions, boolean) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Declares the versions of the specified document as a single record and files the new record in
the specified folders.
- declare(String, String[], RMFolder[], Properties, String, Permissions, boolean, boolean) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Declares the versions of the specified document as a single record and files the new record in
the specified folders.
- declareAllVersions(DocumentStore, String, boolean, RMFolder[], Properties, String, Permissions, boolean, Map) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Declares all versions of the specified documents as either a single record or as separate records,
and files the record or records in the specified folders.
- declareAllVersions(DocumentStore, String, boolean, RMFolder[], Properties, String, Permissions, boolean, Map, boolean) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Declares all versions of the specified documents as either a single record or as separate records,
and files the record or records in the specified folders.
- declareAllVersions(String, boolean, RMFolder[], Properties, String, Permissions, boolean, Map) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Declares all versions of the documents specified by the asURL
parameter as either a single record or as separate records,
and files the record or records in the specified folders.
- declareAllVersions(String, boolean, RMFolder[], Properties, String, Permissions, boolean, Map, boolean) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Declares all versions of the documents specified by the asURL
parameter as either a single record or as separate records,
and files the record or records in the specified folders.
- declareAndClassify(DocumentStore, String[], RMFolder[], Properties, String, Permissions, boolean, boolean) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Declares the specified document as a record with the security classification specified in the
aoRecordProps
parameter.
- declareAndClassify(String, String[], RMFolder[], Properties, String, Permissions, boolean, boolean) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Declares the specified document as a record with the security classification specified in the
aoRecordProps
parameter.
- DECLARED_BY - Static variable in interface com.filenet.rm.api.RMProperty
-
Identifies the user who declared the document as a record.
- declareDocument(String, String, String[], Properties, Permissions) - Method in interface com.filenet.rm.api.RMConnector
-
Sets the required properties to the document, which are related to the declaration and finally updates the permission of the document to that of the record as supplied.
- declareDocument(String, RecordInfo, String[], Properties, Permissions) - Method in interface com.filenet.rm.api.RMConnector
-
Sets the required properties to the document, which are related to the declaration and finally updates the permission of the document to that of the record as supplied.
- declareDocument(String, String, String[], Properties, Permissions, DocumentStore) - Method in interface com.filenet.rm.api.RMConnector
-
Sets the isRecord and RecordLink properties to the document, which are related to the declaration and finally updates the permission of the document to that of the record as supplied.
- DECLASSIFIED_BY - Static variable in class com.filenet.rm.api.DODCH4Property
-
- DECLASSIFIED_ON - Static variable in class com.filenet.rm.api.DODCH4Property
-
- DECLASSIFIEDBY - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- DECLASSIFIEDON - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- declassify(Properties) - Method in interface com.filenet.rm.api.RecordInfo
-
Sets the security classification to declassify this RecordInfo
object
according to the DoD 5015.2-STD Chapter 4 standards.
- DECLASSIFY_DATE_NOT_WITHIN_TIME_LIMIT - Static variable in class com.filenet.rm.api.ValidationError
-
The declassification date exceeds the maximum allowed timeframe.
- DECLASSIFY_ON_DATE - Static variable in class com.filenet.rm.api.DODCH4Property
-
- DECLASSIFY_ON_EVENTS - Static variable in class com.filenet.rm.api.DODCH4Property
-
- DECLASSIFY_REMARKS - Static variable in class com.filenet.rm.api.DODCH4Property
-
- DECLASSIFY_REMARKS - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- DECLASSIFYON_DATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- DECLASSIFYON_EVENTS - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- DecodeFormattedString(String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Decode the passed String by replacing strings like &,<,> with filter operators.
- DEFAULT_RECORD_VERSION - Static variable in interface com.filenet.rm.api.RMProperty
-
- DEFAULT_VALUE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of DefaultValue.
- DEFAULT_WORKFLOW - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the default workflow that is to be launched for the disposition
action that is associated with the object.
- delete() - Method in interface com.filenet.rm.api.GuideContainer
-
- delete(boolean, String) - Method in interface com.filenet.rm.api.RecordInfo
-
Deletes this RecordInfo
object.
- delete(boolean, String) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Deletes this container object provided there is no constraint, such as the object
being on hold, that prevents the object from being deleted.
- delete(RMObjectStore, String[]) - Method in class com.filenet.rm.api.util.RMBulkOperationsUtil
-
Performs the delete operation on all RM Entities whose IDs are specified in
asArrObjectIDs input parameter.
- deleteAlternateRetention(String) - Method in interface com.filenet.rm.api.DispositionSchedule
-
Deletes a specified AlternateRetention
object.
- deleteDocument(String) - Method in interface com.filenet.rm.api.RMConnector
-
Deletes the specified document from the records object store (ROS).
- deleteFromParent(boolean, String, RMRecordContainer) - Method in interface com.filenet.rm.api.RecordInfo
-
Called by the specified
RMRecordContainer
object to delete this
RecordInfo
object in response to the destroy operation being invoked on that
RMRecordContainer
object.
- deletePhase(String) - Method in interface com.filenet.rm.api.DispositionSchedule
-
Deletes the specified Phase
object and updates the sequence of all associated
Phase
objects to reflect the change.
- DELETIONNOTALLOWED - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of DeletionNotAllowed.
- DERIVED_FROM - Static variable in class com.filenet.rm.api.DODCH4Property
-
- DERIVEDFROM - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- DESCRIPTION - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with ClassificationGuide object.
- DESCRIPTOR - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of Descriptor.
- destroy(boolean) - Method in interface com.filenet.rm.api.DisposableObject
-
Deletes this object either logically or physically from the object store.
- destroy(boolean, boolean) - Method in interface com.filenet.rm.api.DisposableObject
-
Deletes this object either logically or physically from the object store.
- destroyFromParent(boolean, RMRecordContainer) - Method in interface com.filenet.rm.api.RecordInfo
-
Called by the specified
RMRecordContainer
object to delete this
RecordInfo
object in response to the destroy operation being invoked in a workflow on that
RMRecordContainer
object.
- destroyWithoutSchedule(boolean) - Method in interface com.filenet.rm.api.DisposableObject
-
Deletes this object either logically or physically from the object store without disposition schedule.
- detachReceiptFromParent() - Method in interface com.filenet.rm.api.RecordInfo
-
Detaches this RecordInfo
object from a parent record as a receipt
for that parent.
- DISCLOSABILITY_TO_DPA_DATA_SUBJECT - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the details of the Freedom of Information (FOI) Release details.
- DisposableObject - Interface in com.filenet.rm.api
-
Represents a Records Manager object that can be disposed of using the automated
disposal process.
- DISPOSAL - Static variable in class com.filenet.rm.api.util.RMUtil
-
The int value represents the Disposition Workflow associated to be launched.
- DISPOSAL_AUTHORIZED_BY - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the user who authorizes the disposal of the object.
- DISPOSAL_INSTRUCTION - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the instructions provided for disposal of an entity..
- DISPOSAL_PHASES - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the disposal phases that are associated with a disposition schedule.
- DISPOSAL_SCHEDULE - Static variable in interface com.filenet.rm.api.RMProperty
-
Identifies the disposition schedule that is associated with the object.
- DISPOSAL_SCHEDULE_ALLOCATIONDATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the date on which the disposition schedule was associated with the object.
- DISPOSAL_SCHEDULE_INHERITEDFROM - Static variable in interface com.filenet.rm.api.RMProperty
-
Identifies the RMFolder
or RecordType
object from which
the object inherited its disposition schedule.
- DISPOSAL_SCHEDULE_NAME - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the name of a disposition schedule.
- DISPOSAL_SCHEDULE_PTR - Static variable in interface com.filenet.rm.api.RMProperty
-
Identifies the disposition schedule that is associated with the Phase
object.
- DISPOSAL_TRIGGER_NAME - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the name of the DisposalTrigger
object.
- DISPOSE_RECEIPTS - Static variable in class com.filenet.rm.api.DODCH4Property
-
- DISPOSITION_AUTHORITY - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the agency or organization that defines the laws for regulating the retention and
maintenance of the object.
- DispositionAllocatableObject - Interface in com.filenet.rm.api
-
Defines the behavior of a Records Manager object
that can be be associated with a
DispositionSchedule
object to define
the disposition process for the Records Manager object and its children.
- DispositionSchedule - Interface in com.filenet.rm.api
-
Represents a set instructions that are allocated to a Records Manager object
to indicate how long that object is to be retained for business purposes.
- DispositionSchedules - Interface in com.filenet.rm.api
-
- DOCUMENT - Static variable in class com.filenet.rm.api.util.XmlHelper
-
- DOCUMENT_LINK - Static variable in interface com.filenet.rm.api.RMProperty
-
Identifies the Document
objects that are represented by a record.
- DOCUMENT_SECURITY_SETTINGS - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the PDF Record Object.
- DOCUMENT_TITLE - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the title of a Document
object.
- DocumentStore - Interface in com.filenet.rm.api
-
Represents a repository in which documents are stored.
- DOCURI - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the URL of a Document
object that is to be declared as a record.
- DODCH4Property - Class in com.filenet.rm.api
-
- DODCH4Property() - Constructor for class com.filenet.rm.api.DODCH4Property
-
- doMultipleFilePlanExist(RMObjectStore) - Method in class com.filenet.rm.api.util.RMUtil
-
- downgrade(Properties) - Method in interface com.filenet.rm.api.RecordInfo
-
Sets the security classification for this RecordInfo
object to a
less restrictive level according to the DoD 5015.2-STD Chapter 4 standards.
- DOWNGRADE_INSRUCTIONS - Static variable in class com.filenet.rm.api.DODCH4Property
-
- DOWNGRADE_INSTRUCTIONS - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- DOWNGRADE_ON_DATE - Static variable in class com.filenet.rm.api.DODCH4Property
-
- DOWNGRADE_ON_EVENTS - Static variable in class com.filenet.rm.api.DODCH4Property
-
- DOWNGRADE_REMARKS - Static variable in class com.filenet.rm.api.DODCH4Property
-
- DOWNGRADE_REMARKS - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- DOWNGRADED_BY - Static variable in class com.filenet.rm.api.DODCH4Property
-
- DOWNGRADED_ON - Static variable in class com.filenet.rm.api.DODCH4Property
-
- DOWNGRADEDBY - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- DOWNGRADEDON - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- DOWNGRADEON_DATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- DOWNGRADEON_EVENTS - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- DPA_DATA_SUBJECT_ACCESS_EXEMPTION - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the details of the Data Protection Act (DPA)
Data Subject Access Exemption for the object.
- DPAEXEMPTCATEGORY - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the details of the Data Protection Act (DPA) Exempt Category for the object.
- editVolumeProperties(Properties, String, String, RecordFolder) - Method in interface com.filenet.rm.api.Volume
-
Edits the properties of the new instance of a volume that is to be created.
- EDM_HOLD - Static variable in interface com.filenet.rm.api.RMProperty
-
- EFFECTIVE_DATE_MODIFIED - Static variable in interface com.filenet.rm.api.RMProperty
-
Specifies the date on which the metadata of the object was modified.
- EIR_DISCLOSABILITY_INDICATOR - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the Environmental Information Regulation (EIR) Disclosability Indicator
for the object.
- EIR_EXEMPTION - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of Environmental Information Regulation (EIR) Exemption
for the object.
- EMAILNOTIFICATIONUSERS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of EmailNotificationUsers.
- endCollection(String, boolean) - Method in class com.filenet.rm.api.util.XmlHelper
-
- endCollection(String) - Method in class com.filenet.rm.api.util.XmlHelper
-
- ENTITY_RECORDCATEGORY - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the entity of class RecordCategory.
- ENTITY_RECORDFOLDER - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the entity of class RecordFolder.
- ENTITY_RECORDINFO - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the entity of class RecordInfo.
- ENTITY_VOLUME - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the entity of class Volume.
- ERROR - Static variable in exception com.filenet.rm.api.exception.RMException
-
- error(String) - Method in class com.filenet.rm.api.util.RMLogger
-
- error(String, Throwable) - Method in class com.filenet.rm.api.util.RMLogger
-
- error(String, String, Throwable) - Method in class com.filenet.rm.api.util.RMLogger
-
- ERROR_CODE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the Error code associated with the RMException.
- ERROR_MESSAGE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the Error Message associated with the RMException.
- ERROR_TYPE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the Error type associated with the RMException.
- EVENT_TYPE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of EventType for a DisposalTrigegr object and specifies which event
will be fired when the DisposalTrigger will be executed.
- EXCEPTIONS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of Exceptions.
- executeInterimTransfer(RMCustomObject) - Method in interface com.filenet.rm.api.DisposableObject
-
Performs an interim transfer action on this object.
- executeInterimTransferWithTransferAPI(RMCustomObject, String, boolean) - Method in interface com.filenet.rm.api.DisposableObject
-
This method performs interim transfer action on the current instance of DisposableObject.
- executeInterimTransferWithTransferAPI(RMCustomObject, Map, String, boolean) - Method in interface com.filenet.rm.api.DisposableObject
-
This method performs interim transfer action on the current instance of DisposableObject.
- executeSinglePagedContentXML(String, int, boolean) - Method in interface com.filenet.rm.api.RMSearch
-
Searches for a specified number of objects across one or more object stores by content,
and returns array that contains the IDs of the Record Manager objects meeting the
search criteria.
- executeVital() - Method in interface com.filenet.rm.api.VitalableObject
-
Calculates the vital review date and sets the Vital Record Review Date
property for this object to that date.
- executeXML(String, String, String) - Method in interface com.filenet.rm.api.RMPagedSearch
-
Searches across one or more object stores by property values, by content, or both,
and returns an XML String
that contains a representation of the Record Manager objects
meeting the search criteria.
- executeXML(String, String, String) - Method in interface com.filenet.rm.api.RMSearch
-
Searches across one or more object stores by property values, by content, or both,
and returns an XML String
that contains a representation of the Record Manager objects
meeting the search criteria.
- EXEMPTIONS - Static variable in class com.filenet.rm.api.DODCH4Property
-
- EXEMPTIONS - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- EXIF_INFORMATION - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Digital Photograph Record Object.
- export() - Method in interface com.filenet.rm.api.DisposableObject
-
Exports this object and its children to XML files that, by default, are structured according
to the Content Engine export schema.
- EXPORT_DATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ExportDate.
- EXPORT_DESTINATION - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ExportDestination for a DisposalPhase and Phase object,
specifies the export destination.
- EXPORT_FORMAT - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ExportFormat for a DisposalPhase and Phase object,
specifies the export format.
- exportDocument(String, String) - Method in interface com.filenet.rm.api.RMConnector
-
Exports the documents identified by the URL in XML string format.
- exportWithTransferAPI(String, boolean) - Method in interface com.filenet.rm.api.DisposableObject
-
This method exports the given object as an XML with the RM Transfer API.
- exportWithTransferAPI(Map, String, boolean) - Method in interface com.filenet.rm.api.DisposableObject
-
This method exports the given object as an XML with RM Transfer API, with the given Transfer Source Context.
- EXTERNAL_EVENT - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value that represents the external event.
- EXTERNAL_EVENT_OCCURANCE_DATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ExternalEventOccuranceDate for a RM object and specifies
the date of occurance of external event.
- EXTERNALLY_MANAGED_BY - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the name of the external application which is managing FPOS content
- EXTRACTSTATUS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ExtractStatus.
- generateDocumentURI(RMObjectStore, String) - Method in class com.filenet.rm.api.util.RMUtil
-
- getActingDisposalSchedule(RMObject) - Method in class com.filenet.rm.api.util.RMUtil
-
- getActiveVolume() - Method in interface com.filenet.rm.api.RecordFolder
-
Returns the
Volume
object that is currently active in this
RecordFolder
object.
- getAllAllowedContaineeType() - Method in interface com.filenet.rm.api.RMFolder
-
Returns a list of the Record Manager entity types that can be contained in
this RMFolder
object regardless of its current state.
- getAllAllowedContaineeType(Property) - Method in interface com.filenet.rm.api.RMFolder
-
Returns a list of the Record Manager entity types that can be contained in
this RMFolder
object regardless of its current state.
- getAllAssociatedROS(RMObjectStore) - Static method in class com.filenet.rm.api.util.RMUtil
-
- getAllChildsOnHold() - Method in interface com.filenet.rm.api.HoldableObject
-
Returns the children of this HoldableObject
object that are
on hold.
- getAllImplementataions(RMObjectStore) - Static method in class com.filenet.rm.api.util.RMUtil
-
This method search for the connector registration and returns the Map containing the implementation class name as the key and the value is the ArrayList that in turn contains the ArrayList containing the parameters like server name, repository name and the repository type
- getAllObjectStores(EntireNetwork) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a collection that contains all the object stores in the EntireNetwork.
- getAllObjectStoresXML(EntireNetwork, String[]) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns all the object stores properties in XML form from the EntireNetwork Object
- getAllowedContainee() - Method in interface com.filenet.rm.api.RMFolder
-
Returns the Record Manager entity types that can be contained in
this RMFolder
object regardless of its current state.
- getAllowedContaineeType() - Method in interface com.filenet.rm.api.RMFolder
-
Returns a list of the Record Manager entity types that can be contained in
this RMFolder
object in its current state.
- getAllVersions(String) - Method in interface com.filenet.rm.api.RMConnector
-
Retrieves all version numbers of the document specified by the URL.
- getAssociatedDisposalSchedule() - Method in interface com.filenet.rm.api.DispositionAllocatableObject
-
Returns the DispositionSchedule
object that is associated with this object.
- getAssociatedDocumentIds() - Method in interface com.filenet.rm.api.RecordInfo
-
Returns the IDs of all Document
objects associated with this RecordInfo
object.
- getAssociatedHolds() - Method in interface com.filenet.rm.api.HoldableObject
-
Returns the
Hold
objects that are associated with this
HoldableObject
object.
- getAssociatedRecords() - Method in interface com.filenet.rm.api.RecordType
-
Returns all records associated with this RecordType
object.
- getAssociatedRecordType() - Method in interface com.filenet.rm.api.RecordInfo
-
Returns the
RecordType
object with which this
RecordInfo
object is assoicated.
- getAssociatedRMobjects() - Method in interface com.filenet.rm.api.Hold
-
Returns the Record Manager objects that are associated with
this Hold
object.
- getAssociatedRMobjects(String[], String[], int, String) - Method in interface com.filenet.rm.api.Hold
-
Returns a Document
object containing the Record Manager objects that are associated with
this Hold
object.
- getAutoName() - Method in class com.filenet.rm.api.RMDriverManager
-
Returns the auto-namining implementation that is registered for this object.
- getCEConnection(Session) - Static method in class com.filenet.rm.api.util.RMUtil
-
Retrieves a CE 4.0 Connection aka DaphneConnection object from the current Buzz Session
- getChar() - Method in enum com.filenet.rm.api.util.RMLogger.Severity
-
Returns the char representing the severity level.
- getClassDescriptions(int[], boolean, boolean) - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns a collection of the ClassDescription
objects, which contain the
metadata for the classes of the specified types in this object store.
- getClassDescriptions(RMObjectStore, int[], boolean) - Method in class com.filenet.rm.api.util.RMUtil
-
- getClassDescriptionsXML(RMObjectStore, int[], boolean) - Method in class com.filenet.rm.api.util.RMUtil
-
- getClassIDs(RMObjectStore, int[], boolean) - Method in class com.filenet.rm.api.util.RMUtil
-
- getClassificationGuide() - Method in interface com.filenet.rm.api.GuideSection
-
Returns the top-level classification guide for this GuideSection
object.
- getClassificationGuide() - Method in interface com.filenet.rm.api.GuideTopic
-
Retrieves the top-level classification guide for this GuideTopic
object.
- getClassificationGuides() - Method in interface com.filenet.rm.api.RMObjectStore
-
- getClassificationGuides(String[]) - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns the
ClassificationGuide
objects, along with their properties, that
are contained in this object store.
- getClassificationGuidesXML(String[]) - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns a
String
in XML format that represents the collection of
ClassificationGuide
objects in this object store along with their properties.
- getClassificationSchemeInterface(Folder) - Method in interface com.filenet.rm.api.RMObjectStore
-
Constructs a ClassificationScheme
object based on
the specified Folder
object and places the new object in this object store.
- getClassificationSchemeRootPath() - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns the path of ClassificationSchemeRoot
object for this object store.
- getClassificationSchemes() - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns a collection containing the ClassificationScheme
objects in this
object store.
- getClassificationSchemesXML(String[]) - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns a String
that contains the XML representation of the ClassificationScheme
objects in this object store along with their specified properties.
- getClosedParents(boolean) - Method in interface com.filenet.rm.api.ClosableObject
-
Returns a collection containing either the first closed parent of this object or
all closed parents of this object.
- getCode() - Method in class com.filenet.rm.api.ValidationError
-
Returns the error code for this ValidationError
object.
- getCollection(String[]) - Method in class com.filenet.rm.api.util.RMUtil
-
- getConnector(RMObjectStore, String) - Method in class com.filenet.rm.api.RMDriverManager
-
Returns the connector implementation that is to be invoked for a specified ConnectorRegistration
object.
- getConnector(RMObjectStore, String, Session) - Method in class com.filenet.rm.api.RMDriverManager
-
Returns the connector implementation that is to be invoked for a specified ConnectorRegistration
object.
- getConnectorQueryString(String, String, String) - Method in class com.filenet.rm.api.util.RMUtil
-
- getConnectorRegistrationClass(RMObjectStore, String) - Method in class com.filenet.rm.api.util.RMUtil
-
- getConnectorSearchURL(RMObjectStore, String, Map) - Static method in class com.filenet.rm.api.util.RMUtil
-
Generates the search URL that needs to be passed to the RMConnector implementation for the search related methods
- getContainees(int[], String[], boolean, int, int) - Method in interface com.filenet.rm.api.RMFolder
-
Returns a collection of the
RMObject
objects of the specified types that are contained in this
RMFolder
object.
- getContaineesXML(int[], String[], boolean, int, int) - Method in interface com.filenet.rm.api.RMFolder
-
Returns the
RMObject
objects of the specified types that are contained in this
RMFolder
object.
- getContent() - Method in interface com.filenet.rm.api.RecordInfo
-
Obtains an input stream for the content element of the first Document
object
associated with this RecordInfo
object.
- getContent(String) - Method in interface com.filenet.rm.api.RecordInfo
-
Obtains an input stream for the content element of the specified Document
object
that is associated with this RecordInfo
object.
- getCountFromResultSet(String) - Method in class com.filenet.rm.api.util.RMUtil
-
- getCountFromSingleObjectType(String) - Method in class com.filenet.rm.api.util.RMUtil
-
- getCurrentPhaseExecutionDate(DisposableObject) - Method in class com.filenet.rm.api.util.RMUtil
-
- getCurrentVersion(String) - Method in interface com.filenet.rm.api.RMConnector
-
Retrieves the current or latest version of the document that is specified by the URL.
- getDeclareDocuments(String, String[]) - Method in interface com.filenet.rm.api.RMConnector
-
Retrieves the documents that correspond to the documentID provided in the URL and the version supplied.
- getDeclassifyProperties() - Static method in class com.filenet.rm.api.DODCH4Property
-
- getDeletedObjects() - Method in interface com.filenet.rm.api.RMFolder
-
Returns the RM entities contained in the hierarchy below this
RMFolder
object that have been logically deleted.
- getDeletedObjectsIds() - Method in interface com.filenet.rm.api.RMFolder
-
Returns the GUIDs of the RM entities contained in the hierarchy below this
RMFolder
object that have been logically deleted.
- getDocumentContent(String) - Method in interface com.filenet.rm.api.RMConnector
-
Constructs a TransportInputStream that represents the content of
this Document.
- getDocumentContentElements(String) - Method in interface com.filenet.rm.api.RMConnector
-
Returns an array that contains the object types for the content elements associated with this Document object.
- getDocumentID(String, String) - Method in interface com.filenet.rm.api.RMConnector
-
Retrieves the DocumentID of the specific version of the given document.
- getDocumentProperties(String, String[]) - Method in interface com.filenet.rm.api.RecordInfo
-
Returns the properties of a specified document that is associated with
this RecordInfo
object
- getDocumentProperties(String, String[]) - Method in interface com.filenet.rm.api.RMConnector
-
Returns property values for the specified document.
- getDocumentStore(Object) - Method in class com.filenet.rm.api.util.RMUtil
-
- getDomain() - Method in interface com.filenet.rm.api.DocumentStore
-
Returns the name of the domain name for this DocumentStore
object.
- getDowngradeProperties() - Static method in class com.filenet.rm.api.DODCH4Property
-
- getFieldFromResultSet(String, String) - Method in class com.filenet.rm.api.util.RMUtil
-
- getFilePlanID(RMFolder) - Method in class com.filenet.rm.api.util.RMUtil
-
- getFilePlanObjectStores(ObjectStores) - Method in class com.filenet.rm.api.util.RMUtil
-
- getFolderType() - Method in interface com.filenet.rm.api.RMFolder
-
Returns the RMEntityType property value that indicates what type of entity
this RMFolder
object.
- getFormattedString(String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Formats the passed String by replacing characters like &,',<,> with filter operators.
- getFromClasses() - Method in class com.filenet.rm.api.util.QueryParser
-
- getGuideSections() - Method in interface com.filenet.rm.api.GuideContainer
-
Returns the
GuideSection
objects at the current level of the hierarchy.
- getGuideSections(String[]) - Method in interface com.filenet.rm.api.GuideContainer
-
Returns the
GuideSection
objects at the current level of the hierarchy along with
the values of the specified properties.
- getGuideSectionsXML(String[]) - Method in interface com.filenet.rm.api.GuideContainer
-
Returns an XML string containing the
GuideSection
objects at the current level
of the hierarchy along with the values of the specified properties.
- getGuideTopics() - Method in interface com.filenet.rm.api.GuideContainer
-
Returns the
GuideTopic
objects at the current level of the hierarchy.
- getGuideTopics(String[]) - Method in interface com.filenet.rm.api.GuideContainer
-
Returns the
GuideTopic
objects at the current level of the hierarchy along with
the values of the specified properties.
- getGuideTopicsXML(String[]) - Method in interface com.filenet.rm.api.GuideContainer
-
Returns an XML string containing the
GuideTopic
objects at the current level
of the hierarchy along with the values of the specified properties.
- getHoldState() - Method in interface com.filenet.rm.api.Hold
-
Returns an int
value indicating the hold state for this Hold
object.
- getIdsFromEntityClass(RMObjectStore, String, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a String array whose elements specify the IDs of objects that match the given criteria.
- getInActiveParents(boolean) - Method in interface com.filenet.rm.api.ActivableObject
-
Returns a collection of containing either the first inactive parent of this container object
or all inactive parents.
- getISODate(Date) - Static method in class com.filenet.rm.api.util.XmlHelper
-
- getLabel() - Method in class com.filenet.rm.api.util.RMBulkOperationResult
-
Returns the member variable msObjectId.
- getLastCreatedVolume() - Method in interface com.filenet.rm.api.RecordFolder
-
Returns the
Volume
object that was most recently created within this
RecordFolder
object.
- getLevel() - Method in interface com.filenet.rm.api.RMFolder
-
Returns the level at which this RMFolder
object exists within its
file plan.
- getLibraryName() - Method in interface com.filenet.rm.api.DocumentStore
-
Returns the name of the document library as represented by this DocumentStore
object.
- getLimitedResultSet(RMObjectStore, String, int) - Method in class com.filenet.rm.api.util.RMUtil
-
- getLocale(Session) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a Locale object from the Session
- getLocalizedMessage() - Method in exception com.filenet.rm.api.exception.RMException
-
Uses the locale specified in the Content Engine user context to return
a String
containing the localized message for this exception.
- getLocalizedMessage(Locale) - Method in exception com.filenet.rm.api.exception.RMException
-
Uses the specified locale to return a String
containing the
localized message for this exception.
- getLogger(String) - Static method in class com.filenet.rm.api.util.RMLogger
-
- getLogger(Class) - Static method in class com.filenet.rm.api.util.RMLogger
-
- getMerged(ArrayList, BaseObjects) - Method in class com.filenet.rm.api.util.RMUtil
-
- getMergedROSOR(ArrayList, ArrayList) - Method in class com.filenet.rm.api.util.RMUtil
-
- getMergedXML(String, String, String) - Method in class com.filenet.rm.api.util.RMUtil
-
- getMessage() - Method in exception com.filenet.rm.api.exception.RMException
-
Uses the default locale to return a String
containing the
localized message for this exception.
- getMessage() - Method in class com.filenet.rm.api.util.RMBulkOperationResult
-
Returns a String value that represents the result of a bulk operation.
- getMessage() - Method in class com.filenet.rm.api.ValidationError
-
Returns the message associated with this ValidationError
object.
- getModifiedConditionXML(RMObjectStore, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
This method returns the XML after modidfying the Sql tag.
- getMostSecurityClassificationProperties() - Static method in class com.filenet.rm.api.DODCH4Property
-
- getName(String, int) - Method in interface com.filenet.rm.api.RMAutoName
-
Generates a name for a Records Manager entity of the specified type.
- getNewDocument() - Method in class com.filenet.rm.api.util.RMUtil
-
- getObject(String) - Method in interface com.filenet.rm.api.RMObjectStore
-
- getObjectStore() - Method in interface com.filenet.rm.api.DocumentStore
-
Returns this DocumentStore
object.
- getObjectStore() - Method in interface com.filenet.rm.api.RMObject
-
Returns a reference to the object store to which this object is persisted.
- getObjectStoreXML(ObjectStores) - Method in class com.filenet.rm.api.util.RMUtil
-
- getObjectStoreXML(ObjectStores, String[]) - Method in class com.filenet.rm.api.util.RMUtil
-
- getParentRecordCategories() - Method in interface com.filenet.rm.api.RecordInfo
-
Returns a collection containing the record categories in which this
RecordInfo
object is filed.
- getParentRecordFolder() - Method in interface com.filenet.rm.api.Volume
-
Returns a reference to the parent RecordFolder
object for
this object.
- getParentRecordFolders() - Method in interface com.filenet.rm.api.RecordInfo
-
Returns a collection containing the
RecordFolder
objects in which this
RecordInfo
object is filed.
- getParentsOnHold(boolean) - Method in interface com.filenet.rm.api.HoldableObject
-
Returns the parents of this HoldableObject
object that are
on hold.
- getPattern() - Method in interface com.filenet.rm.api.RMFolder
-
Returns the pattern associates with this RMFolder
object.
- getPatternBaseName(int) - Method in interface com.filenet.rm.api.RMRecordCategoryContainer
-
Generates a name for an entity of the specified
RMType
based on the
naming pattern applied to that entity type.
- getPatternBaseName(int, StringBuffer) - Method in interface com.filenet.rm.api.RMRecordCategoryContainer
-
Generates a name for an entity of the specified
RMType
based on the
naming pattern applied to that entity type.
- getPatternBaseName(int, Properties) - Method in interface com.filenet.rm.api.RMRecordCategoryContainer
-
Generates a name for an entity of the specified
RMType
based on the
naming pattern applied to that entity type.
- getPatternBaseName(int, Properties, StringBuffer) - Method in interface com.filenet.rm.api.RMRecordCategoryContainer
-
Generates a name for an entity of the specified
RMType
based on the
naming pattern applied to that entity type.
- getPatternBaseName(int) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
- getPatternBaseName(int, StringBuffer) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
- getPatternBaseName(int, Properties) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
- getPatternBaseName(int, Properties, StringBuffer) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
- getPatternBaseName(int) - Method in interface com.filenet.rm.api.RMRecordFolderContainer
-
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
- getPatternBaseName(int, StringBuffer) - Method in interface com.filenet.rm.api.RMRecordFolderContainer
-
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
- getPatternBaseName(int, Properties) - Method in interface com.filenet.rm.api.RMRecordFolderContainer
-
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
- getPatternBaseName(int, Properties, StringBuffer) - Method in interface com.filenet.rm.api.RMRecordFolderContainer
-
Generates a string for a Records Manager entity of the specified type
based on the naming pattern defined for this container object.
- getPatternValue() - Method in interface com.filenet.rm.api.ClassificationScheme
-
Returns the Pattern
object that is associated with this
ClassificationScheme
object.
- getPhases() - Method in interface com.filenet.rm.api.DispositionSchedule
-
Returns all Phase
objects that are associated with this DispositionSchedule
object.
- getPreviewListingOfEntites(RMObjectStore, String[], String, String, int) - Static method in class com.filenet.rm.api.util.RMUtil
-
This method returns the XML containig information about the entites depending upon the properties tag contained in the asConditionXML.
- getPropertyDescriptions(ClassDescription, String) - Method in class com.filenet.rm.api.util.RMUtil
-
- getPropertyDescriptionXML(ClassDescription, String) - Method in class com.filenet.rm.api.util.RMUtil
-
- getPropertyDescriptionXML(ClassDescription, String, RMRecordContainer) - Method in class com.filenet.rm.api.util.RMUtil
-
- getPropertyNames(int) - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns an array containing the symbolic names of all properties
for objects of the specified entity type.
- getQueriedObjects(RMObjectStore, String, int) - Method in class com.filenet.rm.api.util.RMUtil
-
- getQueriedObjects(RMObjectStore, String, int, int) - Method in class com.filenet.rm.api.util.RMUtil
-
- getReader(String, String, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
- getReader(String, String) - Method in class com.filenet.rm.api.util.RMUtil
-
- getReceiptParent() - Method in interface com.filenet.rm.api.RecordInfo
-
Returns the parent record to which this RecordInfo
object is
attached as a receipt.
- getReceipts() - Method in interface com.filenet.rm.api.RecordInfo
-
Returns a collection of RecordInfo
objects that are attached to this
object as receipts.
- getRecord(String) - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns the RecordInfo
object in this object store that has the
the specified document URI.
- getRecordCategoryInterface(Folder) - Method in interface com.filenet.rm.api.RMObjectStore
-
Constructs a RecordCategory
object based on
the specified Folder
object and places the new object in this object store.
- getRecordFolderInterface(Folder) - Method in interface com.filenet.rm.api.RMObjectStore
-
Constructs a RecordFolder
object object based on
the specified Folder
object and places the new object in this object store.
- getRecordInfoInterface(Document) - Method in interface com.filenet.rm.api.RMObjectStore
-
Constructs a RecordInfo
object based on
the specified Document
object and places the new object in this object store.
- getRecordObjectStores(ObjectStores) - Method in class com.filenet.rm.api.util.RMUtil
-
- getRecordTypeInterface(CustomObject) - Method in interface com.filenet.rm.api.RMObjectStore
-
Constructs a RecordType
object based on
the specified Folder
object and places the new object in this object store.
- getRecordTypes() - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns a collection containing the RecordType
objects in this
object store.
- getRecordURI(RMObjectStore, String) - Method in class com.filenet.rm.api.util.RMUtil
-
- getRegistrationClass(RMObjectStore, String) - Method in class com.filenet.rm.api.util.RMUtil
-
- getRegistrationID(RMObjectStore, String, String, String, boolean) - Method in class com.filenet.rm.api.util.RMUtil
-
- getRendition(String) - Method in interface com.filenet.rm.api.RMConnector
-
Retrieves a collection of documents (along with all the properties) that are published from this Document object version.
- getRepositoryName() - Method in interface com.filenet.rm.api.DocumentStore
-
Generates a repository name for this DocumentStore
object by combining the domain
and library names this object.
- getRepositoryType() - Method in interface com.filenet.rm.api.DocumentStore
-
Returns a value indicating the repository type of this DocumentStore
object.
- getRepositoryType() - Method in interface com.filenet.rm.api.RecordInfo
-
Returns a String
that indicates the type of repository in which the document
corresponding to this RecordInfo
object is stored.
- getRepositoryType(String) - Method in interface com.filenet.rm.api.RMConnector
-
Returns the Repository type where this instance of Connector points.
- getResultSet(ObjectStore, String) - Method in class com.filenet.rm.api.util.RMUtil
-
- getResultSet(RMObjectStore, String) - Method in class com.filenet.rm.api.util.RMUtil
-
- getResultSet(RMObjectStore, String, int) - Method in class com.filenet.rm.api.util.RMUtil
-
- getResultSet(RMObjectStore, String, int, int) - Method in class com.filenet.rm.api.util.RMUtil
-
- getResultSet(ObjectStore, String, int) - Method in class com.filenet.rm.api.util.RMUtil
-
- getResultSet(ObjectStore, String, int, int) - Method in class com.filenet.rm.api.util.RMUtil
-
- getRetentionPropertiesXML() - Method in interface com.filenet.rm.api.RecordInfo
-
Returns the retention properties for this RecordInfo
object, such as the
cutoff date and current phase action.
- getRMCustomObjectInterface(CustomObject) - Method in interface com.filenet.rm.api.RMObjectStore
-
Constructs an RMCustomObject
object based on
the specified CustomObject
object and places the new object in this object store.
- getRMCustomObjects(int, String) - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns a collection of all
RMCustomObject
objects of the specified type that are
contained within this object store.
- getRMCustomObjects(int) - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns a collection of all
RMCustomObject
objects of the specified type that are
contained within this object store for which the user has permission to update
the schedule.
- getRMDeclassificationOffset(ObjectStore) - Static method in class com.filenet.rm.api.BusinessRules
-
Returns the declassification offset for this object.
- getRMDeclassificationOffset() - Method in interface com.filenet.rm.api.RMObject
-
Returns the declassification offset for this object.
- getRMEntityType() - Method in interface com.filenet.rm.api.RMObject
-
Returns the value of the RMEntityType property for this object.
- getRMEntityType() - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns the type of this object store.
- getRMEntityType(String) - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns the type of the specified Records Manager entity.
- getRMException(int, int, Exception, Object[]) - Static method in exception com.filenet.rm.api.exception.RMException
-
Returns for an exception of type ERROR, SWEEPERROR, HOLDSWEEPERROR, SWEEPFATAL,
HOLDSWEEPFATAL, or FATAL an RMException
object that
contains a localized message derived from the specified Exception
object.
- getRMFolderType(String) - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns the entity type of the container object with the specified GUID.
- getRMFolderType(Folder) - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns the entity type of the specified container object.
- getRMImplementationType() - Method in interface com.filenet.rm.api.RMObject
-
Returns an
int
value representing the
RMType
constant that indicates
the implementation type of this object.
- getRMObjects() - Method in interface com.filenet.rm.api.RMObjectStore
-
- getRMObjects(RMObjectStore, String, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a collection of RMObjects that match the given criteria.
- getRMObjectStore(ObjectStore) - Method in class com.filenet.rm.api.util.RMUtil
-
- getRMPagedSearch() - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns an
RMPagedSearch
object that can be used to search this object store
and to return paged results.
- getRMSearch() - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns an
RMSearch
object that can be used to search this object store.
- getRMStoredSearches(int[], String[]) - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns a collection of the
RMStoredSearch
objects, along with their
properties, that are contained in this object store.
- getRMStoredSearchesXML(int[], String[]) - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns a
String
in XML format representing a collection of the
RMStoredSearch
objects, along with their properties, that are contained
in this object store.
- getRootLogger() - Static method in class com.filenet.rm.api.util.RMLogger
-
- getROSObjectStore(RecordInfo, Session) - Method in class com.filenet.rm.api.util.RMUtil
-
- GetROSURL(NodeList) - Static method in class com.filenet.rm.api.util.RMUtil
-
- getSearchSQL(String) - Method in interface com.filenet.rm.api.RMConnector
-
Returns an XML document that represents the content query to be executed on the ROS.
- getSecurityClassificationInfoPageProperties() - Static method in class com.filenet.rm.api.DODCH4Property
-
- getSecurityClassificationProperties() - Static method in class com.filenet.rm.api.DODCH4Property
-
Returns the properties to be used by the wizard.
- getSecurityParentHierarchicalPropertiesXML(String[], int) - Method in interface com.filenet.rm.api.RecordInfo
-
Returns the properties for either a security parent or the container of a security
parent of this RecordInfo
object.
- getSelectList() - Method in class com.filenet.rm.api.util.QueryParser
-
- getServerName() - Method in interface com.filenet.rm.api.DocumentStore
-
Returns the URL that is used to connect to the Content Engine server and return.
- getSystemConfigurationValue(String) - Method in interface com.filenet.rm.api.RMObjectStore
-
Returns the value of the specified SystemConfiguration property for the
ClassificationSchemes
object in this object store.
- getTopValue() - Method in class com.filenet.rm.api.util.QueryParser
-
- getUpgradeProperties() - Static method in class com.filenet.rm.api.DODCH4Property
-
- getURI(RMObjectStore, String[]) - Method in interface com.filenet.rm.api.DocumentStore
-
Generates a URI that is passed to RM Declaration API when documents are declared as records.
- getUserId(RMObjectStore) - Method in class com.filenet.rm.api.util.RMUtil
-
- getUserIdWithDomain(RMObjectStore) - Method in class com.filenet.rm.api.util.RMUtil
-
- getUsernameFromFullName(String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Get the short username from possible full username.
- getVolumeInterface(Folder) - Method in interface com.filenet.rm.api.RMObjectStore
-
Constructs a Volume
object based on
the specified Folder
object and places the new object in this object store.
- getXML() - Method in class com.filenet.rm.api.util.RMXSLUtil
-
Returns the source XML file in the format that was orignially set in the setXML() method.
- getXML(QueryParser.SelectItem[], String[]) - Method in class com.filenet.rm.api.util.SearchExecuteXMLSchema
-
- getXMLResponse() - Method in class com.filenet.rm.api.util.XmlHelper
-
- getXMLResponse(String) - Method in class com.filenet.rm.api.util.XmlHelper
-
- getXSLParameter(String) - Method in class com.filenet.rm.api.util.RMXSLUtil
-
Returns previously set XSL Parameter.
- GUIDE_ID - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with several objects.
- GUIDE_NAME - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with several objects.
- GUIDE_TOPIC - Static variable in class com.filenet.rm.api.DODCH4Property
-
- GUIDE_TOPIC_CODE - Static variable in class com.filenet.rm.api.DODCH4Property
-
- GuideContainer - Interface in com.filenet.rm.api
-
- GuideSection - Interface in com.filenet.rm.api
-
Represents a section in a classification guide.
- GuideSections - Interface in com.filenet.rm.api
-
- GuideTopic - Interface in com.filenet.rm.api
-
Represents a topic in a classification guide.
- GuideTopics - Interface in com.filenet.rm.api
-
- IBM_PREFIX - Static variable in exception com.filenet.rm.api.exception.RMException
-
The IBM Message Standard three-character prefix assigned to
IBM Enterprise Records products.
- ID - Static variable in class com.filenet.rm.api.util.XmlHelper
-
- IMAGE_BIT_DEPTH - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Digital Photograph and Scanned Record Objects.
- IMAGE_RESOLUTION - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Scanned Record Object.
- IMAGE_SIZE - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Digital Photograph Record Object.
- IMAGE_SOURCE - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Digital Photograph Record Object.
- IMPLEMENTING_CLASS_NAME - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ImplementingClassName for a ConnectorRegistration object,
specifies the name of the class implementing the RMConnector interface.
- inActivate(boolean, String) - Method in interface com.filenet.rm.api.ActivableObject
-
Inactivates or activates this container object.
- inActivate(RMObjectStore, String[], String) - Method in class com.filenet.rm.api.util.RMBulkOperationsUtil
-
Inactivates all the RM entities whose Ids are specified in
the asArrObjectIDs input parameter.
- INACTIVE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of Inactive for a RMObject object and specifies whether the
given RMObject is inactive.
- INCREMENTED_BY - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of IncrementedBy for a PatternLevel object and specifies the value by
which an increment will be made while generating the entity name in
accordance with the Pattern applied.
- info(String) - Method in class com.filenet.rm.api.util.RMLogger
-
- info(String, Throwable) - Method in class com.filenet.rm.api.util.RMLogger
-
- info(String, String, Throwable) - Method in class com.filenet.rm.api.util.RMLogger
-
- INFORMATION - Static variable in exception com.filenet.rm.api.exception.RMException
-
- INHERIT_IMMEDIATE_CHILDREN - Static variable in interface com.filenet.rm.api.RMObject
-
Specifies that a disposition schedule is to be applied to all immediate children of this object.
- INHERITED_CHILDREN - Static variable in interface com.filenet.rm.api.RMObject
-
Specifies that a disposition schedule is to be applied to the child objects that inherit from this object.
- INITIAL_CLASSIFICATION - Static variable in class com.filenet.rm.api.DODCH4Property
-
- INITIAL_CLASSIFICATION - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- initiateDisposition(VWSession, boolean) - Method in interface com.filenet.rm.api.DisposableObject
-
Verifies the state of this object and its available
children to launch the associated phase workflow with corresponding
entities
- initiateDisposition(VWSession) - Method in interface com.filenet.rm.api.DisposableObject
-
Verifies the state of this object and its available
children to launch the associated phase workflow with corresponding
entities
- initiateDisposition(RMObjectStore, String[], VWSession) - Method in class com.filenet.rm.api.util.RMBulkOperationsUtil
-
Performs initiateDisposition operation on all RM entities whose Ids are
specified in the asArrObjectIDs input parameter.
- INSTANCESUB - Static variable in class com.filenet.rm.api.util.XmlHelper
-
- INTEGERTEST - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of IntegerTest.
- INTELLIGENTNAME - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of IntelligentName.
- INVALID_CLASSIFICATION_AGENCY - Static variable in class com.filenet.rm.api.ValidationError
-
The security classification action lacks a classification agency.
- INVALID_CLASSIFICATION_AUTHORITY - Static variable in class com.filenet.rm.api.ValidationError
-
The security classification action lacks a classification authority.
- INVALID_CURRENT_CLASSIFICATION - Static variable in class com.filenet.rm.api.ValidationError
-
The security classification action lacks an current classification.
- INVALID_DECLASSIFY_DATA - Static variable in class com.filenet.rm.api.ValidationError
-
There is no valid declassify on date.
- INVALID_DECLASSIFY_DATA_RESTRICTED - Static variable in class com.filenet.rm.api.ValidationError
-
There is a "declassify on", but the record is restricted.
- INVALID_DOWNGRADE_DATA_RESTRICTED - Static variable in class com.filenet.rm.api.ValidationError
-
There is a "downgrade on", but the record is restricted.
- INVALID_EXEMPTION_DATA_RESTRICTED - Static variable in class com.filenet.rm.api.ValidationError
-
There is an "exemption", but the record is restricted.
- INVALID_INITIAL_CLASSIFICATION - Static variable in class com.filenet.rm.api.ValidationError
-
The security classification action lacks an initial classification.
- IS_DELETED - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of IsDeleted for a RM object and specifies whether the given RMObject
has been logically deleted.
- IS_DYNAMIC_HOLD - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the RecordHoldLink and RMFolderHoldLink.This property represents whether a Hold has been applied manually or dynamically.
- IS_EQUAL - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value that represents the relational IS EQUAL operator.
- IS_EXTRACT - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of isExtract for an RM Record and specifies whether the version is extract.
- IS_FINAL_PHASE_COMPLETED - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of IsFinalPhaseCompleted for a RM object and specifies whether the
final phase has been completed.
- IS_FISCALYEAR - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of IsFiscalYear.
- IS_FREEZED - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of IsFreezed.
- IS_GREATER - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value that represents the relational GREATER THAN operator.
- IS_GREATER_OR_EQUAL - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value that represents the relational GREATER THAN OR EQUAL TO operator.
- IS_LESS - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value that represents the relational LESS THAN operator.
- IS_LESS_OR_EQUAL - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value that represents the relational LESS THAN OR EQUAL TO operator.
- IS_NOT_EQUAL - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value that represents the relational IS NOT EQUAL operator.
- IS_NOT_NULL - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value that represents the NOT NULL operator.
- IS_NULL - Static variable in interface com.filenet.rm.api.RMCustomObject
-
An int
value that represents the IS NULL operator.
- IS_PERMANENTRECORD - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of IsPermanentRecord for a RM object such as a RecordCategory or a
RecordFolder and specifies whether this RMObject represents a permanent record.
- IS_REOPEN - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of IsReOpen for a RM object and specifies whether the container entity has been reopened.
- IS_SCREENINGREQUIRED - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of IsScreeningRequired for a RM object and specifies whether screening is required when the entity is launched as a workflow item.
- IS_SYSTEM_ROLE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of IsSystemRole.
- IS_VITAL_RECORD - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of IsVitalRecord for a RM object and specifies whether the entity has been declared has vital.
- isAlreadyRegistered(RMObjectStore, String) - Method in class com.filenet.rm.api.RMDriverManager
-
Indicates whether a connector implementation is registered in the specified object store.
- isAnyChildonHold() - Method in interface com.filenet.rm.api.HoldableObject
-
Indicates whether any child of this HoldableObject
object
on hold.
- isAnyParentClosed() - Method in interface com.filenet.rm.api.ClosableObject
-
Indicates whether any parent of this object is closed.
- isAnyParentClosed(RMFolder) - Method in class com.filenet.rm.api.util.RMUtil
-
- isAnyParentInActive() - Method in interface com.filenet.rm.api.ActivableObject
-
Returns a boolean
value indicating whether any parent of this container object
is inactive.
- isAnyParentOnHold() - Method in interface com.filenet.rm.api.HoldableObject
-
Indicates whether any parent of this HoldableObject
object
on hold.
- isAppliedDynamically() - Method in interface com.filenet.rm.api.Hold
-
Indicates whether the disposition hold represented by this Hold
object
has been placed dynamically.
- isClosed(boolean) - Method in interface com.filenet.rm.api.ClosableObject
-
Indicates whether this object or, optionally, any parent of this object
is closed.
- isDebugEnabled() - Method in class com.filenet.rm.api.util.RMLogger
-
- ISDISCRIPTORFUNCTIONING - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of IsDiscriptorFunctioning.
- isEDMHoldSupportedOnMarkers(RMObjectStore) - Method in class com.filenet.rm.api.util.RMBulkOperationsUtil
-
- isEnabledFor(Priority) - Method in class com.filenet.rm.api.util.RMLogger
-
- isErrorEnabled() - Method in class com.filenet.rm.api.util.RMLogger
-
- isFatalEnabled() - Method in class com.filenet.rm.api.util.RMLogger
-
- isFilePlanObjectStore(ObjectStore) - Method in class com.filenet.rm.api.util.RMUtil
-
- isFromWorkflow() - Static method in class com.filenet.rm.api.util.ThreadLocalForWorkflow
-
Gets the flag that mark the call is from workflow in this thread
- ISHIDDENCONTAINER - Static variable in class com.filenet.rm.api.util.XmlHelper
-
- isInActive(boolean) - Method in interface com.filenet.rm.api.ActivableObject
-
Returns a boolean
value indicating whether this container object or, optionally,
any parent of this object is inactive.
- isInfoEnabled() - Method in class com.filenet.rm.api.util.RMLogger
-
- isMinimumMetadataRetained() - Method in interface com.filenet.rm.api.RecordInfo
-
Retrieves the RetainMetadata property for the
ClassificationScheme
object to which this
RecordInfo
object belongs.
- isMinimumMetadataRetained() - Method in interface com.filenet.rm.api.RMFolder
-
Returns the RetainMetadata property value for the
ClassificationScheme
object to which
this
RMFolder
object belongs.
- isOnHold(boolean) - Method in interface com.filenet.rm.api.HoldableObject
-
Indicates whether this HoldableObject
object is on hold.
- isPhysicalRecordContaineeOnHold(RMObjectStore, RMRecordContainer) - Method in class com.filenet.rm.api.util.RMBulkOperationsUtil
-
- isPhysicalRecordOnHold(RMObjectStore, String, String, int) - Method in class com.filenet.rm.api.util.RMBulkOperationsUtil
-
- isRecordMultiFilingEnabled() - Method in interface com.filenet.rm.api.RMObjectStore
-
Indicates whether or not multi-filing of records is allowed on this
RMObjectStore
.
- isRecordObjectStore(ObjectStore) - Method in class com.filenet.rm.api.util.RMUtil
-
- isReOpened() - Method in interface com.filenet.rm.api.ClosableObject
-
Indicates whether this object is currently open.
- isSuccess() - Method in class com.filenet.rm.api.util.RMBulkOperationResult
-
Specifies whether the bulk operations that have been performed on an
RMObject are successful or not.
- ISSUEDBY - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with several objects.
- isVital() - Method in interface com.filenet.rm.api.VitalableObject
-
Indicates whether this object is a VitableObject
object.
- isWarningEnabled() - Method in class com.filenet.rm.api.util.RMLogger
-
- REALM - Static variable in class com.filenet.rm.api.util.XmlHelper
-
- REASON - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of Reason.
- REASON_FOR_ACTION - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ReasonForAction for an RM Audit object and specifies the reason
for this audit action.
- REASON_FOR_CHANGE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ReasonForChange for an RM object specifies reason for which the object is changed.
- REASON_FOR_CLOSE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ReasonForClose for an RM object specifies reason for which the object is closed.
- REASON_FOR_FREEZE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ReasonForFreeze for an RM object specifies reason for which the object is freezed.
- REASON_FOR_INACTIVATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ReasonForInactivate for an RM object specifies reason for which the object is inactivated.
- REASON_FOR_LAUNCH - Static variable in interface com.filenet.rm.api.RMProperty
-
The following properties are used for the launching the transfer workflows from the UI
- Reason_FOR_OUTCOME_OF_LAST_REVIEW - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ReasonforOutcomeofLastReview for an RM object such as a RecordCategory
or a RecordFolder.
- REASON_FOR_RECLASSIFICATION - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ReasonForReclassification for an RM object specifies reason for which the object is re-classified into another hierarchy.
- REASONS_FOR_CLASSIFICATION - Static variable in class com.filenet.rm.api.DODCH4Property
-
- REASONS_FOR_SECURITY_CLASSIFICATION - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- REASONS_FOR_UPGRADE - Static variable in class com.filenet.rm.api.DODCH4Property
-
- RECALCULATE_PHASE_RETENTION - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents a symbolic name for RMSysem property name used by sweep to check for the alternate retention condition
on any entity.
- recalculateCutOff(DisposableObject) - Method in interface com.filenet.rm.api.DispositionSchedule
-
Recalculates and updates the pre-cutoff data based on the schedule associated with a specified
DisposableObject
object or its parent.
- recalculateCuttOff() - Method in interface com.filenet.rm.api.DisposableObject
-
Recalculates the pre-cutoff data based on the schedule associated with this object
or its parent to update the entity with pre-cutoff data.
- RECEIPT_STATUS - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- RECEIPTOF - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- RECEIPTS - Static variable in class com.filenet.rm.api.DODCH4Property
-
- RECEIPTS - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- RECORD_CATEGORY_DESCRIPTION - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RecordCategoryDescription for an RM category specifies description for the Record Category.
- RECORD_CATEGORY_IDENTIFIER - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RecordCategoryIdentifier for an RM category specifies unique identifier for the Record Category.
- RECORD_CATEGORY_NAME - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RecordCategoryName for an RM category specifies name for the Record Category.
- RECORD_FOLDER_IDENTIFIER - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RecordFolderIdentifier for an RM Folder specifies name for the Record Folder.
- RECORD_FOLDER_NAME - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RecordFolderName for an RM Folder specifies name for the Record Folder.
- RECORD_LINK - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RecordInformation for a Document object and specifies the RecordInfo
with which the Document is associated.
- RECORD_PATTERN - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RecordPattern for a RecordCategory and a RecordFolder and specifies
the value of pattern definition String.
- RECORD_TYPE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RecordType for an RM Record and specifies record type associated with the record.
- RECORD_VERSION - Static variable in interface com.filenet.rm.api.RMProperty
-
- RecordCategories - Interface in com.filenet.rm.api
-
- RecordCategory - Interface in com.filenet.rm.api
-
Represents a container that categorizes a set of related records within a file plan.
- RecordFolder - Interface in com.filenet.rm.api
-
Represents a container that is used to manage related records according to
specified retention and disposition schedules and events.
- RecordFolders - Interface in com.filenet.rm.api
-
- RECORDHOLDER - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RecordHolder.
- RecordInfo - Interface in com.filenet.rm.api
-
Represents a a logical entity that serves as an official record for any
type of document pertaining to business operations, or of having material value.
- RECORDINFOPTR - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RecordInfoPtr for a Disposal phase object.
- RecordInfos - Interface in com.filenet.rm.api
-
- RecordType - Interface in com.filenet.rm.api
-
Represents a non-hierarchical grouping of records.
- RECORDTYPE_DISPOSAL_PHASES - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RecordTypeDisposalPhases for a Property object and specifies a bitmask combining bit values for the security access rights being granted or denied
- RECORDTYPE_NAME - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RecordTypeName for a RecordType object and specifies the name
of RecordType.
- RecordTypes - Interface in com.filenet.rm.api
-
- registerAutoName(RMAutoName) - Method in class com.filenet.rm.api.RMDriverManager
-
Registers the specified auto-naming implementation for use by a custom application.
- registerConnector(RMObjectStore, String, String, String, String) - Method in class com.filenet.rm.api.RMDriverManager
-
Registers the connector implementation that is to be invoked for the specified combination of
repository type, server name and repository name.
- registerExternalEvent(String[], Date) - Method in interface com.filenet.rm.api.DispositionAllocatableObject
-
Deprecated.
Use RMBulkOperationsUtil.registerExternalEvent(RMObjectStore, String[], Date)
- registerExternalEvent(String[], Date) - Method in interface com.filenet.rm.api.RMObject
-
- registerExternalEvent(RMObjectStore, String[], Date) - Method in class com.filenet.rm.api.util.RMBulkOperationsUtil
-
Updates the ExternalEventOccurrenceDate metadata of the Events represented
by the GUIDs specified in input parameter for a particular RMObjectStore.
- RELATIONSHIP - Static variable in class com.filenet.rm.api.util.XmlHelper
-
- REMARKS - Static variable in class com.filenet.rm.api.DODCH4Property
-
- REMARKS - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with several objects.
- removeNode(String, String) - Method in class com.filenet.rm.api.util.RMUtil
-
- reOpen(boolean, String) - Method in interface com.filenet.rm.api.ClosableObject
-
Opens this object.
- reOpen(RMObjectStore, String[], boolean, String) - Method in class com.filenet.rm.api.util.RMBulkOperationsUtil
-
Performs the reOpen operation on all RM objects whose IDs are specified in
the asArrObjectIDs input parameter.
- REOPENED_BY - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ReopenedBy for an RM object such as a RecordCategory or a RecordFolder,
specifies the user who reopened the RM container object.
- REOPENED_DATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ReOpenedDate for an RM object such as a RecordCategory or a RecordFolder,
specifies the date when RM container object was reopened.
- replaceAll(String, String, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns String after replacing characters with the provided characters.
- replaceALLInstance(String, String, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
This method replace all the occurance of asFindStr with asReplaceBy in as MainStr
- REPORTNAME - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ReportName for an RM Report object and specifies the name of Report.
- REPOSITORY_NAME - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RepositoryName for an RM Connector Registration object and specifies
the repository name where Document is stored.
- REPOSITORY_TYPE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RepositoryType for an RM Connector Registration object and specifies
the repository type where Document is stored.
- REQUEST_DECLASSIFICATION_DATE_UPDATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with System Configuration.
- RETAIN_METADATA - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RetainMetadata for a ClassificationScheme object and specifies
whether RM object will be hard deleted or logically deleted or user input
will be considered.
- RETENTION_BASE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the property RetentionBase on the class AlternateRetention.
- RETENTION_PERIOD_DAYS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RetentionPeriodDays for a Phase object.
- RETENTION_PERIOD_MONTHS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RetentionPeriodMonths for a Phase object.
- RETENTION_PERIOD_TRIGGER_PROPERTY_NAME - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the string value of the DD container property RMRetentionTriggerPropertyName.
- RETENTION_PERIOD_YEARS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RetentionPeriodYears for a Phase object.
- RETURN_DATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ReturnDate.
- review(Properties) - Method in interface com.filenet.rm.api.DisposableObject
-
Reviews this object and updates the specified properties.
- REVIEW_COMMENTS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ReviewComments for a Disposal Phase object.
- REVIEW_DATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ReviewDate for a Disposal phase and RecordInfo object.
- REVIEW_DECISION - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ReviewDecision for a Disposal phase object.
- REVIEW_REMARKS - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- REVIEWEDBY - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- REVIEWEDON - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Record Info Object.
- REVIEWER - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of Reviewer for an RM object such as a RecordCategory or a RecordFolder.
- REVIEWER_DETAILS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ReviewerDetails for a Disposal phase object.
- RM_CATEGORY_TYPE_DECLARE - Static variable in class com.filenet.rm.api.RMPropertiesCategoryType
-
Represents the value Declare
that is applied to properties that are
classified as declaration-related metadata.
- RM_CATEGORY_TYPE_DISPOSAL - Static variable in class com.filenet.rm.api.RMPropertiesCategoryType
-
Represents the value Disposal
that is applied to properties that are
classified as disposition-related metadata.
- RM_CATEGORY_TYPE_VITAL - Static variable in class com.filenet.rm.api.RMPropertiesCategoryType
-
Represents the value Vital
that is applied to properties that are
classified as vital-related metadata.
- RM_CONNECTOR_PROPERTY_REGISTRATIONID - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the connector registration id.
- RM_CONNECTOR_REGISTRATION_PATH - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the path for the connector registration
- RM_CONNECTOR_ROOT_URL - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RM_CONNECTOR_ROOT_URL for a Connector URL and specifies Connector root element name.
- RM_CONNECTOR_SEARCH_ROOT_URL - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents a constant for search URL.
- RM_CONNECTOR_URL_DOCUMENTID - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RM_CONNECTOR_URL_DOCUMENTID for a Connector URL and specifies document Id assciated to URL.
- RM_CONNECTOR_URL_PASSWORD - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RM_CONNECTOR_URL_PASSWORD for a Connector URL and specifies password used.
- RM_CONNECTOR_URL_REGISTRATIONID - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RM_CONNECTOR_URL_REGISTRATIONID for a Connector URL and specifies registration Id used.
- RM_CONNECTOR_URL_USERID - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RM_CONNECTOR_URL_USERID for a Connector URL and specifies user Id used.
- RM_CONNECTOR_URL_VERSION - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RM_CONNECTOR_URL_VERSION for a Connector URL and specifies connector versions.
- RM_CONNECTOR_URL_VERSION_DELIMITER - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RM_CONNECTOR_URL_VERSION_DELIMITER for a Connector URL and specifies the delimiter to be used.
- RM_RECORD_URL - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the constant for record URL.
- RM_RECORD_URL_RECORDID - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the constant for record id for the record URL.
- RM_REPOSITORY_TYPE_CE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the constant for CE Respository type.
- RM_REPOSITORY_TYPE_CS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the constant for CS Respository type.
- RM_REPOSITORY_TYPE_IS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the constant for IS Respository type.
- RM_SYSTEM_CONFIGURATION_FREEZE_DECLARE_DOCUMENT - Static variable in interface com.filenet.rm.api.RMProperty
-
- RM_TYPE_ACTION - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is an action.
- RM_TYPE_ALTERNATERETENTION - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is an alternate retention within a phase.
- RM_TYPE_AUDITCONFIG - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity represents an audit metadata configuration
for a DoD classified document.
- RM_TYPE_CLASSIFICATIONGUIDE - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a security classification guide (SCG)
as defined by the DoD Chapter 4 data model.
- RM_TYPE_CLASSIFICATIONSCHEME - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a classification scheme.
- RM_TYPE_CONNECTORREGISTRATION - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a connector registration.
- RM_TYPE_DISPOSALPHASE - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a disposal phase.
- RM_TYPE_DISPOSALSCHEDULE - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a disposition schedule.
- RM_TYPE_DISPOSALTRIGGER - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a disposal trigger.
- RM_TYPE_ELECTRONICRECORD - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is an electronic record.
- RM_TYPE_ELECTRONICRECORDFOLDER - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is an electronic record folder.
- RM_TYPE_EMAILRECORD - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is an e-mail record.
- RM_TYPE_EXTRACTLINK - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is an extract link.
- RM_TYPE_FPOS - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a File Plan Object Stores (FPOS).
- RM_TYPE_GUIDESECTION - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a security classification guide section
as defined by the DoD Chapter 4 data model.
- RM_TYPE_GUIDETOPIC - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a security classification guide topic
as defined by the DoD Chapter 4 data model.
- RM_TYPE_HOLD - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a hold.
- RM_TYPE_HYBRIDRECORDFOLDER - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a hybrid record folder.
- RM_TYPE_IMPLEMENTATAION_BASE - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is implemented using the Base model.
- RM_TYPE_IMPLEMENTATAION_DOD - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is implemented using the DoD model.
- RM_TYPE_IMPLEMENTATAION_PRO - Static variable in interface com.filenet.rm.api.RMType
-
Deprecated.
- RM_TYPE_IMPLEMENTATION_DODCLASSIFIED - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is implemented using the DoD Classified model.
- RM_TYPE_LOCATION - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a location.
- RM_TYPE_MARKER - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a marker.
- RM_TYPE_PATTERN - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a pattern.
- RM_TYPE_PATTERNLEVEL - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a pattern level.
- RM_TYPE_PATTERNSEQUENCES - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a pattern sequence.
- RM_TYPE_PDFRECORD - Static variable in interface com.filenet.rm.api.RMType
-
Constant value for representing pdf record
- RM_TYPE_PHASE - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a phase.
- RM_TYPE_PHASEEXCEPTION - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a phase exception.
- RM_TYPE_PHYSICALCONTAINER - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a physical container
- RM_TYPE_PHYSICALRECORDFOLDER - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a physical record folder.
- RM_TYPE_PREVIOUSPROTECTIVEMARKING - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a previous protective marking.
- RM_TYPE_RECEIPTLINK - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a receipt link.
- RM_TYPE_RECORD - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a record.
- RM_TYPE_RECORDCATEGORY - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a record category.
- RM_TYPE_RECORDCOPYLINK - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a record copy link.
- RM_TYPE_RECORDFOLDER - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a record folder.
- RM_TYPE_RECORDHOLDLINK - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a record hold link.
- RM_TYPE_RECORDSEEALSOLINK - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a record see-also link.
- RM_TYPE_RECORDTYPE - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a record type.
- RM_TYPE_REFERENCE - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a reference.
- RM_TYPE_RELATION - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a relation.
- RM_TYPE_REPORT - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a report.
- RM_TYPE_RESERVATION - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a reservation.
- RM_TYPE_RMAUDIT - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is an Audit event.
- RM_TYPE_RMFOLDERHOLDLINK - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a folder hold link.
- RM_TYPE_RMLINK - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a Records Manager link.
- RM_TYPE_RMLOG - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a Records Manager log.
- RM_TYPE_RMSYSTEM - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a Records Manager system custom object.
- RM_TYPE_ROS - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a Records Object Store (ROS).
- RM_TYPE_SUPERCEDELINK - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a supersede link.
- RM_TYPE_SYSTEMCONFIGURATION - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a system configuration.
- RM_TYPE_TRANSCRIPT - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a transcript.
- RM_TYPE_TRANSFERMAPPING - Static variable in interface com.filenet.rm.api.RMType
-
For internal use only.
- RM_TYPE_VOLUME - Static variable in interface com.filenet.rm.api.RMType
-
Specifies that the entity is a volume.
- RMAutoName - Interface in com.filenet.rm.api
-
Supports the auto naming feature of Records Manager that enables custom
applications to customize the name that is generated for a record.
- RMBulkOperationResult - Class in com.filenet.rm.api.util
-
The RMBulkOperationResult class is a utility class that contains the result
of bulk operations performed on each RMObject.
- RMBulkOperationResult() - Constructor for class com.filenet.rm.api.util.RMBulkOperationResult
-
The default constructor used to retrieve an instance of this class.
- RMBulkOperationResults - Class in com.filenet.rm.api.util
-
The RMBulkOperationResults class is a collection that contains objects of the
RMBulkOperationResult class.
- RMBulkOperationResults() - Constructor for class com.filenet.rm.api.util.RMBulkOperationResults
-
A default constructor that is used to retrieve an instance of this class.
- RMBulkOperationsUtil - Class in com.filenet.rm.api.util
-
The RMBulkOperationsUtil class is a utility class that is used to perform
bulk operations on RM entities.
- RMBulkOperationsUtil() - Constructor for class com.filenet.rm.api.util.RMBulkOperationsUtil
-
A default constructor thats is used to retrieve an instance of this class.
- RMConnector - Interface in com.filenet.rm.api
-
Represents a connection to an external document repositories, such as
Image Services, Content Services, and Content Engine.
- RMCustomObject - Interface in com.filenet.rm.api
-
Represents the base object for all RM custom objects.
- RMCustomObjects - Interface in com.filenet.rm.api
-
- RMDispositionConflictException - Exception in com.filenet.rm.api.exception
-
The RMDispositionConflictException class extends the RMException interface.
- RMDispositionConflictException(int, String) - Constructor for exception com.filenet.rm.api.exception.RMDispositionConflictException
-
Calls the constructor of the super class with the specified parameters.
- RMDriverManager - Class in com.filenet.rm.api
-
Registers and retrieves connector and auto-naming implementations for
a Records Manager application.
- RMDriverManager() - Constructor for class com.filenet.rm.api.RMDriverManager
-
Creates a new RMDriverManager
object.
- RMENTITY_DESCRIPTION - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RMEntityDescription for an RM object.
- RMENTITY_TYPE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RMEntityType for an RM object and specifies the type of RM entity
such as a RecordFolder or a RecordCategory.
- RMEVENTACTION - Static variable in interface com.filenet.rm.api.RMProperty
-
Property added for the custom object RMSystem
- RMException - Exception in com.filenet.rm.api.exception
-
Represents an exception that has occurred in Records Manager and provides
static methods to create and retrieve such an exception.
- RMException() - Constructor for exception com.filenet.rm.api.exception.RMException
-
Constructs an RMException
object with a null message String
.
- RMEXCEPTION - Static variable in exception com.filenet.rm.api.exception.RMException
-
- RMFolder - Interface in com.filenet.rm.api
-
Represents the base interface for all container objects in the Records Manager Java API.
- RMFOLDERPTR - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RMFolderPtr for a Disposal phase object.
- RMFolders - Interface in com.filenet.rm.api
-
ARepresents a collection of
RMFolder
objects.
- RMLogger - Class in com.filenet.rm.api.util
-
The RMLogger class is a wrapper class that provides a single choke point to control log4j logging.
- RMLogger(String) - Constructor for class com.filenet.rm.api.util.RMLogger
-
- RMLogger.Severity - Enum in com.filenet.rm.api.util
-
Represents the severity level of a log entry per the IBM/SWG logging standards.
- RMObject - Interface in com.filenet.rm.api
-
Represents the base interface for a Records Manager object.
- RMObjects - Interface in com.filenet.rm.api
-
Represents a collection of
RMObject
objects.
- RMObjectStore - Interface in com.filenet.rm.api
-
Represents a Records Manager object store that can hold
multiple file plans.
- RMObjectStores - Interface in com.filenet.rm.api
-
- RMPagedSearch - Interface in com.filenet.rm.api
-
Provides functionality for performing single object type searches of Records Manager objects.
- RMPropertiesCategoryType - Class in com.filenet.rm.api
-
Defines constant values that represent the categories into which Record Manager properties
are classified.
- RMPropertiesCategoryType() - Constructor for class com.filenet.rm.api.RMPropertiesCategoryType
-
- RMProperty - Interface in com.filenet.rm.api
-
Contains a constant for the name of each property in the Records Manager Jsva API.
- RMRecord - Interface in com.filenet.rm.api
-
Serves as the base interface for
RecordInfo
objects, which represent
records.
- RMRecordCategoryContainer - Interface in com.filenet.rm.api
-
Defines the behavior of any
RMFolder
object that can contain a record category in the file plan
hierarchy.
- RMRecordContainer - Interface in com.filenet.rm.api
-
- RMRecordFolderContainer - Interface in com.filenet.rm.api
-
Represents the base class for a container that can hold
RecordFolder
objects.
- RMSearch - Interface in com.filenet.rm.api
-
Provides methods for performing ad-hoc searches of Records Manager objects, such as record categories,
record folders, records, and physical record markers, across one or more object stores.
- RMStoredSearch - Interface in com.filenet.rm.api
-
Represents a predefined search query to retrieve Records Manager objects, including record categories,
folders, volumes, records, and custom objects, from one or more object stores.
- RMStoredSearches - Interface in com.filenet.rm.api
-
- RMType - Interface in com.filenet.rm.api
-
Provides a set of constants that indicate the types of entities that can reside
in a file plan.
- RMUnSupportedOperation - Exception in com.filenet.rm.api.exception
-
The RMUnSupportedOperation class extends the RMException interface.
- RMUnSupportedOperation(int, String) - Constructor for exception com.filenet.rm.api.exception.RMUnSupportedOperation
-
Calls the constructor of the super class with the specified parameters.
- RMUNSUPPORTEDOPERATION_EXCEPTION - Static variable in exception com.filenet.rm.api.exception.RMException
-
- RMUtil - Class in com.filenet.rm.api.util
-
The RMUtil class is a common utility class.
- RMUtil() - Constructor for class com.filenet.rm.api.util.RMUtil
-
This is the default public constructor of the RMUtil class that initializes a newly created RMUtil
.
- RMValidationOptions - Static variable in interface com.filenet.rm.api.RMProperty
-
- RMXSLUtil - Class in com.filenet.rm.api.util
-
The RMXSLUtil class is the base class that performs operations related to the XSL transformation.
- RMXSLUtil() - Constructor for class com.filenet.rm.api.util.RMXSLUtil
-
- ROLE_NAME - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of Role Name.
- ROLE_TYPE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of RoleType.
- runDisposaltrigger(DispositionAllocatableObject, RecordInfos) - Method in interface com.filenet.rm.api.DispositionSchedule
-
Checks the disposal event for the specified DispositionAllocatableObject
object and, if the event has occurred, sets the pre-cutoff date and
other disposal-related data for the object or its children.
- runDisposaltrigger(DispositionAllocatableObject) - Method in interface com.filenet.rm.api.DispositionSchedule
-
- SCANNED_IMAGE_FORMAT_AND_VERSION - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Scanned Record Object.
- SCENARIO_DEFINITION_DOCID - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ScenarioDefinitionDocID.
- SCENARIO_DESCRIPTION - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ScenarioDescription.
- SCREENING - Static variable in class com.filenet.rm.api.util.RMUtil
-
The int value represents the Vital workflow associated with the entities to be launched.
- search(String, String) - Method in interface com.filenet.rm.api.RMConnector
-
Performs the content-based search in the records object store (ROS) as identified by the URL parameters.
- searchDocument(String, String, String) - Method in interface com.filenet.rm.api.RMConnector
-
This method does the content-based search in the records object store (ROS) as identified by the URL parameters.
- searchDocumentXML(String, String, String) - Method in interface com.filenet.rm.api.RMConnector
-
Performs a content-based search in the records object store (ROS) as identified by the URL parameters.
- SearchExecuteXMLSchema - Class in com.filenet.rm.api.util
-
- SearchExecuteXMLSchema(Object[], ObjectStore) - Constructor for class com.filenet.rm.api.util.SearchExecuteXMLSchema
-
- SEARCHINGOBJECTTYPES - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of SearchingObjectTypes.
- SECURITY_CATEGORY - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of Security Category for an RM object and specifies the security.
- SECURITY_FOLDER - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the property that defines a record's security parent.
- SECURITYPOLICY - Static variable in class com.filenet.rm.api.util.XmlHelper
-
- SEPARATOR - Static variable in class com.filenet.rm.api.util.RMLogger
-
String that provides separation between the IBM/SWG message Id and the
localized, formatted message string.
- SERVER_NAME - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of ServerName for an RM Connector Registration object and specifies
the server name where Document is stored.
- setFromWorkflow(Object) - Static method in class com.filenet.rm.api.util.ThreadLocalForWorkflow
-
Sets the flag that mark the call is from workflow in this thread
- setIsExportedBeforeDestroy(boolean) - Method in interface com.filenet.rm.api.DisposableObject
-
Sets a flag that indicates whether an export has been done on this object prior to calling destroy.
- setLabel(String) - Method in class com.filenet.rm.api.util.RMBulkOperationResult
-
Sets the value of the member variable msObjectId equal to the value provided
in the input parameter.
- setLastRetrievalOfRecordOnContainer(RMObjectStore) - Method in interface com.filenet.rm.api.RecordInfo
-
Sets the LastRetrievalofRecord property for the container or
containers in which this RecordInfo
object is filed.
- setLoggerMessage(RMLogger, String, Object[], int) - Static method in class com.filenet.rm.api.util.LoggingUtil
-
- setLoggerMessage(RMLogger, String, Object, int) - Static method in class com.filenet.rm.api.util.LoggingUtil
-
- setLoggingFile(File) - Method in exception com.filenet.rm.api.exception.RMException
-
Deprecated.
This method no longer performs any action.
- setPatternValue(RMCustomObject) - Method in interface com.filenet.rm.api.ClassificationScheme
-
Updates the Pattern property for this ClassificationScheme
object to the
specified value.
- setProperties(Properties, boolean) - Method in interface com.filenet.rm.api.RecordInfo
-
Sets the properties of this RecordInfo
object to the
specified values.
- setProperties(Properties, boolean) - Method in interface com.filenet.rm.api.RMRecordContainer
-
Sets the properties of this container object to the specified values and, optionally, resets the
RECALCULATE_PHASE_RETENTION property if a sweep has reset the cutOff data
for the object.
- setResult(String, boolean) - Method in class com.filenet.rm.api.util.RMBulkOperationResult
-
Sets the value of the member variables msMsg and mbSuccess equal to the values
provided in the input parameters.
- setRMObjectStore(RMObjectStore) - Static method in exception com.filenet.rm.api.exception.RMException
-
Deprecated.
This method no longer performs any action.
- setState(int) - Method in interface com.filenet.rm.api.RMObject
-
Sets the member variable miState
to the specified value.
- settingTimeComponentasZero(Date) - Static method in class com.filenet.rm.api.util.RMUtil
-
Sets the time component of the date as zero
- setVital(Properties) - Method in interface com.filenet.rm.api.VitalableObject
-
Sets the vital-related properties for this object.
- setWSIRetryCount(int) - Method in interface com.filenet.rm.api.RMSearch
-
- setXML(Document) - Method in class com.filenet.rm.api.util.RMXSLUtil
-
This method sets the value of member variable sourceXML equal to the Document object passed as input parameter
- setXSL(String) - Method in class com.filenet.rm.api.util.RMXSLUtil
-
Sets the value of the pathToXSL member variable to the value passed in the input parameter.
- setXSLContent(String) - Method in class com.filenet.rm.api.util.RMXSLUtil
-
Sets the value of the pathToXSL member variable to the value of the TempFile.
- setXSLParameter(String, Object) - Method in class com.filenet.rm.api.util.RMXSLUtil
-
Creates an entry for key and value pair specified as input parameters in member variable parameters of type Map.
- SIMULATION_DESCRIPTION - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of SimulationDescription.
- SIMULATIONGUID - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of SimulationGUID.
- singleObjectTypeExecute(String, String, String, String, int, int, boolean) - Method in interface com.filenet.rm.api.RMPagedSearch
-
Searches for objects of a specified type by property values and returns paged results.
- singleObjectTypeExecuteXML(String, String, String, int) - Method in interface com.filenet.rm.api.RMSearch
-
Searches for objects of a specified type across one or more object stores by property values,
by content, or both, and returns an XML String
that contains a representation of
the Record Manager objects meeting the search criteria.
- SKIP_DISPOSITION_VALIDATION - Static variable in interface com.filenet.rm.api.RMProperty
-
- startCollection(String, boolean) - Method in class com.filenet.rm.api.util.XmlHelper
-
- startCollection(String) - Method in class com.filenet.rm.api.util.XmlHelper
-
- startsAt - Variable in class com.filenet.rm.api.util.QueryParser.SelectItem
-
- STOREDSEARCH - Static variable in class com.filenet.rm.api.util.XmlHelper
-
- STRONG_LINK_TYPE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents a constant for any strongly link object.
- SUBJECT - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of EmailSubject for a RecordInfo object.
- SUPERCEDED_BY - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of SupercededBy for a RecordInfo object.
- SUPERCEDED_DATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of SupercededDate for a RecordInfo object.
- SUPERCEDED_RECORD - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of SupercededRecord for a RecordInfo object.
- SUPERCEDING_RECORDS - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of SupercedingRecords.
- superceed(RecordInfo) - Method in interface com.filenet.rm.api.RecordInfo
-
Supersedes this RecordInfo
object with the specified
RecordInfo
object.
- SUPPLEMENTAL_MARKING - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of SupplementalMarking.
- SUPPLEMENTAL_MARKING_STRING_LIST - Static variable in interface com.filenet.rm.api.RMProperty
-
String representation of the actual supplemental marking list
- SUPPLEMENTAL_MARKINGS - Static variable in class com.filenet.rm.api.DODCH4Property
-
- SWEEP_AUDIT_XML - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the RecordHold Object.This property used to log the Entites Placed on Hold and Entites Removed from Hold.
- SWEEP_STATE - Static variable in interface com.filenet.rm.api.RMProperty
-
Property associated with the Hold.This property is used to identify the RM entities to be removed (which have been put dynamically) from the hold in the next run of Hold Sweep.
- SWEEPERROR - Static variable in exception com.filenet.rm.api.exception.RMException
-
- SWEEPFATAL - Static variable in exception com.filenet.rm.api.exception.RMException
-
- SWEEPLOCK - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of SweepLock.
- SWG_ID - Static variable in exception com.filenet.rm.api.exception.RMException
-
The IBM SWG Component Id assigned to the IBM Enterprise Records API.
- synchronizeDocument(String, Properties) - Method in interface com.filenet.rm.api.RMConnector
-
Synchronizes the document with the properties and the permissions provided by a user.
- synchronizeDocumentFromRecord(Properties) - Method in interface com.filenet.rm.api.RecordInfo
-
Updates the specified properties of the document or documents to which
this RecordInfo
object points.
- synchronizeRecordFromDocument(Properties, String) - Method in interface com.filenet.rm.api.RecordInfo
-
Updates the specified properties of this RecordInfo
object with
values from the specified document.
- SYSTEM_CONFIGURATION - Static variable in interface com.filenet.rm.api.RMProperty
-
Represents the value of SystemConfiguration for a ClassificationScheme object and specifies
the system configuration objects that are associated with it.
- _addNode(String, String, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Add Nodes to the XML String passed as parameter.
- _addNode(String, Map) - Static method in class com.filenet.rm.api.util.RMUtil
-
Adds mulitiple nodes to the XML String passed as a parameter.
- _addPropertiestoSearchXml(String, String[], String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Adds the symbolic name of the Properties to the search XML depending upon the value of lsclass.
- _addRMLog(RMObjectStore, Properties, Permissions) - Static method in class com.filenet.rm.api.util.RMUtil
-
Creates an RMLog object as an instance of RMCustomObject.
- _addToDate(Date, int, int, int) - Static method in class com.filenet.rm.api.util.RMUtil
-
Adds the year, month, and day passed as integers to the
Date and returns the Modified Date.
- _auditEvent(RMObject, String, String, String, String, int) - Static method in class com.filenet.rm.api.util.RMUtil
-
Audits the event based upon the value of Action type.
- _batchClose(BaseObjects, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Performs the batch close operation for collection of BaseObjects passed as parameter.
- _batchFile(BaseObjects, RMRecordContainer) - Static method in class com.filenet.rm.api.util.RMUtil
-
- _batchInactivate(boolean, RMObjectStore, BaseObjects, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Performs the batch inactivate operation for collection of BaseObjects passed as parameter.
- _batchReopen(boolean, BaseObjects, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Reopens all the baseobject collection instances of ClosableObject (RecordCategory ,
RecordFolder or Volume).
- _bulkUpdateEntities(Session, BaseObjects, Properties, boolean, boolean, boolean) - Static method in class com.filenet.rm.api.util.RMUtil
-
Updates the entities in a batch of 10 entities.
- _checkPattern(String, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Validates whether a string name that is passed in the asBaseName parameter is
valid as per the pattern specified by the asPattern paramter.
- _containsValue(int[], int) - Static method in class com.filenet.rm.api.util.RMUtil
-
- _createXMLdoc(InputSource) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns an XML document object.
- _createXMLDoc(Reader) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns an XML document object.
- _createXMLDoc(String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns an XML document object.
- _createXMLDoc(InputStream) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns an XML document object.
- _doMultipleFilePlanExist(RMObjectStore) - Static method in class com.filenet.rm.api.util.RMUtil
-
Checks whether the given object store contains more then one file plan.
- _generateDocumentURI(RMObjectStore, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a String Document URI obtained by modifying the URI (XML String) passed by a user while record
declaration.
- _getActingDisposalSchedule(RMObject) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns the entity with which a disposal schedule is associated or cut-off data is inherited.
- _getAllDateProperties(RMObjectStore) - Static method in class com.filenet.rm.api.util.RMUtil
-
Retrieves the symbolic names of all the date-type properties
of the Folder and Document classes.
- _getClassDescriptions(RMObjectStore, int[], boolean) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns the collection of the ClassDescription of all the RM types which are passed in
the int array as a parameter.
- _getClassDescriptionsXML(RMObjectStore, int[], boolean) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a String in XML that represents the class descriptions for Content
Engine classes and their subclasses.
- _getClassIDs(RMObjectStore, int[], boolean) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a String array of the ClassIds of all the RM entities whose RM type
is passed in the int array as a parameter.
- _getCollection(String[]) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a collection of String objects for a String array
- _getConnectorQueryString(String, String, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a query string to retrieve the connector registration object.
- _getConnectorRegistrationClass(RMObjectStore, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a ConnectorRegistration CustomObject retrieved from an RM object store based on the String query
passed as parameter
- _getCountFromResultSet(String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns the count of all the z_row elements passed in the
ResultSet XML string.
- _getCountFromSingleObjectType(String) - Static method in class com.filenet.rm.api.util.RMUtil
-
This method returns the count tag value from the ResultSet.
- _getCurrentPhaseExecutionDate(DisposableObject) - Static method in class com.filenet.rm.api.util.RMUtil
-
Calculates the current phase executution date for an entity
- _getDocumentStore(Object) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns an instance of DocumentStore for the object store, which is passed
as a parameter.
- _getFieldFromResultSet(String, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns the FieldName attribute of all the z_row elements passed in the
ResultSet XML string.
- _getFilePlanID(RMFolder) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns the GUID of the ClassificationScheme object that contains the specified RMFolder object.
- _getFilePlanObjectStores(ObjectStores) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns an RMObjectStores collection.
- _getLimitedResultSet(RMObjectStore, String, int) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns the String XML result set obtained by executing a query passed as parameter
asQuerySQL for an RM object store and retricts the result set as per the input parameter aiMaxRecords.
- _getMerged(ArrayList, BaseObjects) - Static method in class com.filenet.rm.api.util.RMUtil
-
Filters those documents from the aoToBeReplacedRecord BaseObjects collection that are not contained in the aoIDCheck collection.
- _getMergedROSOR(ArrayList, ArrayList) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a union of the record IDs as specified in the input parameters.
- _getMergedXML(String, String, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Invokes the XSLT transformation on the XML DOM document represented by the aoReaderXMLIDCheck string.
- _getNewDocument() - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns an empty Document object that is obtained from the Document Builder factory
- _getObjectStoreXML(ObjectStores) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a String that contains an XML representation of the object stores
The XML representation includes only those object stores that are valid FPOS.
- _getObjectStoreXML(ObjectStores, String[]) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a string that contains an XML representation of the object stores (and their properties, specified as symbolic names).
- _getPropertyDescriptions(ClassDescription, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a PropertyDescriptions collection whose elements are
property descriptions for the specified classes by filtering out property descriptions based on type.
- _getPropertyDescriptionXML(ClassDescription, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a String in XML that represents property descriptions for the specified classes,
by filtering out hidden property descriptions based on type.
- _getPropertyDescriptionXML(ClassDescription, String, RMRecordContainer) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a XML string of the property descriptions filtered out by the type of property descriptions
The xml string also includes the Record Pattern associated with the aoContainer.
- _getQueriedObjects(RMObjectStore, String, int) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a BaseObjects collection by executing a query passed as parameter
asQuerySQL for an RM object store.
- _getQueriedObjects(RMObjectStore, String, int, int) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a BaseObjects collection by executing a query passed as parameter
asQuerySQL for an RM object store and retricts the ResultSet as per the input parameter aiMaxResult.
- _getReader(String, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a Reader object.
- _getRecordObjectStores(ObjectStores) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns an ObjectStores collection.
- _getRecordURI(RMObjectStore, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a URI string for the record
- _getRegistrationClass(RMObjectStore, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns an RM custom object of type ConnectorRegistration that is retrieved from an
RM object store using the ID of this custom object.
- _getRegistrationID(RMObjectStore, String, String, String, boolean) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns the GUID of a connector registration object.
- _getResultSet(ObjectStore, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a string in XML that represents the results of a query in an object store.
- _getResultSet(RMObjectStore, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns the String result set obtained by executing a query passed as parameter
asQuerySQL in an RM object store.
- _getResultSet(RMObjectStore, String, int) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns the String XML result set obtained by executing a query passed as parameter
asQuerySQL for an RM object store.
- _getResultSet(RMObjectStore, String, int, int) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns the String result set obtained by executing a query passed as parameter
asQuerySQL in an RM object store and retricts the result set as per the input parameter aiMaxResults.
- _getResultSet(ObjectStore, String, int) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns the String XML result set obtained by executing the query passed as parameter
asQuerySQL for an object store.
- _getResultSet(ObjectStore, String, int, int) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a String XML result set obtained by executing a the query passed as parameter
asQuerySQL for an object store and retricts the ResultSet as per the input parameter aiMaxResults.
- _getRMObjectStore(ObjectStore) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns an instance of RMObjectStore for an object store.
- _getUserId(RMObjectStore) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns the "ShortName" property for the user currently associated with
the Buzz Session that is associated with the given RMObjectStore instance.
- _getUserIdWithDomain(RMObjectStore) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a String specifying the complete domain name of a User who is logged on to the current instance of an
object store.
- _isAnyParentClosed(RMFolder) - Static method in class com.filenet.rm.api.util.RMUtil
-
Determines if any parent of the RMFolder is closed.
- _isFilePlanObjectStore(ObjectStore) - Static method in class com.filenet.rm.api.util.RMUtil
-
Specifies if an object store is a valid File Plan Object Store.
- _isRecordObjectStore(ObjectStore) - Static method in class com.filenet.rm.api.util.RMUtil
-
Specifies if an object store is a valid Records Object Store.
- _launchWorkFlow(RMObjectStore, String[], String, int, VWSession) - Static method in class com.filenet.rm.api.util.RMUtil
-
Launches the workflow associated with the entities.
- _launchWorkFlow(RMObjectStore, Map, String, int, VWSession) - Static method in class com.filenet.rm.api.util.RMUtil
-
Launches the workflow associated with the entities.
- _locateRecord(String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Retrieves a RecordInfo object corresponding to the URI passed as a parameter.
- _populateMap(String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a Map object for the asURL, which is an XML String with nodes as key, and
the corresponding values as key-value pair.
- _populateMap(Document) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns a Map object for the aoDocument, which is an XML String with nodes as key, and
the corresponding values as key-value pair.
- _removeNode(String, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Removes the node from the XML String passed as a parameter whose name is specified
by the key name.
- _useInSubFolder(RMObjectStore, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
- _validateDate(String, String) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns true or false if the Date passed as String is as per the format
passed as parameter
- _validateDestination(RMRecordContainer, RecordInfo) - Static method in class com.filenet.rm.api.util.RMUtil
-
- _validateDisposition(DisposableObject) - Static method in class com.filenet.rm.api.util.RMUtil
-
Validates whether the entity passed as input parameter can be disposed or
not.
- _writeXML(Node) - Static method in class com.filenet.rm.api.util.RMUtil
-
Returns an XML string representing the node passed as parameter.