Interface | osid.room.squatting.LeaseSmartCampusSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
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 associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartCampuses | ||
Description |
Tests if this user can manage smart campuses. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart campus management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLeaseQuery | ||
Description |
Gets a lease query. | ||
Return | osid.room.squatting.LeaseQuery | the lease query | |
Compliance | mandatory | This method must be implemented. | |
Method | getLeaseSearchOrder | ||
Description |
Gets a lease search order. | ||
Return | osid.room.squatting.LeaseSearchOrder | the lease search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyLeaseQuery | ||
Description |
Applies a lease query to this campus. | ||
Parameters | osid.room.squatting.LeaseQuery | leaseQuery | the lease query |
Errors | NULL_ARGUMENT | leaseQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | leaseQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectLeaseQuery | ||
Description |
Gets a lease query inspector for this campus. | ||
Return | osid.room.squatting.LeaseQueryInspector | the lease query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyLeaseSequencing | ||
Description |
Applies a lease search order to this campus. | ||
Parameters | osid.room.squatting.LeaseSearchOrder | leaseSearchOrder | the lease search order |
Errors | NULL_ARGUMENT | leaseSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | leaseSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLeaseQueryFromInspector | ||
Description |
Gets a lease query from an inspector. | ||
Parameters | osid.room.squatting.LeaseQueryInspector | leaseQueryInspector | a query inspector |
Return | osid.room.squatting.LeaseQuery | the lease query | |
Errors | NULL_ARGUMENT | leaseQueryInspector is null | |
UNSUPPORTED | leaseQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |