OSID Logo
OSID Specifications
room construction package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.construction.RenovationLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving Renovation objects. The Renovation represents a work project to a room or set of rooms.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated campus view: All renovation methods in this session operate, retrieve and pertain to renovations defined explicitly in the current campus. Using an isolated view is useful for managing renovations with the RenovationAdminSession.
  • federated campus view: All renovation lookup methods in this session operate, retrieve and pertain to all renovations defined in this campus and any other campuses implicitly available in this campus through campus inheritence.
  • effective renovation view: All renovation lookup methods return effective renovations.
  • any effective renovation view: Renovations of any effective date are returned.
MethodgetCampusId
Description

Gets the Campus Id associated with this session.

Returnosid.id.Idthe Campus Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCampus
Description

Gets the Campus associated with this session.

Returnosid.room.Campusthe campus
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupRenovations
Description

Tests if this user can perform Renovation lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeRenovationView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryRenovationView
Description

A complete view of the Renovation returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedCampusView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCampusView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.

CompliancemandatoryThis method is must be implemented.
MethoduseEffectiveRenovationView
Description

Only renovations whose effective dates are current are returned by methods in this session

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveRenovationView
Description

Renovations of any effective dates are returned by all methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetRenovation
Description

Gets the Renovation specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Renovation may have a different Id than requested, such as the case where a duplicate Id was assigned to a Renovation and retained for compatibility.

In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.

Parametersosid.id.IdrenovationId Id of the Renovation
Returnosid.room.construction.Renovationthe renovation
ErrorsNOT_FOUND renovationId not found
NULL_ARGUMENT renovationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetRenovationsByIds
Description

Gets a RenovationList corresponding to the given IdList.

In plenary mode, the returned list contains all of the renovations specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Renovations may be omitted from the list and may present the elements in any order including returning a unique set.

In effective mode, renovations are returned that are currently effective. In any effective mode, effective renovations and those currently expired are returned.

Parametersosid.id.IdListrenovationIdsthe list of Ids to retrieve
Returnosid.room.construction.RenovationListthe returned Renovation list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT renovationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsByGenusType
Description

Gets a RenovationList corresponding to the given renovation genus Type which does not include renovations of genus types derived from the specified 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.

Parametersosid.type.TyperenovationGenusTypea renovation genus type
Returnosid.room.construction.RenovationListthe returned Renovation list
ErrorsNULL_ARGUMENT renovationGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsByParentGenusType
Description

Gets a RenovationList corresponding to the given renovation genus Type and include any additional renovations with genus types derived from the specified 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.

Parametersosid.type.TyperenovationGenusTypea renovation genus type
Returnosid.room.construction.RenovationListthe returned Renovation list
ErrorsNULL_ARGUMENT renovationGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsByRecordType
Description

Gets a RenovationList containing the given renovation record 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.

Parametersosid.type.TyperenovationRecordTypea renovation record type
Returnosid.room.construction.RenovationListthe returned Renovation list
ErrorsNULL_ARGUMENT renovationRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsOnDate
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.

Parametersosid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.room.construction.RenovationListthe returned RenovationList
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsByGenusTypeOnDate
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.

Parametersosid.type.TyperenovationGenusTypea renovation genus type
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.room.construction.RenovationListthe returned RenovationList
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT renovationGenusType, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsForRoom
Description

Gets a list of all renovations corresponding to a room Id.

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.

Parametersosid.id.IdroomIdthe Id of the room
Returnosid.room.construction.RenovationListthe returned RenovationList
ErrorsNULL_ARGUMENT roomId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsByGenusTypeForRoom
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.

Parametersosid.id.IdroomIda room Id
osid.type.TyperenovationGenusTypea renovation genus type
Returnosid.room.construction.RenovationListthe returned RenovationList
ErrorsINVALID_ARGUMENT to is less than from
NULL_ARGUMENT roomId or renovationGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsForRoomOnDate
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.

Parametersosid.id.IdroomIda room Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.room.construction.RenovationListthe returned RenovationList
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT roomId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsByGenusTypeForRoomOnDate
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.

Parametersosid.id.IdroomIda room Id
osid.type.TyperenovationGenusTypea renovation genus type
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.room.construction.RenovationListthe returned RenovationList
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT roomId, renovationGenusType, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsForFloor
Description

Gets a list of all renovations on a floor Id.

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.

Parametersosid.id.IdfloorIdthe Id of the floor
Returnosid.room.construction.RenovationListthe returned RenovationList
ErrorsNULL_ARGUMENT floorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsByGenusTypeForFloor
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.

Parametersosid.id.IdfloorIda floor Id
osid.type.TyperenovationGenusTypea renovation genus type
Returnosid.room.construction.RenovationListthe returned RenovationList
ErrorsINVALID_ARGUMENT to is less than from
NULL_ARGUMENT floorId or renovationGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsForFloorOnDate
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.

Parametersosid.id.IdfloorIda floor Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.room.construction.RenovationListthe returned RenovationList
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT floorId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsByGenusTypeForFloorOnDate
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.

Parametersosid.id.IdfloorIda floor Id
osid.type.TyperenovationGenusTypea renovation genus type
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.room.construction.RenovationListthe returned RenovationList
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT floorId, renovationGenusType, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsForBuilding
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.

Parametersosid.id.IdbuildingIdthe Id of the building
Returnosid.room.construction.RenovationListthe returned RenovationList
ErrorsNULL_ARGUMENT buildingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsByGenusTypeForBuilding
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.

Parametersosid.id.IdbuildingIda building Id
osid.type.TyperenovationGenusTypea renovation genus type
Returnosid.room.construction.RenovationListthe returned RenovationList
ErrorsINVALID_ARGUMENT to is less than from
NULL_ARGUMENT buildingId or renovationGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsForBuildingOnDate
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.

Parametersosid.id.IdbuildingIda building Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.room.construction.RenovationListthe returned RenovationList
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT buildingId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsByGenusTypeForBuildingOnDate
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.

Parametersosid.id.IdbuildingIda building Id
osid.type.TyperenovationGenusTypea renovation genus type
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.room.construction.RenovationListthe returned RenovationList
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT buildingId, renovationGenusType, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRenovations
Description

Gets all Renovations.

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.

Returnosid.room.construction.RenovationLista list of Renovations
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.