Interface | osid.room.construction.RenovationLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
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 | canLookupRenovations | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeRenovationView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryRenovationView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedCampusView | ||
Description |
Federates the view for methods in this session. A federated view will include renovations in campuses which are children of this campus in the campus hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCampusView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useEffectiveRenovationView | ||
Description |
Only renovations whose effective dates are current are returned by methods in this session | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveRenovationView | ||
Description |
Renovations of any effective dates are returned by all methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRenovation | ||
Description |
Gets the In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.id.Id | renovationId | Id of the Renovation |
Return | osid.room.construction.Renovation | the renovation | |
Errors | NOT_FOUND | renovationId not found | |
NULL_ARGUMENT | renovationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRenovationsByIds | ||
Description |
Gets a In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.id.IdList | renovationIds | the list of Ids to retrieve |
Return | osid.room.construction.RenovationList | the returned Renovation list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | renovationIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsByGenusType | ||
Description |
Gets a In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.type.Type | renovationGenusType | a renovation genus type |
Return | osid.room.construction.RenovationList | the returned Renovation list | |
Errors | NULL_ARGUMENT | renovationGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsByParentGenusType | ||
Description |
Gets a In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.type.Type | renovationGenusType | a renovation genus type |
Return | osid.room.construction.RenovationList | the returned Renovation list | |
Errors | NULL_ARGUMENT | renovationGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsByRecordType | ||
Description |
Gets a In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.type.Type | renovationRecordType | a renovation record type |
Return | osid.room.construction.RenovationList | the returned Renovation list | |
Errors | NULL_ARGUMENT | renovationRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsOnDate | ||
Description |
Gets a list of all renovations effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.calendaring.DateTime | from | start of date range |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.room.construction.RenovationList | the returned RenovationList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsByGenusTypeOnDate | ||
Description |
Gets a list of all renovations of a genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.type.Type | renovationGenusType | a renovation genus type |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.room.construction.RenovationList | the returned RenovationList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | renovationGenusType, from or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsForRoom | ||
Description |
Gets a list of all renovations corresponding to a room
In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.id.Id | roomId | the Id of the room |
Return | osid.room.construction.RenovationList | the returned RenovationList | |
Errors | NULL_ARGUMENT | roomId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsByGenusTypeForRoom | ||
Description |
Gets a list of all renovations corresponding to a room and renovation genus type. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.id.Id | roomId | a room Id |
osid.type.Type | renovationGenusType | a renovation genus type | |
Return | osid.room.construction.RenovationList | the returned RenovationList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | roomId or renovationGenusType is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsForRoomOnDate | ||
Description |
Gets a list of all renovations for a room with an effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.id.Id | roomId | a room Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.room.construction.RenovationList | the returned RenovationList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | roomId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsByGenusTypeForRoomOnDate | ||
Description |
Gets a list of all renovations for a room and of a renovation genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.id.Id | roomId | a room Id |
osid.type.Type | renovationGenusType | a renovation genus type | |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.room.construction.RenovationList | the returned RenovationList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | roomId, renovationGenusType, from or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsForFloor | ||
Description |
Gets a list of all renovations on a floor In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.id.Id | floorId | the Id of the floor |
Return | osid.room.construction.RenovationList | the returned RenovationList | |
Errors | NULL_ARGUMENT | floorId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsByGenusTypeForFloor | ||
Description |
Gets a list of all renovations on a floor and of a renovation genus type. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.id.Id | floorId | a floor Id |
osid.type.Type | renovationGenusType | a renovation genus type | |
Return | osid.room.construction.RenovationList | the returned RenovationList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | floorId or renovationGenusType is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsForFloorOnDate | ||
Description |
Gets a list of all renovations on a floor with an effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.id.Id | floorId | a floor Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.room.construction.RenovationList | the returned RenovationList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | floorId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsByGenusTypeForFloorOnDate | ||
Description |
Gets a list of all renovations on a floor and of a renovation genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.id.Id | floorId | a floor Id |
osid.type.Type | renovationGenusType | a renovation genus type | |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.room.construction.RenovationList | the returned RenovationList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | floorId, renovationGenusType, from, or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsForBuilding | ||
Description |
Gets a list of all renovations in a building. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.id.Id | buildingId | the Id of the building |
Return | osid.room.construction.RenovationList | the returned RenovationList | |
Errors | NULL_ARGUMENT | buildingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsByGenusTypeForBuilding | ||
Description |
Gets a list of all renovations in a building and of a renovation genus type. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.id.Id | buildingId | a building Id |
osid.type.Type | renovationGenusType | a renovation genus type | |
Return | osid.room.construction.RenovationList | the returned RenovationList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | buildingId or renovationGenusType is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsForBuildingOnDate | ||
Description |
Gets a list of all renovations in a building with an effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.id.Id | buildingId | a building Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.room.construction.RenovationList | the returned RenovationList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | buildingId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovationsByGenusTypeForBuildingOnDate | ||
Description |
Gets a list of all renovations in a building and of a renovation genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Parameters | osid.id.Id | buildingId | a building Id |
osid.type.Type | renovationGenusType | a renovation genus type | |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.room.construction.RenovationList | the returned RenovationList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | buildingId, renovationGenusType, from or to
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRenovations | ||
Description |
Gets all In plenary mode, the returned list contains all known renovations or an error results. Otherwise, the returned list may contain only those renovations that are accessible through this session. In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned. | ||
Return | osid.room.construction.RenovationList | a list of Renovations | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |