Interface Lease

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
public interface Lease extends OsidRelationship

A Lease relates a tenant to a Roo m.

  • Method Details

    • getRoomId

      Id getRoomId()
      Gets the Id of the room.
      Returns:
      the room Id
      Compliance:
      mandatory - This method must be implemented.

    • getRoom

      Room getRoom() throws OperationFailedException
      Gets the room.
      Returns:
      the room
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getTenantId

      Id getTenantId()
      Gets the Id of the tenant resource.
      Returns:
      the tenant Id
      Compliance:
      mandatory - This method must be implemented.

    • getTenant

      Resource getTenant() throws OperationFailedException
      Gets the tenant resource.
      Returns:
      the resource
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getLeaseRecord

      LeaseRecord getLeaseRecord(Type leaseRecordType) throws OperationFailedException
      Gets the lease record corresponding to the given 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 .
      Parameters:
      leaseRecordType - the type of lease record to retrieve
      Returns:
      the lease record
      Throws:
      NullArgumentException - leaseRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(leaseRecordType) is false
      Compliance:
      mandatory - This method must be implemented.