com.filenet.rm.api
Interface RMObject
All Superinterfaces:
com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.ReadableMetadataObject, java.io.Serializable, com.filenet.wcm.api.ValueObject
All known subinterfaces:
ActivableObject, ClassificationScheme, ClosableObject, DisposableObject, DispositionAllocatableObject, DispositionSchedule, Hold, HoldableObject, RecordCategory, RecordFolder, RecordInfo, RecordType, RMCustomObject, RMFolder, RMObjectStore, RMRecord, RMRecordCategoryContainer, RMRecordContainer, RMRecordFolderContainer, RMStoredSearch, VitalableObject, Volume
- public interface RMObject
- extends com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.ReadableMetadataObject
RMObject
interface.
The RMObject
interface extends the BaseObject
and ReadableMetadataObject
interfaces of the Content Java API.
Field Summary
Modifier and Type | Field and Description |
---|---|
|
AGGREGATION_RECORD
Specifies that this object represents a record.
|
|
AGGREGATION_RECORD_CATEGORY
Specifies that this object represents a record category.
|
|
AGGREGATION_RECORD_FOLDER
Specifies that this object represents a record folder.
|
|
AGGREGATION_VOLUME
Specifies that this object represents a volume.
|
|
CLEAR_INHERITED_CHILDREN
Specifies that the disposition schedule is to be removed from all children that
that inherited the schedule from this object.
|
|
INHERIT_IMMEDIATE_CHILDREN
Specifies that a disposition schedule is to be applied to all immediate children of this object.
|
|
INHERITED_CHILDREN
Specifies that a disposition schedule is to be applied to the child objects that inherit from this object.
|
|
NON_INHERITED_CHILDREN
Specifies that a disposition schedule is to be applied to the child object that do not
inherit from this object.
|
|
WORK_FLOW_STATUS_COMPLETED
Specifies that the current workflow status of this object is Completed.
|
|
WORK_FLOW_STATUS_NOT_STARTED
Specifies that the current workflow status of this object is Not Started.
|
|
WORK_FLOW_STATUS_STARTED
Specifies that the current workflow status of this object is Started.
|
Fields inherited from interface com.filenet.wcm.api.BaseObject |
---|
EXPORT_DEFAULT, EXPORT_ENCODED_CONTENT, EXPORT_FULL, EXPORT_OBJECT_ID, EXPORT_OBJECT_SECURITY, IMPORT_DEFAULT, IMPORT_OBJECT_ID, IMPORT_OWNER, IMPORT_PERMISSIONS, TYPE_ACTIVE_MARKING, TYPE_ANNOTATION, TYPE_ANY, TYPE_AUDIT_DEFINITION, TYPE_CBR_ENGINE_TYPE, TYPE_CHOICE, TYPE_CHOICELIST, TYPE_CLASS_SUBSCRIPTION, TYPE_CLASSDEFINITION, TYPE_CLASSDESCRIPTION, TYPE_COLUMN_DEFINITION, TYPE_COMPUTER, TYPE_CONTENT_CACHE_SERVICE, TYPE_CONTENT_MGR_SERVICE, TYPE_CONTENT_REFERENCE, TYPE_CONTENT_TRANSFER, TYPE_CUSTOMOBJECT, TYPE_DOCUMENT, TYPE_DOCUMENT_CLASSIFICATION_ACTION, TYPE_DOCUMENT_LIFECYCLE_ACTION, TYPE_DOCUMENT_LIFECYCLE_POLICY, TYPE_DOCUMENTSTATE, TYPE_DOMAIN, TYPE_DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_ENTIRENETWORK, TYPE_EVENT, TYPE_EVENT_ACTION, TYPE_FEATURE_ADD_ON, TYPE_FILESTORE, TYPE_FOLDER, TYPE_GROUP, TYPE_INSTANCE_SUBSCRIPTION, TYPE_LINK, TYPE_LOCALIZED_STRING, TYPE_MARKING_SET, TYPE_MULTIPLEVALUES, TYPE_OBJECT_STORE, TYPE_OBJECTSET, TYPE_OBJSTORE_SERVICE, TYPE_PERMISSION, TYPE_PROPERTY_DEFINITION, TYPE_PROPERTYDESCRIPTION, TYPE_PROPERTYDESCRIPTIONS, TYPE_PUBLISH_REQUEST, TYPE_PUBLISH_TEMPLATE, TYPE_READONLY_OBJECT_SET, TYPE_REALM, TYPE_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_SECURITY_POLICY, TYPE_SECURITY_TEMPLATE, TYPE_STORAGE_POLICY, TYPE_STORED_SEARCH, TYPE_STYLE_TEMPLATE, TYPE_SUBSCRIBED_EVENT, TYPE_SUBSCRIPTION, TYPE_TABLE_DEFINITION, TYPE_TRANSIENT, TYPE_USER, TYPE_VERSIONSERIES, TYPE_WORKFLOW_CLASS_SUBSCRIPTION, TYPE_WORKFLOW_INSTANCE_SUBSCRIPTION, TYPE_WORKFLOWDEFINITION, TYPE_XML_PROPERTY_MAPPING_SCRIPT |
Method Summary
Modifier and Type | Method and Description |
---|---|
getObjectStore()
Returns a reference to the object store to which this object is persisted.
|
|
|
getRMDeclassificationOffset()
Returns the declassification offset for this object.
|
|
getRMEntityType()
Returns the value of the RMEntityType property for this object.
|
|
getRMImplementationType()
Returns an
int value representing the RMType constant that indicates
the implementation type of this object.
|
|
registerExternalEvent(java.lang.String[] asArrEventIDs,java.util.Date aoExtEventOccurrenceDate)
Deprecated. Use the
registerExternalEvent
method for the RMBulkOperationsUtil instead.
|
|
setState(int aiState)
Sets the member variable
miState to the specified value.
|
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject |
---|
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh |
Methods inherited from interface com.filenet.wcm.api.BaseObject |
---|
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject |
Field Detail
INHERITED_CHILDREN
- static final int INHERITED_CHILDREN
Specifies that a disposition schedule is to be applied to the child objects that inherit from this object.
See Also:
INHERIT_IMMEDIATE_CHILDREN
- static final int INHERIT_IMMEDIATE_CHILDREN
Specifies that a disposition schedule is to be applied to all immediate children of this object.
See Also:
NON_INHERITED_CHILDREN
- static final int NON_INHERITED_CHILDREN
Specifies that a disposition schedule is to be applied to the child object that do not
inherit from this object.
See Also:
CLEAR_INHERITED_CHILDREN
- static final int CLEAR_INHERITED_CHILDREN
Specifies that the disposition schedule is to be removed from all children that
that inherited the schedule from this object.
See Also:
WORK_FLOW_STATUS_NOT_STARTED
- static final int WORK_FLOW_STATUS_NOT_STARTED
Specifies that the current workflow status of this object is Not Started.
See Also:
WORK_FLOW_STATUS_STARTED
- static final int WORK_FLOW_STATUS_STARTED
Specifies that the current workflow status of this object is Started.
See Also:
WORK_FLOW_STATUS_COMPLETED
- static final int WORK_FLOW_STATUS_COMPLETED
Specifies that the current workflow status of this object is Completed.
See Also:
AGGREGATION_RECORD_CATEGORY
- static final java.lang.String AGGREGATION_RECORD_CATEGORY
Specifies that this object represents a record category.
See Also:
AGGREGATION_RECORD_FOLDER
- static final java.lang.String AGGREGATION_RECORD_FOLDER
Specifies that this object represents a record folder.
See Also:
AGGREGATION_VOLUME
- static final java.lang.String AGGREGATION_VOLUME
Specifies that this object represents a volume.
See Also:
AGGREGATION_RECORD
- static final java.lang.String AGGREGATION_RECORD
Specifies that this object represents a record.
See Also:
Method Detail
getRMEntityType
- int getRMEntityType()
- throws RMException
Returns the value of the RMEntityType property for this object.
Returns:
An int value that represents the RMEntityType property value for this object.
Throws:
RMException
- If the RMEntityType property for this object is not found. getObjectStore
- RMObjectStore getObjectStore()
- throws RMException
Returns a reference to the object store to which this object is persisted.
registerExternalEvent
- void registerExternalEvent(java.lang.String[] asArrEventIDs,
- java.util.Date aoExtEventOccurrenceDate)
- throws RMException
Deprecated. Use the
registerExternalEvent
method for the RMBulkOperationsUtil
instead.
Updates the ExternalEventOccurrenceDate property, which represents the date the external event
is to be executed, for the specified disposal triggers.
Parameters:
asArrEventIDs
- A String
array that contains the GUIDs of the disposal triggers
to be updated. aoExtEventOccurrenceDate
- A Date
object containing the new date on which the
external event is to be executed. Throws:
RMException
- If a Records Manager error occurs. getRMImplementationType
- int getRMImplementationType()
Returns an
int
value representing the RMType
constant that indicates
the implementation type of this object.
Returns:
An
int
value that specifies the implementation type of this object. getRMDeclassificationOffset
- int getRMDeclassificationOffset( )
Returns the declassification offset for this object.
Returns:
An
int
value that represents the declassification offset for
this object. setState
- void setState(int aiState)
Sets the member variable
miState
to the specified value. The miState
member
variable represents the state of this object for such actions as whether to destroy or
execute the interim transfer method of this object.
Parameters:
aiState
- An int
value representing the state of this object.