public interface IDfSysObjectRetention
Modifier and Type | Method and Description |
---|---|
void |
applyRetention(IDfId retainerId)
Places object under retention by the specified dm_retainer object.
|
boolean |
canSwapRetainer(IDfId oldRetainerId,
IDfId newRetainerId) |
int |
getRetainerCount()
Returns the number of entries in the i_retainer_id field.
|
IDfId |
getRetainerId(int index)
Returns an entry from the i_retainer_id field.
|
boolean |
isObjectUnderRetention()
Returns true if the object is under retention.
|
boolean |
isObjectUnderRetentionHold()
Returns true is the object is under retention-hold.
|
void |
onObjectRetained()
A function that is called by RPS after an object was retained.
|
void |
removeRetention(IDfId retainerId)
Removes object from the control of retention services.
|
void |
swapRetainer(IDfId oldRetainerId,
IDfId newRetainerId)
Replace a dm_retainer attached to the object to a new one.
|
void |
triggerConditionalRetention()
Function triggers the clip inside Centera associated with the SysObject object.
|
void applyRetention(IDfId retainerId) throws DfException
IDfPersistentObject.save()
is performed.
The caller must either have Write Permission on the sysobject or be a member of the
dm_retention_managers group to call this method.
The dm_sysobject.i_retainer_id and dm_sysobject.i_retain_until fields are modified.retainerId
- dm_retainer object controlling the retentionDfException
void removeRetention(IDfId retainerId) throws DfException
IDfPersistentObject.save()
is performed.
If the specified retainer is still active, the caller must be a member of the
dm_retention_managers group.retainerId
- dm_retainer from which to remove associationDfException
void swapRetainer(IDfId oldRetainerId, IDfId newRetainerId) throws DfException
IDfPersistentObject.save()
is performed.
The two retainers specified in oldRetainerId and newRetainerId must be compatible
in the sense that the following attribute values are identical:
. r_object_type
. owner_name
. acl_domain
. acl_name
. retainer_strategy
. r_retention_status
. retention_rule_type
. rendition_rule
. enforcement_rule
. immutability_rule
. aging_methodoldRetainerId:
- a dm_retainer already attached to the sysobject to be replaced withnewRetainerId:
- a dm_retainer to replace the oldRetainerId in the sysobject.DfException
boolean canSwapRetainer(IDfId oldRetainerId, IDfId newRetainerId) throws DfException
DfException
int getRetainerCount() throws DfException
DfException
IDfId getRetainerId(int index) throws DfException
index
- specifies the index of the repeating attributeDfException
void onObjectRetained() throws DfException
DfException
boolean isObjectUnderRetention() throws DfException
DfException
void triggerConditionalRetention() throws DfException
DfException
boolean isObjectUnderRetentionHold() throws DfException
DfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.