public interface DispositionTrigger extends RMCustomObject
A specific disposition trigger can be obtained using the
RMFactory.DispositionTrigger
factory class.
A new disposition trigger can be created using the factory class
method RMFactory.DispositionTrigger#createInstance
.
The resulting new DispositionTrigger
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.DispositionTrigger
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAggregation()
Returns a string describing the entity-type level to which
this disposition trigger applies.
|
java.util.List<DispositionSchedule> |
getAssociatedDispositionSchedules()
Returns a collection of
DispositionSchedule instances where
this DispositionTrigger is currently associated. |
java.lang.String |
getConditionXML()
Returns an XML string fragment describing the condition defined
for this disposition trigger.
|
java.util.Date |
getDateTime()
Returns a
Date value for the disposition trigger's DateTime property, if any. |
java.lang.String |
getDescription()
Returns the
RMEntityDescription property value of this disposition trigger. |
java.util.Date |
getExternalEventOccurrenceDate()
Returns a
Date value for the disposition trigger's ExternalEventOccurrenceDate property. |
java.lang.Integer |
getOperator()
Returns the value of the
Operator property for this disposition trigger. |
java.lang.String |
getPropertyName()
Returns the
PropertyName property value of this disposition trigger. |
java.lang.String |
getPropertyValue()
Returns the value of the
PropertyValue property for this disposition trigger. |
java.lang.Integer[] |
getRecurringCyclePeriod()
Returns the three
Integer values that define
the recurring cycle period in years, months and days,
respectively, for a recurring trigger. |
java.lang.String |
getTriggerName()
Returns the
DisposalTriggerName property value of this disposition trigger. |
DispositionTriggerType |
getTriggerType()
Returns the
DispositionTriggerType enum value that defines the general
category of trigger type of this instance. |
void |
setAggregation(java.lang.String aggregation)
Defines the required entity-type level to which this disposition trigger
applies.
|
void |
setConditionXML(java.lang.String xmlFragment)
Sets an XML string fragment that describes the condition defined for
this disposition trigger.
|
void |
setDateTime(java.util.Date dateValue)
Sets the value of the
DateTime property for this disposition trigger. |
void |
setDescription(java.lang.String value)
Sets the
RMEntityDescription property value for this disposition trigger. |
void |
setExternalEventOccurrenceDate(java.util.Date dateValue)
Sets a
Date value for the disposition trigger's ExternalEventOccurrenceDate property. |
void |
setOperator(java.lang.Integer value)
Sets the value of the
Operator property for this disposition trigger. |
void |
setPropertyName(java.lang.String propSymbolicName)
Sets the value of the
PropertyName property for this disposition trigger. |
void |
setPropertyValue(java.lang.String value)
Sets the value of the
PropertyValue property for this disposition trigger. |
void |
setRecurringCyclePeriod(java.lang.Integer years,
java.lang.Integer months,
java.lang.Integer days)
Sets the recurring cycle period for a recurring trigger.
|
void |
setTriggerName(java.lang.String triggerName)
Sets the
DisposalTriggerName property value. |
delete
getAccessAllowed, getClassDescription, getClassName, getClientIdentifier, getContainedBy, getDomainType, getEntityType, getName, getObjectIdentity, getPermissions, getProperties, getRepository, isCreationPending, isPlaceholder, refresh, refresh, refresh
save, setPermissions
getAuditedEvents
java.lang.String getTriggerName()
DisposalTriggerName
property value of this disposition trigger.String
value.void setTriggerName(java.lang.String triggerName)
DisposalTriggerName
property value.
This value must be unique amongst existing disposition triggers
on a given file plan repository.
Note that uniqueness validation does not occur until the save
is called for disposition trigger instance.
triggerName
- a String
value. This entry cannot be null
.DispositionTriggerType getTriggerType()
DispositionTriggerType
enum value that defines the general
category of trigger type of this instance.
Note that this property is indirectly set by the
RMFactory.DispositionTrigger.createInstance
method.
DispositionTriggerType
value.java.lang.String getDescription()
RMEntityDescription
property value of this disposition trigger.String
value. This entry can be null
or empty.void setDescription(java.lang.String value)
RMEntityDescription
property value for this disposition trigger.value
- a String
value. This entry can be null
or blank.java.lang.String getAggregation()
String
value.void setAggregation(java.lang.String aggregation)
save
is made).
It can only accept values defined by the "Aggregation" choice list.aggregation
- A String
value corresponding to a member value of the
"Aggregation" choice list. This entry cannot be null
.java.lang.String getPropertyName()
PropertyName
property value of this disposition trigger.String
value. This entry can be null
or empty.void setPropertyName(java.lang.String propSymbolicName)
PropertyName
property for this disposition trigger.propSymbolicName
- a String
value. This entry can be null
.java.lang.String getPropertyValue()
PropertyValue
property for this disposition trigger.String
value. This entry can be null
or empty.void setPropertyValue(java.lang.String value)
PropertyValue
property for this disposition trigger.value
- a String
value. This entry can be null
.java.lang.Integer getOperator()
Operator
property for this disposition trigger.Integer
value. This entry can be null
.void setOperator(java.lang.Integer value)
Operator
property for this disposition trigger.value
- an Integer
value. This entry can be null
.java.util.Date getDateTime()
Date
value for the disposition trigger's DateTime
property, if any.Date
value. This entry can be null
.void setDateTime(java.util.Date dateValue)
DateTime
property for this disposition trigger.dateValue
- a Date
value. This entry can be null
.java.lang.Integer[] getRecurringCyclePeriod()
Integer
values that define
the recurring cycle period in years, months and days,
respectively, for a recurring trigger.Integer[]
of a fixed size of three entries.
The first entry represents years. The second entry represents
months. The third entry represents days.void setRecurringCyclePeriod(java.lang.Integer years, java.lang.Integer months, java.lang.Integer days)
null
value greater than 0.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.util.Date getExternalEventOccurrenceDate()
Date
value for the disposition trigger's ExternalEventOccurrenceDate
property.Date
value. This entry can be null
.void setExternalEventOccurrenceDate(java.util.Date dateValue)
Date
value for the disposition trigger's ExternalEventOccurrenceDate
property.dateValue
- a Date
value. This entry can be null
.java.lang.String getConditionXML()
String
XML fragment.void setConditionXML(java.lang.String xmlFragment)
xmlFragment
- a String
value. This entry can be null
.java.util.List<DispositionSchedule> getAssociatedDispositionSchedules()
DispositionSchedule
instances where
this DispositionTrigger is currently associated.List
of DispositionSchedule
instances. This entry can be empty.© Copyright IBM Corp. 2010, 2013. All Rights Reserved.