com.filenet.rm.api
Interface HoldableObject
All Superinterfaces:
com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.ReadableMetadataObject, RMObject, java.io.Serializable, com.filenet.wcm.api.ValueObject
All known subinterfaces:
- public interface HoldableObject
- extends RMObject
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 |
---|---|
getAllChildsOnHold()
Returns the children of this
HoldableObject object that are
on hold.
|
|
getAssociatedHolds()
Returns the
Hold objects that are associated with this
HoldableObject object.
|
|
getParentsOnHold(boolean abFirstParentOnly)
Returns the parents of this
HoldableObject object that are
on hold.
|
|
|
hold(Hold aoHold)
Associates this
HoldableObject object with the specified Hold object.
|
|
isAnyChildonHold()
Indicates whether any child of this
HoldableObject object
on hold.
|
|
isAnyParentOnHold()
Indicates whether any parent of this
HoldableObject object
on hold.
|
|
isOnHold(boolean abCheckParents)
Indicates whether this
HoldableObject object is on hold.
|
|
unHold(Hold aoHold)
Dissociates this
HoldableObject object from the specified 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.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
hold
- void hold(Hold aoHold)
- throws RMException
Parameters:
aoHold
- The Hold
object with which this HoldableObject
object is to be associated. Throws:
RMException
- If a Records Manager error occurs. unHold
- void unHold(Hold aoHold)
- throws RMException
Dissociates this
HoldableObject
object from the specified
Hold
object.
Parameters:
aoHold
- The Hold
object from which this HoldableObject
object is to be dissociated. Throws:
RMException
- If a Records Manager error occurs. isAnyParentOnHold
- boolean isAnyParentOnHold()
- throws RMException
Indicates whether any parent of this
HoldableObject
object
on hold.
Returns:
true
if any parent in the file plan is on hold; otherwise,
returns false
. Throws:
RMException
- If a Records Manager error occurs. isAnyChildonHold
- boolean isAnyChildonHold()
- throws RMException
Indicates whether any child of this
HoldableObject
object
on hold.
Returns:
true
if any child in the file plan is on hold; otherwise,
returns false
. Throws:
RMException
- If an error occurs, an RMException is thrown. isOnHold
- boolean isOnHold(boolean abCheckParents)
- throws RMException
Indicates whether this
HoldableObject
object is on hold. If this object is not
on hold and the abCheckParents
parameter is set to true
, the method indicates
whether any parent of this object is on hold.
Parameters:
abCheckParents
- A boolean
value of true
to check the parents of
this object; otherwise, false
. Returns:
true
this object or, optionally, one of its parents is on hold; otherwise,
returns false
. Throws:
RMException
- If a Records Manager error occurs. getAssociatedHolds
- Holds getAssociatedHolds()
- throws RMException
Returns the
Hold
objects that are associated with this
HoldableObject
object.
Returns:
A
Holds
collection containing the Hold
objects
associated with this object. Throws:
RMException
- If a Records Manager error occurs. getAllChildsOnHold
- RMObjects getAllChildsOnHold()
Returns the children of this
HoldableObject
object that are
on hold.
Returns:
An (@link RMObjects} collection that contains the children of this object
that are on hold.
Throws:
RMException
- If a Records Manager error occurs. getParentsOnHold
- RMFolders getParentsOnHold(boolean abFirstParentOnly)
Returns the parents of this
HoldableObject
object that are
on hold. If the abFirstParentOnly parameter is set to true
,
the method returns only the first parent on hold.
Parameters:
abFirstParentOnly
- A boolean
value of true
if the
method is to return only the first parent on hold that is found or false
if all parents on hold are to be returned. Returns:
An
RMFolders
collection that contains either the first parent or
all parents of this object that are on hold. Throws:
RMException
- If a Records Manager error occurs.
HoldableObject
object with the specifiedHold
object.