OSID Logo
OSID Specifications
room construction package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.construction.RoomConstructionProxyManager
Implementsosid.OsidProxyManager
osid.room.construction.RoomConstructionProfile
Description

The room construction manager provides access to room construction sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy for passing information from a server environment. The sessions included in this manager are:

  • RenovationLookupSession: a session to retrieve renovationes
  • RenovationQuerySession: a session to query renovationes
  • RenovationSearchSession: a session to search for renovationes
  • RenovationAdminSession: a session to create, update and delete renovationes
  • RenovationNotificationSession: a session to receive notifications for changes in renovationes
  • RenovationCampusSession: a session to look up renovation campus mappings
  • RenovationCampusAssignmentSession: a session to manage renovation campus mappings
  • RenovationSmartCampusSession: a session to manage smart campuses of renovationes
  • ProjectLookupSession: a session to retrieve projects
  • ProjectQuerySession: a session to query projects
  • ProjectSearchSession: a session to search for projects
  • ProjectAdminSession: a session to create, update and delete projects
  • ProjectNotificationSession: a session to receive notifications for changes in projects
  • ProjectCampusSession: a session to look up project campus mappings
  • ProjectCampusAssignmentSession: a session to manage project campus mappings
  • ProjectSmartCampusSession: a session to manage smart campuses of projects

The room construction manager also provides a profile for determing the supported search types supported by this service.

MethodgetRenovationLookupSession
Description

Gets the OsidSession associated with the renovation lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.construction.RenovationLookupSessiona RenovationLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRenovationLookup() is false
ComplianceoptionalThis method must be implemented if supportsRenovationLookup() is true.
MethodgetRenovationLookupSessionForCampus
Description

Gets the OsidSession associated with the renovation lookup service for the given campus.

Parametersosid.id.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.construction.RenovationLookupSessiona RenovationLookupSession
ErrorsNOT_FOUNDno Campus found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRenovationLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRenovationLookup() and supportsVisibleFederation() are true
MethodgetRenovationQuerySession
Description

Gets the OsidSession associated with the renovation query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.construction.RenovationQuerySessiona RenovationQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRenovationQuery() is false
ComplianceoptionalThis method must be implemented if supportsRenovationQuery() is true.
MethodgetRenovationQuerySessionForCampus
Description

Gets the OsidSession associated with the renovation query service for the given campus.

Parametersosid.id.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.construction.RenovationQuerySessiona RenovationQuerySession
ErrorsNOT_FOUNDno Renovation found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRenovationQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRenovationQuery() and supportsVisibleFederation() are true
MethodgetRenovationSearchSession
Description

Gets the OsidSession associated with the renovation search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.construction.RenovationSearchSessiona RenovationSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRenovationSearch() is false
ComplianceoptionalThis method must be implemented if supportsRenovationSearch() is true.
MethodgetRenovationSearchSessionForCampus
Description

Gets the OsidSession associated with the renovation search service for the given campus.

Parametersosid.id.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.construction.RenovationSearchSessiona RenovationSearchSession
ErrorsNOT_FOUNDno Renovation found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRenovationSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRenovationSearch() and supportsVisibleFederation() are true
MethodgetRenovationAdminSession
Description

Gets the OsidSession associated with the renovation administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.construction.RenovationAdminSessiona RenovationAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRenovationAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRenovationAdmin() is true.
MethodgetRenovationAdminSessionForCampus
Description

Gets the OsidSession associated with the renovation administration service for the given campus.

Parametersosid.id.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.construction.RenovationAdminSessiona RenovationAdminSession
ErrorsNOT_FOUNDno Renovation found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRenovationAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRenovationAdmin() and supportsVisibleFederation() are true
MethodgetRenovationNotificationSession
Description

Gets the OsidSession associated with the renovation notification service.

Parametersosid.room.construction.RenovationReceiverrenovationReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.room.construction.RenovationNotificationSessiona RenovationNotificationSession
ErrorsNULL_ARGUMENT renovationReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRenovationNotification() is false
ComplianceoptionalThis method must be implemented if supportsRenovationNotification() is true.
MethodgetRenovationNotificationSessionForCampus
Description

Gets the OsidSession associated with the renovation notification service for the given campus.

Parametersosid.room.construction.RenovationReceiverrenovationReceiverthe receiver
osid.id.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.construction.RenovationNotificationSessiona RenovationNotificationSession
ErrorsNOT_FOUNDno Renovation found by the given Id
NULL_ARGUMENT renovationReceiver, campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRenovationNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRenovationNotification() and supportsVisibleFederation() are true
MethodgetRenovationCampusSession
Description

Gets the session for retrieving renovation to campus mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.construction.RenovationCampusSessiona RenovationCampusSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRenovationCampus() is false
ComplianceoptionalThis method must be implemented if supportsRenovationCampus() is true.
MethodgetRenovationCampusAssignmentSession
Description

Gets the session for assigning renovation to campus mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.construction.RenovationCampusAssignmentSessiona RenovationCampusAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRenovationCampusAssignment() is false
ComplianceoptionalThis method must be implemented if supportsRenovationCampusAssignment() is true.
MethodgetRenovationSmartCampusSession
Description

