public interface Lease extends OsidRelationship
A Lease
represents a collection of rooms with a
Deed.
Modifier and Type | Method and Description |
---|---|
LeaseRecord |
getLeaseRecord(Type leaseRecordType)
Gets the lease record corresponding to the given
Lease
record Type. |
Room |
getRoom()
Gets the room.
|
Id |
getRoomId()
Gets the
Id of the room. |
Resource |
getTenant()
Gets the tenant resource.
|
Id |
getTenantId()
Gets the
Id of the tenant resource. |
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getRoomId()
Id
of the room. Id
mandatory
- This method must be implemented. Room getRoom() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getTenantId()
Id
of the tenant resource. Id
mandatory
- This method must be implemented. Resource getTenant() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. LeaseRecord getLeaseRecord(Type leaseRecordType) throws OperationFailedException
Lease
record Type.
This method is used to retrieve an object
implementing the requested record. The leaseRecordType
may be the Type
returned in getRecordTypes()
or any of its parents in a Type
hierarchy where
hasRecordType(leaseRecordType)
is true
.leaseRecordType
- the type of lease record to retrieveNullArgumentException
- leaseRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(leaseRecordType)
is false
mandatory
- This method must be implemented.