public interface IDfRetainer extends IDfSysObject
CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE
Modifier and Type | Method and Description |
---|---|
void |
changeRetentionStatus(int retentionStatus)
This call changes the status of the dm_retainer object.
|
int |
getAgingMethod()
Returns the dm_retainer.aging_method value.
|
int |
getDispositionRule()
Returns the dm_retainer.disposition_rule value.
|
int |
getEnforcementRule()
Returns the dm_retainer.enforcement_rule value.
|
int |
getImmutabilityRule()
Returns the dm_retainer.immutability_rule value.
|
int |
getRenditionRule()
Returns the dm_retainer.rendition_rule value.
|
IDfId |
getRetainerRootId()
Returns the dm_retainer.retainer_root_id value.
|
int |
getRetainerStrategy()
Returns the dm_retainer.retainer_strategy value.
|
IDfTime |
getRetentionDate()
Returns the dm_retainer.retention_date value.
|
int |
getRetentionInterval()
Returns the dm_retainer.retention_interval value.
|
int |
getRetentionRuleType()
Returns the dm_retainer.retention_rule_type value.
|
int |
getRetentionStatus()
Returns the dm_retainer.r_retention_status value.
|
java.lang.String |
getRetentionStorageClass()
Returns the dm_retainer.retention_storage_class value.
|
void |
setAgingMethod(int aging_method)
Sets the dm_retainer.aging_method value.
|
void |
setDateRetentionPeriod(IDfTime retentionDate)
Specifies the retention period for the retainer.
|
void |
setDispositionRule(int dispositionRule)
Sets the dm_retainer.disposition_rule value.
|
void |
setEnforcementRule(int enforcementRule)
Sets the dm_retainer.enforcement_rule value.
|
void |
setImmutabilityRule(int immutabilityRule)
Sets the dm_retainer.immutability_rule value.
|
void |
setIntervalRetentionPeriod(int retentionInterval)
Specifies retention period for the retainer.
|
void |
setNoRetentionPeriod()
Specifies retention rule for the retainer with no defined retention period.
|
void |
setRenditionRule(int renditionRule)
Sets the dm_retainer.rendition_rule value.
|
void |
setRetentionStorageClass(java.lang.String retentionStorageClass)
Sets the dm_retainer.retention_storage_class value.
|
addDigitalSignature, addESignature, addNote, addReference, addRendition, addRenditionEx, addRenditionEx2, addRenditionEx3, appendContent, appendContentEx, appendFile, appendFileEx, appendPart, areAttributesModifiable, assemble, asVirtualDocument, attachPolicy, bindFile, branch, cancelCheckout, cancelCheckoutEx, cancelScheduledDemote, cancelScheduledPromote, cancelScheduledResume, cancelScheduledSuspend, canDemote, canPromote, canResume, canSuspend, checkin, checkinEx, checkout, checkoutEx, demote, destroyAllVersions, detachPolicy, disassemble, freeze, getAccessDate, getAccessorApplicationPermit, getAccessorCount, getAccessorName, getAccessorPermit, getAccessorPermitType, getAccessorXPermit, getAccessorXPermitNames, getACL, getACLDomain, getACLName, getAclRefValid, getAcsRequests, getAliasSet, getAliasSetId, getAntecedentId, getApplicationType, getAssembledFromId, getAuthors, getAuthorsCount, getBranchCount, getCabinetId, getChronicleId, getCollectionForContent, getCollectionForContentEx2, getCollectionForContentEx3, getCollectionForContentEx4, getComponentId, getComponentIdCount, getCompoundArchitecture, getContainId, getContainIdCount, getContent, getContentAvailability, getContentEx, getContentEx2, getContentEx3, getContentsId, getContentSize, getContentSize, getContentState, getContentStateCount, getContentType, getCreationDate, getCreatorName, getCurrentState, getCurrentStateName, getDirectDescendant, getDoubleContentAttr, getExceptionStateName, getFile, getFileEx, getFileEx2, getFolderId, getFolderIdCount, getFormat, getFrozenAssemblyCount, getFullText, getGroupName, getGroupPermit, getHasEvents, getHasFolder, getHasFrozenAssembly, getImplicitVersionLabel, getKeywords, getKeywordsCount, getLatestFlag, getLinkCount, getLinkHighCount, getLocations, getLockDate, getLockMachine, getLockOwner, getLogEntry, getMasterDocbase, getModifier, getModifyDate, getNextStateName, getObjectName, getOtherFileSize, getOwnerName, getOwnerPermit, getPageCount, getPath, getPathEx, getPathEx2, getPermissions, getPermit, getPermitEx, getPolicyId, getPolicyName, getPreviousStateName, getReferenceCount, getRemoteId, getRenditions, getResolutionLabel, getResumeState, getResumeStateName, getRetainerCount, getRetainerId, getRetainUntilDate, getRouters, getSpecialApp, getStatus, getStorageType, getStringContentAttr, getSubject, getTimeContentAttr, getTitle, getTypeName, getVdmPath, getVdmPathDQL, getVersionLabel, getVersionLabelCount, getVersionLabels, getVersionPolicy, getVersions, getWorkflows, getWorldPermit, getXPermit, getXPermitList, getXPermitNames, grant, grantPermit, hasPermission, insertContent, insertContentEx, insertFile, insertFileEx, insertPart, isArchived, isCheckedOut, isCheckedOutBy, isContentTransferCapabilityEnabled, isFrozen, isHidden, isImmutable, isLinkResolved, isPublic, isReference, isSuspended, isVirtualDocument, link, mark, mount, print, promote, prune, queue, refreshReference, removeContent, removeNote, removePart, removeRendition, removeRenditionEx, removeRenditionEx2, resolveAlias, resume, revertACL, revoke, revokePermit, saveAsNew, saveLock, scheduleDemote, schedulePromote, scheduleResume, scheduleSuspend, setACL, setACLDomain, setACLName, setApplicationType, setArchived, setAuthors, setCompoundArchitecture, setContent, setContentEx, setContentEx2, setContentType, setDoubleContentAttribute, setFile, setFileEx, setFullText, setGroupName, setGroupPermit, setHidden, setIsVirtualDocument, setKeywords, setLinkResolved, setLogEntry, setObjectName, setOwnerName, setOwnerPermit, setPath, setResolutionLabel, setSpecialApp, setStatus, setStorageType, setStringContentAttribute, setSubject, setTimeContentAttribute, setTitle, setWorldPermit, suspend, unfreeze, unlink, unmark, updatePart, updatePartEx, useACL, verifyESignature
addChildRelative, addParentRelative, apiExec, apiGet, apiSet, destroy, fetch, fetchWithCaching, getAttrAssistance, getAttrAssistanceWithValues, getAttrAsstDependencies, getChildRelatives, getParentRelatives, getPartition, getType, getValidator, getVStamp, getWidgetType, isDeleted, isDirty, isInstanceOf, isNew, isReplica, lock, lockEx, registerEvent, removeChildRelative, removeParentRelative, revert, save, setPartition, signoff, unRegisterEvent, unRegisterEventEx, validateAllRules, validateAttrRules, validateAttrRulesWithValue, validateAttrRulesWithValues, validateObjRules, validateObjRulesWithValues
appendBoolean, appendDouble, appendId, appendInt, appendString, appendTime, appendValue, dump, enumAttrs, findAttrIndex, findBoolean, findDouble, findId, findInt, findString, findTime, findValue, getAllRepeatingStrings, getAttr, getAttrCount, getAttrDataType, getBoolean, getDouble, getId, getInt, getLong, getObjectId, getObjectSession, getOriginalSession, getRepeatingBoolean, getRepeatingDouble, getRepeatingId, getRepeatingInt, getRepeatingLong, getRepeatingString, getRepeatingTime, getRepeatingValue, getSession, getSessionManager, getString, getTime, getValue, getValueAt, getValueCount, hasAttr, insertBoolean, insertDouble, insertId, insertInt, insertString, insertTime, insertValue, isAttrRepeating, isNull, remove, removeAll, setBoolean, setDouble, setId, setInt, setNull, setRepeatingBoolean, setRepeatingDouble, setRepeatingId, setRepeatingInt, setRepeatingString, setRepeatingTime, setRepeatingValue, setSessionManager, setString, setTime, setValue, truncate
void setDateRetentionPeriod(IDfTime retentionDate) throws DfException
IDfRetentionRuleType.DATE
)
and retention_date fields of the dm_retainer object.retentionDate
- Date for retentionDfException
void setIntervalRetentionPeriod(int retentionInterval) throws DfException
IDfRetentionRuleType.INTERVAL
)
and retention_date fields of the dm_retainer object.retentionInterval
- Time interval - in seconds - for retentionDfException
void setNoRetentionPeriod() throws DfException
IDfRetentionRuleType.NONE
.DfException
int getRetainerStrategy() throws DfException
IDfRetainerStrategy
.DfException
IDfId getRetainerRootId() throws DfException
DfException
int getRetentionRuleType() throws DfException
IDfRetentionRuleType
.DfException
IDfTime getRetentionDate() throws DfException
getRetentionDate
in interface IDfSysObject
DfException
int getRetentionInterval() throws DfException
DfException
void setRenditionRule(int renditionRule) throws DfException
renditionRule
- rendition rule. Values are defined by IDfRetainerRenditionRule
.DfException
int getRenditionRule() throws DfException
IDfRetainerRenditionRule
.DfException
void setImmutabilityRule(int immutabilityRule) throws DfException
immutabilityRule
- The immutability rule. Values are defined by IDfRetainerImmutabilityRule
.DfException
int getImmutabilityRule() throws DfException
IDfRetainerImmutabilityRule
.DfException
void setEnforcementRule(int enforcementRule) throws DfException
enforcementRule
- The enforcement rule. Values are defined by IDfRetainerEnforcementRule
.DfException
int getEnforcementRule() throws DfException
IDfRetainerEnforcementRule
.DfException
void setDispositionRule(int dispositionRule) throws DfException
dispositionRule
- The disposition rule. Values are defined by IDfRetainerDispositionRule
.DfException
int getDispositionRule() throws DfException
IDfRetainerDispositionRule
.DfException
void setRetentionStorageClass(java.lang.String retentionStorageClass) throws DfException
retentionStorageClass
- The retention_storage_class value.DfException
java.lang.String getRetentionStorageClass() throws DfException
DfException
void changeRetentionStatus(int retentionStatus) throws DfException
save
call.retentionStatus
- The new status. Values are defined by IDfRetentionStatus
.DfException
int getRetentionStatus() throws DfException
IDfRetentionStatus
.DfException
void setAgingMethod(int aging_method) throws DfException
aging_method,
- either CHRONOLOGICAL, CONDITIONAL, DOES_NOT_AGE .DfException
int getAgingMethod() throws DfException
DfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.