public interface DispositionSchedule extends RMCustomObject
A specific disposition schedule can be obtained using the
RMFactory.DispositionSchedule
factory class.
A new disposition schedule can be created using the factory class
method RMFactory.DispositionSchedule.createInstance
.
The resulting new DispositionSchedule
instance can then be further defined
followed by an eventual call to its save
in order to ensure that it is persisted to its associated file plan repository.
RMFactory.DispositionSchedule
Modifier and Type | Method and Description |
---|---|
DispositionPhase |
createNewPhase(java.lang.String phaseName)
Creates a new
DispositionPhase instance that can
be further defined and then added to a DispositionPhaseList . |
DispositionPhase |
createNewPhase(java.lang.String phaseName,
java.lang.String idStr)
Creates a new
DispositionPhase instance that can
be further defined and then added to a DispositionPhaseList . |
java.util.List<RecordCategory> |
getAssociatedRecordCategories()
Returns a collection of
RecordCategory instances to
which this DispositionSchedule instance is
directly associated. |
java.util.List<RecordFolder> |
getAssociatedRecordFolders()
Returns a collection of
RecordFolder instances to
which this DispositionSchedule instance is
directly associated. |
java.util.List<RecordType> |
getAssociatedRecordTypes()
Returns a collection of
RecordType instances to
which this DispositionSchedule instance is
directly associated. |
java.lang.String |
getAuditXML()
Returns the
SweepAuditXML property value of this disposition schedule. |
java.util.Date |
getCalendarDate()
Returns the
CalendarDate property value of this disposition schedule. |
DispositionAction |
getCutoffAction()
Returns the
DispositionAction instance that defines
the Cutoff action for this DispositionSchedule . |
java.lang.String |
getCutoffBase()
Returns the symbolic name of the
Date -type property that defines
the cutoff base for this DispositionSchedule . |
java.lang.String |
getDescription()
Returns the
RMEntityDescription property value of this disposition schedule. |
java.lang.String |
getDispositionAuthority()
Returns the
AuthorizingStatute property value of this disposition schedule. |
java.lang.Integer[] |
getDispositionEventOffset()
Returns the three
Integer values that define
the cutoff event offset time period in years, months and days,
respectively. |
DispositionPhaseList |
getDispositionPhases()
Returns an ordered collection of existing
DispositionPhase instances
that define this disposition schedule. |
DispositionTrigger |
getDispositionTrigger()
Returns the CutoffDisposalTrigger property value.
|
java.util.Date |
getEffectiveDateModified()
Returns the
EffectiveDateModified property value of this disposition schedule. |
java.lang.String |
getReasonForChange()
Returns the
ReasonForChange property value of this disposition schedule. |
java.lang.String |
getScheduleName()
Returns the
DisposalScheduleName property value of this disposition schedule. |
java.lang.Integer |
getSweepState()
Returns the
SweepState property value of this disposition schedule. |
java.lang.Boolean |
isScreeningRequired()
Returns the
IsScreeningRequired property value of this disposition schedule. |
java.lang.Boolean |
isTriggerChanged()
Returns the
IsTriggerChanged property value of this disposition schedule. |
void |
recalculateCutoffDate(Dispositionable entity)
Recalculates the cutoff date for the given entity based upon this
disposition schedule.
|
void |
setCalendarDate(java.util.Date dateValue)
Sets the
CalendarDate property value for this disposition schedule. |
void |
setCutoffAction(DispositionAction action)
Sets the
DispositionAction that defines the
Cutoff action for this DispositionSchedule . |
void |
setCutoffBase(java.lang.String propertySymbolicName)
Sets the symbolic name of the property to be used
as the cutoff base value.
|
void |
setDescription(java.lang.String value)
Sets the
RMEntityDescription property value for this disposition schedule. |
void |
setDispositionAuthority(java.lang.String value)
Sets the
AuthorizingStatute property value for this disposition schedule. |
void |
setDispositionEventOffset(java.lang.Integer years,
java.lang.Integer months,
java.lang.Integer days)
Sets the cutoff event offset time period for this disposition schedule.
|
void |
setDispositionTigger(DispositionTrigger trigger)
Sets the CutoffDisposalTrigger property value for this
DispositionSchedule instance. |
void |
setReasonForChange(java.lang.String reason)
Assigns a value to the
ReasonForChange property. |
void |
setScheduleName(java.lang.String name)
Sets the
DisposalScheduleName property value for this disposition schedule. |
void |
setScreeningRequired(java.lang.Boolean value)
Sets the
IsScreeningRequired property value for this disposition schedule. |
delete
getAccessAllowed, getClassDescription, getClassName, getClientIdentifier, getContainedBy, getDomainType, getEntityType, getName, getObjectIdentity, getPermissions, getProperties, getRepository, isCreationPending, isPlaceholder, refresh, refresh, refresh
save, setPermissions
getAuditedEvents
java.lang.String getScheduleName()
DisposalScheduleName
property value of this disposition schedule.String
value.void setScheduleName(java.lang.String name)
DisposalScheduleName
property value for this disposition schedule.
This name value must be unique relative to all other disposition schedules
defined on the same file plan repository. Validation of
such name uniqueness does not occur until the
save
is called.
name
- a String
value. This entry cannot be null
nor blank.java.lang.String getDescription()
RMEntityDescription
property value of this disposition schedule.String
value. This entry can be null
.void setDescription(java.lang.String value)
RMEntityDescription
property value for this disposition schedule.value
- a String
value. This entry can be null
or blank.java.util.Date getCalendarDate()
CalendarDate
property value of this disposition schedule.Date
value. This entry can be null
.void setCalendarDate(java.util.Date dateValue)
CalendarDate
property value for this disposition schedule.dateValue
- a Date
value. This entry can be null
.java.lang.String getCutoffBase()
Date
-type property that defines
the cutoff base for this DispositionSchedule
.String
defining the property's symbolic name.void setCutoffBase(java.lang.String propertySymbolicName)
propertySymbolicName
- the property symbolic name String
.DispositionAction getCutoffAction()
DispositionAction
instance that defines
the Cutoff action for this DispositionSchedule
.DispositionAction
instance.void setCutoffAction(DispositionAction action)
DispositionAction
that defines the
Cutoff action for this DispositionSchedule
.action
- a DispositionAction
instance.java.lang.String getDispositionAuthority()
AuthorizingStatute
property value of this disposition schedule.String
value. This entry can be null
.void setDispositionAuthority(java.lang.String value)
AuthorizingStatute
property value for this disposition schedule.value
- a String
value. This entry can be null
or blank.java.lang.Integer[] getDispositionEventOffset()
Integer
values that define
the cutoff event offset time period in years, months and days,
respectively.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 setDispositionEventOffset(java.lang.Integer years, java.lang.Integer months, java.lang.Integer days)
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
.DispositionTrigger getDispositionTrigger()
DispositionTrigger
instance.void setDispositionTigger(DispositionTrigger trigger)
DispositionSchedule
instance.trigger
- a DispositionTrigger
instance.
This entry cannot be null
.DispositionPhaseList getDispositionPhases()
DispositionPhase
instances
that define this disposition schedule.DispositionPhaseList
instance.DispositionPhase createNewPhase(java.lang.String phaseName)
DispositionPhase
instance that can
be further defined and then added to a DispositionPhaseList
.phaseName
- String name to assign to the new phase.
This entry cannot be null
or blank.DispositionPhase
instance.DispositionPhase createNewPhase(java.lang.String phaseName, java.lang.String idStr)
DispositionPhase
instance that can
be further defined and then added to a DispositionPhaseList
.phaseName
- String name to assign to the new phase.
This entry cannot be null
or blank.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.DispositionPhase
instance.java.util.List<RecordCategory> getAssociatedRecordCategories()
RecordCategory
instances to
which this DispositionSchedule
instance is
directly associated.List
of RecordCategory
instances.java.util.List<RecordFolder> getAssociatedRecordFolders()
RecordFolder
instances to
which this DispositionSchedule
instance is
directly associated.List
of RecordFolder
instances.java.util.List<RecordType> getAssociatedRecordTypes()
RecordType
instances to
which this DispositionSchedule
instance is
directly associated.List
of RecordType
instances.java.util.Date getEffectiveDateModified()
EffectiveDateModified
property value of this disposition schedule.Date
value. This entry can be null
.java.lang.Boolean isScreeningRequired()
IsScreeningRequired
property value of this disposition schedule.Boolean
value. This entry can be null
.void setScreeningRequired(java.lang.Boolean value)
IsScreeningRequired
property value for this disposition schedule.value
- a Boolean
value. This entry can be null
.java.lang.Boolean isTriggerChanged()
IsTriggerChanged
property value of this disposition schedule.Boolean
value. This entry can be null
.java.lang.String getReasonForChange()
ReasonForChange
property value of this disposition schedule.String
value. This entry can be null
.void setReasonForChange(java.lang.String reason)
ReasonForChange
property.
A non-null, non-blank ReasonForChange value is required when
performing any update to an existing schedule.reason
- A String
value. This entry should not be null
or blank when an update is being performed.java.lang.String getAuditXML()
SweepAuditXML
property value of this disposition schedule.String
value. This entry can be null
.java.lang.Integer getSweepState()
SweepState
property value of this disposition schedule.Integer
value. This entry can be null
.void recalculateCutoffDate(Dispositionable entity)
entity
- the Dispositionable
entity to perform
update calculation for.API_ENTITY_MISSING_CUTOFF_BASE_DATE
- if the applicable cutoff base date is null
.API_DISPOSITION_TRIGGER_INVALID_TRIGGER_TYPE
- if cutoff disposition trigger is an invalid trigger type.© Copyright IBM Corp. 2010, 2013. All Rights Reserved.