public interface CmHold extends RepositoryObject, Replicable, Subscribable, IndependentlyPersistableObject
CmHoldable
,
preventing that object from being deleted for
an indefinite period of time, until the hold is explicitly removed.
Holds can be repeatedly applied and removed on an ad hoc basis
during the object's lifecycle.
A hold is applied by associating a CmHold
object with a CmHoldable
object
through an intermediate CmHoldRelationship
object.
Every hold in which a CmHold
object participates is reflected in the object's
CmHoldRelationships property.
Deleting a CmHold
object results in a cascade delete of the set of CmHoldRelationship
objects
referenced by the CmHoldRelationships property. Thus, the hold is removed from all of the
CmHoldable
objects to which the hold previously applied.
Note: Deleting a CmHold
object that is referenced by a large number of
CmHoldRelationship
objects can result in a database transaction failure.
If you anticipate large-scale hold removals, configure the application server transaction timeout and transaction log space
to accommodate the operation.
By default, only object store administrators have the right to create CmHold
instances.
The initial default instance permissions for CmHold
grant full control to object store administrators
and read-only access to general users.
Modifier and Type | Method and Description |
---|---|
ActiveMarkingList |
get_ActiveMarkings()
Returns the value of the ActiveMarkings property.
|
EventSet |
get_AuditedEvents()
Returns the value of the AuditedEvents property.
|
CmHoldRelationshipSet |
get_CmHoldRelationships()
Returns the value of the CmHoldRelationships property.
|
java.lang.String |
get_Creator()
Returns the value of the Creator property.
|
java.util.Date |
get_DateCreated()
Returns the value of the DateCreated property.
|
java.util.Date |
get_DateLastModified()
Returns the value of the DateLastModified property.
|
java.lang.String |
get_DescriptiveText()
Returns the value of the DescriptiveText property.
|
java.lang.String |
get_DisplayName()
Returns the value of the DisplayName property.
|
Id |
get_Id()
Returns the value of the Id property.
|
java.lang.String |
get_LastModifier()
Returns the value of the LastModifier property.
|
java.lang.String |
get_Owner()
Returns the value of the Owner property.
|
AccessPermissionList |
get_Permissions()
Returns the value of the Permissions property.
|
void |
set_Creator(java.lang.String value)
Sets the value of the Creator property.
|
void |
set_DateCreated(java.util.Date value)
Sets the value of the DateCreated property.
|
void |
set_DateLastModified(java.util.Date value)
Sets the value of the DateLastModified property.
|
void |
set_DescriptiveText(java.lang.String value)
Sets the value of the DescriptiveText property.
|
void |
set_DisplayName(java.lang.String value)
Sets the value of the DisplayName property.
|
void |
set_LastModifier(java.lang.String value)
Sets the value of the LastModifier property.
|
void |
set_Owner(java.lang.String value)
Sets the value of the Owner property.
|
void |
set_Permissions(AccessPermissionList value)
Sets the value of the Permissions property.
|
getObjectStore
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup
raiseEvent
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
java.lang.String get_Creator()
void set_Creator(java.lang.String value)
java.util.Date get_DateCreated()
void set_DateCreated(java.util.Date value)
java.lang.String get_LastModifier()
void set_LastModifier(java.lang.String value)
java.util.Date get_DateLastModified()
void set_DateLastModified(java.util.Date value)
Id get_Id()
EventSet get_AuditedEvents()
java.lang.String get_Owner()
void set_Owner(java.lang.String value)
AccessPermissionList get_Permissions()
void set_Permissions(AccessPermissionList value)
ActiveMarkingList get_ActiveMarkings()
java.lang.String get_DisplayName()
void set_DisplayName(java.lang.String value)
java.lang.String get_DescriptiveText()
void set_DescriptiveText(java.lang.String value)
CmHoldRelationshipSet get_CmHoldRelationships()
© Copyright IBM Corporation 2006, 2015. All rights reserved.