com.filenet.rm.api
Interface Hold
All Superinterfaces:
com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.ContainableObject, com.filenet.wcm.api.CreatableObject, com.filenet.wcm.api.CustomObject, com.filenet.wcm.api.GettableObject, com.filenet.wcm.api.LockableObject, com.filenet.wcm.api.ReadableMetadataObject, com.filenet.wcm.api.ReadableSecurityObject, RMCustomObject, RMObject, java.io.Serializable, com.filenet.wcm.api.ValueObject, com.filenet.wcm.api.WorkflowTarget, com.filenet.wcm.api.WriteableMetadataObject, com.filenet.wcm.api.WriteableSecurityObject
- public interface Hold
- extends RMCustomObject
Hold
interface extends the RMCustomObject
interface to provide methods for managing a disposition hold.
Field Summary
Fields inherited from interface com.filenet.rm.api.RMCustomObject |
---|
ACTION_AUTODELETE, ACTION_CUTTOFF, ACTION_DESTROY, ACTION_EXPORT, ACTION_INTRIMTRANSFER, ACTION_REVIEW, ACTION_TRANSFER, ACTION_VITAL_REVIEW, CYCLIC_EVENT, EXTERNAL_EVENT, IS_EQUAL, IS_GREATER, IS_GREATER_OR_EQUAL, IS_LESS, IS_LESS_OR_EQUAL, IS_NOT_EQUAL, IS_NOT_NULL, IS_NULL, LIKE, METADATA_EVENT, PREDEFINED_DATE_EVENT |
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.ContainableObject |
---|
INVALID_CONTAINMENT_NAME_CHARACTERS |
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 |
---|---|
getAssociatedRMobjects()
Returns the Record Manager objects that are associated with
this
Hold object.
|
|
|
getAssociatedRMobjects(java.lang.String[] aoFolderProps,java.lang.String[] aoRecordInfoProps,int aiMaxRecords,java.lang.String asFilterString)
Returns a
Document object containing the Record Manager objects that are associated with
this Hold object.
|
|
getHoldState()
Returns an
int value indicating the hold state for this Hold object.
|
|
isAppliedDynamically()
Indicates whether the disposition hold represented by this
Hold object
has been placed dynamically.
|
|
unHoldAll()
Releases the disposition hold on all objects associated with this
Hold object
by dissociating those objects from this Hold object.
|
Methods inherited from interface com.filenet.rm.api.RMObject |
---|
getObjectStore, getRMDeclassificationOffset, getRMEntityType, getRMImplementationType, registerExternalEvent, setState |
Methods inherited from interface com.filenet.wcm.api.CustomObject |
---|
applySecurityTemplate, changeClass, delete, getHeadLinks, getHeadLinksXML, getPermissionsXML, getSubscriptions, getTailLinks, getTailLinksXML, getUserAccess, getUserAccess, getUserAccess, raiseEvent |
Methods inherited from interface com.filenet.wcm.api.ContainableObject |
---|
file, file, file, file, getContainers, getContainersXML, getContainmentNames, getContainmentPaths, getSecurityParent, setContainmentName, setContainmentName, setSecurityParent, unfile, unfile |
Methods inherited from interface com.filenet.wcm.api.WorkflowTarget |
---|
getWorkflowSubscriptions, getWorkflowSubscriptionsXML, getWorkflowSubscriptionsXML |
Methods inherited from interface com.filenet.wcm.api.WriteableSecurityObject |
---|
setPermissions, setPermissions |
Methods inherited from interface com.filenet.wcm.api.WriteableMetadataObject |
---|
setProperties, setProperties |
Methods inherited from interface com.filenet.wcm.api.ReadableSecurityObject |
---|
getAccessMask, getPermissions, getPermissions |
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 |
Methods inherited from interface com.filenet.wcm.api.LockableObject |
---|
extendLock, extendLock, isLocked, lock, unlock, unlock |
Method Detail
getAssociatedRMobjects
- HoldableObjects getAssociatedRMobjects( )
- throws RMException
Returns:
A
HoldableObjects
collection containing the objects associated
with this Hold
object Throws:
RMException
- If a Records Manager error occurs. getAssociatedRMobjects
- org.w3c.dom.Document getAssociatedRMobjects( java.lang.String[] aoFolderProps,
- java.lang.String[] aoRecordInfoProps,
- int aiMaxRecords,
- java.lang.String asFilterString)
- throws RMException
Returns a
Document
object containing the Record Manager objects that are associated with
this Hold
object.
These objects can include record categories, record folders, or volumes.
Parameters:
aoFolderProps
- A String
array containing the properties associated with
the record categories, record folders, or volumes to be returned. aoRecordInfoProps
- A String
array containing the properties associated with
the records to be returned. aiMaxRecords
- An int
value indicating the maximum number of records to be returned. asFilterString
- A String
that specifies a filter to be applied to the results. Returns:
An
org.w3c.dom.Document
that includes the objects associated with associated with
this Hold
object. Throws:
RMException
- If a Records Manager error occurs. unHoldAll
- void unHoldAll()
- throws RMException
Releases the disposition hold on all objects associated with this
Hold
object
by dissociating those objects from this Hold
object.
Throws:
RMException
- If a Records Manager error occurs. isAppliedDynamically
- boolean isAppliedDynamically()
- throws RMException
Indicates whether the disposition hold represented by this
Hold
object
has been placed dynamically.
Returns:
true
if at least one object associated with this Hold
object
was dynamically placed on hold; otherwise, returns false
. Throws:
RMException
- If a Records Manager error occurs. getHoldState
- int getHoldState()
- throws RMException
Returns an
int
value indicating the hold state for this Hold
object.
Returns:
An
int
value indicating the hold state as follows:
0 | Hold without any conditions. |
1 | Hold with at least one condition. |
2 | User has requested removal of hold from all associated entities. |
3 | Hold will no longer be processed by the hold sweep. This value is set after completing the remove hold request by the hold sweep. |
4 | The hold sweep is currently processing the hold. |
Throws:
RMException
- If a Records Manager error occurs.
Hold
object. These objects can include record categories, record folders, or volumes.