com.filenet.rm.api

Interface VitalableObject

All Superinterfaces:
com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.ReadableMetadataObject, RMObject, java.io.Serializable, com.filenet.wcm.api.ValueObject
All known subinterfaces:
RecordCategory, RecordFolder, RecordInfo, Volume

  1. public interface VitalableObject
  2. extends RMObject
Represents a Records Manager object that can be marked as vital to indicate that the object is required for meeting operational responsibilities during an enterprise-wide emergency.

Field Summary

Fields inherited from interface com.filenet.rm.api.RMObject
AGGREGATION_RECORD, AGGREGATION_RECORD_CATEGORY, AGGREGATION_RECORD_FOLDER, AGGREGATION_VOLUME, CLEAR_INHERITED_CHILDREN, INHERIT_IMMEDIATE_CHILDREN, INHERITED_CHILDREN, NON_INHERITED_CHILDREN, WORK_FLOW_STATUS_COMPLETED, WORK_FLOW_STATUS_NOT_STARTED, WORK_FLOW_STATUS_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
  1. void
executeVital()
Calculates the vital review date and sets the Vital Record Review Date property for this object to that date.
  1. boolean
isVital()
Indicates whether this object is a VitableObject object.
  1. void
setVital(com.filenet.wcm.api.Properties loProperties)
Sets the vital-related properties for this object.
  1. void
updateVitalStatus(java.util.Date aoVitalReviewDate,java.util.Date aoNextVitalReviewDate)
Uses the specified dates to update the Vital Record Next Review Date and Vital Workflow Status properties for this object.
Methods inherited from interface com.filenet.rm.api.RMObject
getObjectStore, getRMDeclassificationOffset, getRMEntityType, getRMImplementationType, registerExternalEvent, setState
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

Method Detail

setVital

  1. void setVital(com.filenet.wcm.api.Properties loProperties)
  2. throws RMException
Sets the vital-related properties for this object.
Parameters:
loProperties - A Properties collection containing the property values to be set for this object.
Throws:
RMException - If an error occurs, an RMException is thrown.

executeVital

  1. void executeVital()
  2. throws RMException
Calculates the vital review date and sets the Vital Record Review Date property for this object to that date.
Throws:
RMException - If an error occurs, an RMException is thrown.

updateVitalStatus

  1. void updateVitalStatus(java.util.Date aoVitalReviewDate,
  2. java.util.Date aoNextVitalReviewDate)
  3. throws RMException
Uses the specified dates to update the Vital Record Next Review Date and Vital Workflow Status properties for this object. The date specified by the aoNextVitalReviewDate property overrides the calculated next review for this object..
Parameters:
aoVitalReviewDate - A Date object representing the date on which the latest review occurred.
aoNextVitalReviewDate - A Date object that representing the date on which the next review is to occur.
Throws:
RMException - If an error occurs, an RMException is thrown.

isVital

  1. boolean isVital()
  2. throws RMException
Indicates whether this object is a VitableObject object.
Returns:
true if this object is a VitableObject object; otherwise, returns false.
Throws:
RMException - If an error occurs, an RMException is thrown.