public interface Hold extends RMCustomObject
Hold
custom object.
A specific hold can be obtained using the RMFactory.Hold
factory class.
All available hold instances for a given file plan repository can
be acquired using the FilePlanRepository.getHolds
method.
A new hold can be created using the factory class
method RMFactory.Hold.createInstance
.
The resulting new Hold
instance can then be further defined
followed by an eventual call to its save
method
in order to ensure that it is persisted to its associated file plan repository.
RMFactory.Hold
Modifier and Type | Method and Description |
---|---|
PageableSet<Container> |
getAssociatedContainers(java.lang.Integer pageSize)
Returns a collection of
Container instances that
are associated with this hold. |
PageableSet<Record> |
getAssociatedRecords(java.lang.Integer pageSize)
Returns a collection of
Record instances that
are associated with this hold. |
java.lang.String |
getConditionXML()
Returns the
ConditionXML property value. |
java.lang.String |
getHoldName()
Returns the
HoldName property value. |
java.lang.String |
getHoldReason()
Returns the
HoldReason property value. |
java.lang.String |
getHoldType()
Returns the
HoldType property value. |
java.lang.Integer |
getSweepState()
Returns the
SweepState property value. |
java.lang.Boolean |
isActive()
Returns a
Boolean value indicating whether the hold is active. |
void |
setActiveState(boolean isActive)
Set the active state for this hold instance.
|
void |
setConditionXML(java.lang.String conditionXML)
Sets the value for the
ConditionXML property value. |
void |
setHoldName(java.lang.String holdName)
Sets the
HoldName property value. |
void |
setHoldReason(java.lang.String reason)
Sets the value for the
HoldReason property value. |
void |
setHoldType(java.lang.String holdType)
Sets the value for the
HoldType property value. |
void |
setSweepState(java.lang.Integer sweepState)
Sets the value for the
SweepState 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 getHoldName()
HoldName
property value.String
value. This entry can be null
.void setHoldName(java.lang.String holdName)
HoldName
property value.
This name value must be unique relative to all other holds
defined on the same file plan repository. Validation of
such name uniqueness does not occur until the
save
is called.
holdName
- a String
value. This entry cannot be null
.java.lang.String getConditionXML()
ConditionXML
property value.
String
value. This entry can be null
.void setConditionXML(java.lang.String conditionXML)
ConditionXML
property value.conditionXML
- a String
value. This entry can be null
or blank.java.lang.Integer getSweepState()
SweepState
property value.Integer
value. This entry can be null
.void setSweepState(java.lang.Integer sweepState)
SweepState
property value.sweepState
- a Integer
value. This entry can be null
.java.lang.String getHoldReason()
HoldReason
property value.String
value. This entry can be null
.void setHoldReason(java.lang.String reason)
HoldReason
property value.reason
- a String
value. This entry can be null
or blank.java.lang.Boolean isActive()
Boolean
value indicating whether the hold is active.true
if the hold is active, false
otherwise.void setActiveState(boolean isActive)
isActive
- true
to activate the hold, false
to deactivate the hold.java.lang.String getHoldType()
HoldType
property value.String
value indicating the type of hold.void setHoldType(java.lang.String holdType)
HoldType
property value.holdType
- a String
value that can be null
or can
be the value of one of the "HoldTypeList" choice list.PageableSet<Record> getAssociatedRecords(java.lang.Integer pageSize)
Record
instances that
are associated with this hold.pageSize
- an optional Integer
page size value. If null
then the repository default value is used.PageableSet
of Record
instances.PageableSet<Container> getAssociatedContainers(java.lang.Integer pageSize)
Container
instances that
are associated with this hold.pageSize
- an optional Integer
page size value. If null
then the repository default value is used.PageableSet
of Container
instances.© Copyright IBM Corp. 2010, 2013. All Rights Reserved.