public interface DispositionPhase extends RMCustomObject
DispositionSchedule
.
Disposition phase instances are created and managed using
the DispositionSchedule
and DispositionPhaseList
interfaces.
A new disposition phase is created using the DispositionSchedule
instance to which it belongs, for example:
// The disposition schedule to which a new phase is added. DispositionSchedule dispSched = ...; DispositionPhaseList dispPhases = dispSched.getDispositionPhases(); DispositionPhase newPhase = dispSched.createNewPhase("Phase X"); newPhase.setXXX(); ... // Further define the new phase instance. // Add the new phase to schedule's existing collection of phases. dispPhases.add(newPhase); // Finally save the schedule in order to persist the new phase to the repository. dispSched.save(RMRefreshMode.Refresh);
Note the use of the DispositionSchedule.save
method to persist the new disposition phase. The DispositionPhase.save
method, on the other hand, is
intended when persisting a change to an existing disposition phase.
Modifier and Type | Method and Description |
---|---|
AlternateRetention |
createAlternateRetention()
Creates a new
AlternateRetention instance that can be
further defined and then added to an AlternateRetentionList
belonging to a specific DispositionPhase . |
AlternateRetention |
createAlternateRetention(java.lang.String idStr)
Creates a new
AlternateRetention instance that can be
further defined and then added to an AlternateRetentionList
belonging to a specific DispositionPhase . |
AlternateRetentionList |
getAlternateRetentions()
Returns the collection of any
AlternateRetention instances, if any,
that are associated with this disposition phase. |
DispositionSchedule |
getAssociatedSchedule()
Returns the
DispositionSchedule with which this
disposition phase is associated. |
java.lang.String |
getDescription()
Returns the
RMEntityDescription property value of this disposition phase. |
java.lang.String |
getExportDestination()
Returns the
ExportDestination property value of this disposition phase. |
ContentItem |
getExportFormat()
Returns the
ExportFormate property value of this disposition phase. |
DispositionAction |
getPhaseAction()
Returns the
DispositionAction associated with this disposition phase. |
java.lang.String |
getPhaseName()
Returns the
PhaseName property value of this disposition phase. |
java.lang.Integer |
getPhaseNumber()
Returns the 1-based ordinal position of this disposition phase
instance relative to its siblings that are also associated
with its corresponding
DispositionSchedule . |
java.lang.String |
getReasonForChange()
Returns the
ReasonForChange property value of this disposition phase. |
java.lang.Integer[] |
getRetentionPeriod()
Returns the three
Integer values that define
the retention time period in years, months and days,
respectively, for this disposition phase. |
boolean |
isScreeningRequired()
Returns
true if screening is required for this disposition phase,
false otherwise. |
void |
setDescription(java.lang.String description)
Sets the
RMEntityDescription property value for this disposition phase. |
void |
setExportDestination(java.lang.String fileSystemDirPath)
Sets the
ExportDestination property value for this disposition phase. |
void |
setExportFormat(ContentItem contentItem)
Sets the
ExportFormat property value for this disposition phase. |
void |
setPhaseAction(DispositionAction action)
Assigns the specified
DispositionAction to this disposition phase. |
void |
setReasonForChange(java.lang.String value)
Sets the
ReasonForChange property value for this disposition phase. |
void |
setRetentionPeriod(java.lang.Integer years,
java.lang.Integer months,
java.lang.Integer days)
Sets the retention time period for this disposition phase.
|
void |
setScreeningRequired(boolean isRequired)
Set the value for the "Is Screening Required" property.
|
delete
getAccessAllowed, getClassDescription, getClassName, getClientIdentifier, getContainedBy, getDomainType, getEntityType, getName, getObjectIdentity, getPermissions, getProperties, getRepository, isCreationPending, isPlaceholder, refresh, refresh, refresh
save, setPermissions
getAuditedEvents
java.lang.String getPhaseName()
PhaseName
property value of this disposition phase.
Note that the name of a dispostion phase is defined at the time
it is created (i.e., DispositionSchedule.createNewPhase
).
String
value.java.lang.String getDescription()
RMEntityDescription
property value of this disposition phase.String
value. This entry can be null
.void setDescription(java.lang.String description)
RMEntityDescription
property value for this disposition phase.description
- a String
value. Can be null
or blank.DispositionAction getPhaseAction()
DispositionAction
associated with this disposition phase.DispositionAction
instance.void setPhaseAction(DispositionAction action)
DispositionAction
to this disposition phase.action
- the DispositionAction
instance to assign. Can be null
.boolean isScreeningRequired()
true
if screening is required for this disposition phase,
false
otherwise.true
if screening is required; false
otherwise.void setScreeningRequired(boolean isRequired)
isRequired
- true
if screening is required for this disposition phase;
false
otherwise.java.lang.Integer[] getRetentionPeriod()
Integer
values that define
the retention time period in years, months and days,
respectively, for this disposition phase.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)
At least one of the years, months or days input parameters must
be a non-null
value greater than or equal to 0,
unless this disposition phase currently has one or
more alternate retention instances assigned to it. This requirement
is validated at the time that the disposition phase or its
parent disposition schedule is saved.
years
- an Integer
value greater than or equal to 0. Can be null
.months
- an Integer
value greater than or equal to 0. Can be null
.days
- an Integer
value greater than or equal to 0. Can be null
.java.lang.String getReasonForChange()
ReasonForChange
property value of this disposition phase.String
value. This entry can be null
.void setReasonForChange(java.lang.String value)
ReasonForChange
property value for this disposition phase.value
- a String
value. Can be null
.java.lang.String getExportDestination()
ExportDestination
property value of this disposition phase.String
value. This entry can be null
.void setExportDestination(java.lang.String fileSystemDirPath)
ExportDestination
property value for this disposition phase.fileSystemDirPath
- a file system directory path String
. This entry can be null
.ContentItem getExportFormat()
ExportFormate
property value of this disposition phase.ContentItem
value. This entry can be null
.void setExportFormat(ContentItem contentItem)
ExportFormat
property value for this disposition phase.contentItem
- a ContentItem
instance. This entry can be null
.java.lang.Integer getPhaseNumber()
DispositionSchedule
.Integer
value.DispositionSchedule getAssociatedSchedule()
DispositionSchedule
with which this
disposition phase is associated.DispositionSchedule
instance.AlternateRetentionList getAlternateRetentions()
AlternateRetention
instances, if any,
that are associated with this disposition phase.AlternateRetentionList
instance.AlternateRetention createAlternateRetention()
AlternateRetention
instance that can be
further defined and then added to an AlternateRetentionList
belonging to a specific DispositionPhase
.AlternateRetention
instance.AlternateRetention createAlternateRetention(java.lang.String idStr)
AlternateRetention
instance that can be
further defined and then added to an AlternateRetentionList
belonging to a specific DispositionPhase
.idStr
- a String
Id value to be assigned to the new instance.
This parameter can be null
in which case an Id value
will be automatically generated for the new instance.AlternateRetention
instance.© Copyright IBM Corp. 2010, 2013. All Rights Reserved.