Interface | osid.room.squatting.LeaseAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | getCampusId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Campus Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCampus | ||
Description |
Gets the | ||
Return | osid.room.Campus | the campus | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateLeases | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Lease creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateLeaseWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | leaseRecordTypes | array of lease record types |
Return | boolean | true if Lease creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | leaseRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getLeaseFormForCreate | ||
Description |
Gets the lease form for creating new leases. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | roomId | a room Id |
osid.id.Id | resourceId | a tenant resource Id | |
osid.type.Type[] | leaseRecordTypes | array of lease record types | |
Return | osid.room.squatting.LeaseForm | the lease form | |
Errors | NOT_FOUND | roomId or resourceId is not found | |
NULL_ARGUMENT | roomId, resourceId, or leaseRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get from for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createLease | ||
Description |
Creates a new | ||
Parameters | osid.room.squatting.LeaseForm | leaseForm | the form for this Lease |
Return | osid.room.squatting.Lease | the new Lease | |
Errors | ILLEGAL_STATE | leaseForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | leaseForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | leaseForm did not originate from
getLeaseFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateLeases | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Lease modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLeaseFormForUpdate | ||
Description |
Gets the lease form for updating an existing lease. A new lease form should be requested for each update transaction. | ||
Parameters | osid.id.Id | leaseId | the Id of the Lease |
Return | osid.room.squatting.LeaseForm | the lease form | |
Errors | NOT_FOUND | leaseId is not found | |
NULL_ARGUMENT | leaseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateLease | ||
Description |
Updates an existing lease. | ||
Parameters | osid.room.squatting.LeaseForm | leaseForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | leaseForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | leaseForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | leaseForm did not originate from
getLeaseFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteLeases | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Lease deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteLease | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | leaseId | the Id of the Lease to remove |
Errors | NOT_FOUND | leaseId not found | |
NULL_ARGUMENT | leaseId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageLeaseAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Lease aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasLease | ||
Description |
Adds an | ||
Parameters | osid.id.Id | leaseId | the Id of a Lease |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | leaseId not found | ||
NULL_ARGUMENT | leaseId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |