public interface Hold extends RMCustomObject
Hold
interface extends the RMCustomObject
interface to provide methods for managing a disposition hold.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
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
INVALID_CONTAINMENT_NAME_CHARACTERS
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
Modifier and Type | Method and Description |
---|---|
HoldableObjects |
getAssociatedRMobjects()
Returns the Record Manager objects that are associated with
this
Hold object. |
org.w3c.dom.Document |
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. |
int |
getHoldState()
Returns an
int value indicating the hold state for this Hold object. |
boolean |
isAppliedDynamically()
Indicates whether the disposition hold represented by this
Hold object
has been placed dynamically. |
void |
unHoldAll()
Releases the disposition hold on all objects associated with this
Hold object
by dissociating those objects from this Hold object. |
getObjectStore, getRMDeclassificationOffset, getRMEntityType, getRMImplementationType, registerExternalEvent, setState
applySecurityTemplate, changeClass, delete, getHeadLinks, getHeadLinksXML, getPermissionsXML, getSubscriptions, getTailLinks, getTailLinksXML, getUserAccess, getUserAccess, getUserAccess, raiseEvent
file, file, file, file, getContainers, getContainersXML, getContainmentNames, getContainmentPaths, getSecurityParent, setContainmentName, setContainmentName, setSecurityParent, unfile, unfile
getWorkflowSubscriptions, getWorkflowSubscriptionsXML, getWorkflowSubscriptionsXML
setPermissions, setPermissions
setProperties, setProperties
getAccessMask, getPermissions, getPermissions
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
HoldableObjects getAssociatedRMobjects() throws RMException
Hold
object.
These objects can include record categories, record folders, or volumes.HoldableObjects
collection containing the objects associated
with this Hold
objectRMException
- If a Records Manager error occurs.org.w3c.dom.Document getAssociatedRMobjects(java.lang.String[] aoFolderProps, java.lang.String[] aoRecordInfoProps, int aiMaxRecords, java.lang.String asFilterString) throws RMException
Document
object containing the Record Manager objects that are associated with
this Hold
object.
These objects can include record categories, record folders, or volumes.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.org.w3c.dom.Document
that includes the objects associated with associated with
this Hold
object.RMException
- If a Records Manager error occurs.void unHoldAll() throws RMException
Hold
object
by dissociating those objects from this Hold
object.RMException
- If a Records Manager error occurs.boolean isAppliedDynamically() throws RMException
Hold
object
has been placed dynamically.true
if at least one object associated with this Hold
object
was dynamically placed on hold; otherwise, returns false
.RMException
- If a Records Manager error occurs.int getHoldState() throws RMException
int
value indicating the hold state for this Hold
object.int
value indicating the hold state as follows:
RMException
- If a Records Manager error occurs.© Copyright IBM Corp. 2003, 2013. All Rights Reserved.