public interface AlternateRetention extends RMCustomObject
AlternateRetention
custom object
that can be an optional member of a DispositionPhase
instance.
Alternate retention instances are created and managed using
the DispositionPhase
and AlternateRetentionList
interfaces.
A new alternate retention is created using the DispositionPhase
instance to which it belongs, for example:
// The disposition phase to which a new alternate retention is added. DispositionPhase dispPhase = ...; AlternateRetentionList altRetents = dispPhase.getAlternateRetentions(); AlternateRetention newAltRetent = dispPhase.createAlternateRetention(); newAltRetent.setXXX(); ... // Further define the new alternate retention. // Add the new alternate retention to the phase's existing collection. altRetents.add(newAltRetent); // Finally save the phase or schedule in order to persist the new alternate // retention to the repository. dispPhase.save(RMRefreshMode.Refresh);
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getConditionXML()
Returns an XML string fragment describing the condition defined
for this alternate retention.
|
DispositionPhase |
getDispositionPhase()
Returns the parent
DispositionPhase instance to which
this alternate retention belongs. |
java.lang.String |
getRetentionBase()
Returns the symbolic property name that defines the retention base
for this alternate retention instance.
|
java.lang.Integer |
getRetentionNumber()
Returns the 1-based positional order of this alternate retention
instance within its containing
DispositionPhase parent. |
java.lang.Integer[] |
getRetentionPeriod()
Returns the three
Integer values that define
the retention time period in years, months and days,
respectively, for this alternate retention. |
void |
setConditionXML(java.lang.String xmlFragment)
Sets the XML string fragment that describes the condition defined
for this alternate retention.
|
void |
setRetentionBase(java.lang.String propSymbolicName)
Defines the
DateTime -type property that is used as the retention
base value by this alternate retention instance. |
void |
setRetentionPeriod(java.lang.Integer years,
java.lang.Integer months,
java.lang.Integer days)
Sets the retention time period for this alternate retention.
|
delete
getAccessAllowed, getClassDescription, getClassName, getClientIdentifier, getContainedBy, getDomainType, getEntityType, getName, getObjectIdentity, getPermissions, getProperties, getRepository, isCreationPending, isPlaceholder, refresh, refresh, refresh
save, setPermissions
getAuditedEvents
java.lang.Integer getRetentionNumber()
DispositionPhase
parent.Integer
value.DispositionPhase getDispositionPhase()
DispositionPhase
instance to which
this alternate retention belongs.DispositionPhase
instance.java.lang.String getRetentionBase()
String
value.void setRetentionBase(java.lang.String propSymbolicName)
DateTime
-type property that is used as the retention
base value by this alternate retention instance.propSymbolicName
- a symbolic name String
value.
Cannot be null
or blank.java.lang.Integer[] getRetentionPeriod()
Integer
values that define
the retention time period in years, months and days,
respectively, for this alternate retention.Integer[]
of a fixed size of three entries.
The first entry represents years The second entry represents
months. The third entry represents days. Any of these values
can be null
or an Integer
value
greater than or equal to 0.void setRetentionPeriod(java.lang.Integer years, java.lang.Integer months, java.lang.Integer days)
years
- an Integer
value greater than or equal to 0. If null
, will be saved as Integer(0).months
- an Integer
value greater than or equal to 0. If null
, will be saved as Integer(0).days
- an Integer
value greater than or equal to 0. If null
, will be saved as Integer(0).java.lang.String getConditionXML()
String
XML fragment.void setConditionXML(java.lang.String xmlFragment)
xmlFragment
- a String
value. Cannot be null
or blank.© Copyright IBM Corp. 2010, 2013. All Rights Reserved.