public interface Location extends RMCustomObject
Location
custom object.
A Location
object is used to represent a physical location
for records and record containers.
A specific location can be obtained using the RMFactory.Location
factory class.
All available location instances for a given file plan repository can
be acquired using the FilePlanRepository.getLocations
method.
A location can be created using the factory class
method RMFactory.Location.createInstance
.
The resulting new Location
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.Location
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBarcode()
Returns the
BarcodeID property value. |
java.lang.String |
getDescription()
Returns the
RMEntityDescription property value. |
java.lang.String |
getLocationName()
Returns the
LocationName property value. |
java.lang.String |
getReviewer()
Returns the
Reviewer property value. |
void |
setBarcode(java.lang.String value)
Sets the
BarcodeId property value. |
void |
setDescription(java.lang.String value)
Sets the
RMEntityDescription property value. |
void |
setLocationName(java.lang.String locationName)
Sets the
LocationName property value. |
void |
setReviewer(java.lang.String value)
Sets the
Reviewer 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 getLocationName()
LocationName
property value.String
value.void setLocationName(java.lang.String locationName)
LocationName
property value.
This name value must be unique relative to all other locations
defined on the same file plan repository. Validation of
such name uniqueness does not occur until the
save
is called.
locationName
- a String
value. Cannot be null
.java.lang.String getDescription()
RMEntityDescription
property value.String
value. This entry can be null
.void setDescription(java.lang.String value)
RMEntityDescription
property value.value
- a String
value. This entry can be null
.java.lang.String getBarcode()
BarcodeID
property value.String
value. This entry can be null
.void setBarcode(java.lang.String value)
BarcodeId
property value.value
- a String
value. This entry can be null
.java.lang.String getReviewer()
Reviewer
property value.String
value. This entry can be null
.void setReviewer(java.lang.String value)
Reviewer
property value.value
- a String
value. This entry can be null
.© Copyright IBM Corp. 2010, 2013. All Rights Reserved.