Gets the session for managing dynamic renovation campuses for the given campus.

Parametersosid.id.IdcampusIdthe Id of a campus
osid.proxy.Proxyproxya proxy
Returnosid.room.construction.RenovationSmartCampusSessiona RenovationSmartCampusSession
ErrorsNOT_FOUND campusId not found
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRenovationSmartCampus() is false
ComplianceoptionalThis method must be implemented if supportsRenovationSmartCampus() is true.
MethodgetProjectLookupSession
Description

Gets the OsidSession associated with the project lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.construction.ProjectLookupSessiona ProjectLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProjectLookup() is false
ComplianceoptionalThis method must be implemented if supportsProjectLookup() is true.
MethodgetProjectLookupSessionForCampus
Description

Gets the OsidSession associated with the project lookup service for the given campus.

Parametersosid.id.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.construction.ProjectLookupSessiona ProjectLookupSession
ErrorsNOT_FOUNDno Campus found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProjectLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProjectLookup() and supportsVisibleFederation() are true
MethodgetProjectQuerySession
Description

Gets the OsidSession associated with the project query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.construction.ProjectQuerySessiona ProjectQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProjectQuery() is false
ComplianceoptionalThis method must be implemented if supportsProjectQuery() is true.
MethodgetProjectQuerySessionForCampus
Description

Gets the OsidSession associated with the project query service for the given campus.

Parametersosid.id.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.construction.ProjectQuerySessiona ProjectQuerySession
ErrorsNOT_FOUNDno Project found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProjectQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProjectQuery() and supportsVisibleFederation() are true
MethodgetProjectSearchSession
Description

Gets the OsidSession associated with the project search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.construction.ProjectSearchSessiona ProjectSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProjectSearch() is false
ComplianceoptionalThis method must be implemented if supportsProjectSearch() is true.
MethodgetProjectSearchSessionForCampus
Description

Gets the OsidSession associated with the project search service for the given campus.

Parametersosid.id.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.construction.ProjectSearchSessiona ProjectSearchSession
ErrorsNOT_FOUNDno Project found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProjectSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProjectSearch() and supportsVisibleFederation() are true
MethodgetProjectAdminSession
Description

Gets the OsidSession associated with the project administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.construction.ProjectAdminSessiona ProjectAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProjectAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProjectAdmin() is true.
MethodgetProjectAdminSessionForCampus
Description

Gets the OsidSession associated with the project administration service for the given campus.

Parametersosid.id.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.construction.ProjectAdminSessiona ProjectAdminSession
ErrorsNOT_FOUNDno Project found by the given Id
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProjectAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProjectAdmin() and supportsVisibleFederation() are true
MethodgetProjectNotificationSession
Description

Gets the OsidSession associated with the project notification service.

Parametersosid.room.construction.ProjectReceiverProjectReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.room.construction.ProjectNotificationSessiona ProjectNotificationSession
ErrorsNULL_ARGUMENT ProjectReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProjectNotification() is false
ComplianceoptionalThis method must be implemented if supportsProjectNotification() is true.
MethodgetProjectNotificationSessionForCampus
Description

Gets the OsidSession associated with the project notification service for the given campus.

Parametersosid.room.construction.ProjectReceiverProjectReceiverthe receiver
osid.id.IdcampusIdthe Id of the Campus
osid.proxy.Proxyproxya proxy
Returnosid.room.construction.ProjectNotificationSessiona ProjectNotificationSession
ErrorsNOT_FOUNDno Project found by the given Id
NULL_ARGUMENT ProjectReceiver, campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProjectNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProjectNotification() and supportsVisibleFederation() are true
MethodgetProjectCampusSession
Description

Gets the session for retrieving project to campus mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.construction.ProjectCampusSessiona ProjectCampusSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProjectCampus() is false
ComplianceoptionalThis method must be implemented if supportsProjectCampus() is true.
MethodgetProjectCampusAssignmentSession
Description

Gets the session for assigning project to campus mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.room.construction.ProjectCampusAssignmentSessiona ProjectCampusAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProjectCampusAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProjectCampusAssignment() is true.
MethodgetProjectSmartCampusSession
Description

Gets the session for managing dynamic project campuses for the given campus.

Parametersosid.id.IdcampusIdthe Id of a campus
osid.proxy.Proxyproxya proxy
Returnosid.room.construction.ProjectSmartCampusSessiona ProjectSmartCampusSession
ErrorsNOT_FOUND campusId not found
NULL_ARGUMENT campusId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProjectSmartCampus() is false
ComplianceoptionalThis method must be implemented if supportsProjectSmartCampus() is true.
MethodgetRoomConstructionBatchProxyManager
Description

Gets a RoomConstructionBatchProxyManager.

Returnosid.room.construction.batch.RoomConstructionBatchProxyManagera RoomConstructionBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRoomConstructionBatch() is false
ComplianceoptionalThis method must be implemented if supportsRoomConstructionBatch() is true.