OSID - osid.room.construction.RoomConstructionManager Service Interface Definition

Interface	osid.room.construction.RoomConstructionManager
Implements	`osid.OsidManager`
Implements	`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. 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.
Method	getRenovationLookupSession
Description	Gets the `OsidSession` associated with the renovation lookup service.
Return	`osid.room.construction.RenovationLookupSession`		a `RenovationLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRenovationLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRenovationLookup()` is `true.`
Method	getRenovationLookupSessionForCampus
Description	Gets the `OsidSession` associated with the renovation lookup service for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Renovation`
Return	`osid.room.construction.RenovationLookupSession`		a `RenovationLookupSession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRenovationLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRenovationLookup()` and `supportsVisibleFederation()` are `true`
Method	getRenovationQuerySession
Description	Gets the `OsidSession` associated with the renovation query service.
Return	`osid.room.construction.RenovationQuerySession`		a `RenovationQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRenovationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRenovationQuery()` is `true.`
Method	getRenovationQuerySessionForCampus
Description	Gets the `OsidSession` associated with the renovation query service for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Renovation`
Return	`osid.room.construction.RenovationQuerySession`		a `RenovationQuerySession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRenovationQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRenovationQuery()` and `supportsVisibleFederation()` are `true`
Method	getRenovationSearchSession
Description	Gets the `OsidSession` associated with the renovation search service.
Return	`osid.room.construction.RenovationSearchSession`		a `RenovationSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRenovationSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRenovationSearch()` is `true.`
Method	getRenovationSearchSessionForCampus
Description	Gets the `OsidSession` associated with the renovation search service for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Renovation`
Return	`osid.room.construction.RenovationSearchSession`		a `RenovationSearchSession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRenovationSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRenovationSearch()` and `supportsVisibleFederation()` are `true`
Method	getRenovationAdminSession
Description	Gets the `OsidSession` associated with the renovation administrative service.
Return	`osid.room.construction.RenovationAdminSession`		a `RenovationAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRenovationAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRenovationAdmin()` is `true.`
Method	getRenovationAdminSessionForCampus
Description	Gets the `OsidSession` associated with the renovation administrative service for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Renovation`
Return	`osid.room.construction.RenovationAdminSession`		a `RenovationAdminSession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRenovationAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRenovationAdmin()` and `supportsVisibleFederation()` are `true`
Method	getRenovationNotificationSession
Description	Gets the `OsidSession` associated with the renovation notification service.
Parameters	`osid.room.construction.RenovationReceiver`	`renovationReceiver`	the receiver
Return	`osid.room.construction.RenovationNotificationSession`		a `RenovationNotificationSession`
Errors	NULL_ARGUMENT		`renovationReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRenovationNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRenovationNotification()` is `true.`
Method	getRenovationNotificationSessionForCampus
Description	Gets the `OsidSession` associated with the renovation notification service for the given campus.
Parameters	`osid.room.construction.RenovationReceiver`	`renovationReceiver`	the receiver
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Campus`
Return	`osid.room.construction.RenovationNotificationSession`		a `RenovationNotificationSession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`renovationReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRenovationNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRenovationNotification()` and `supportsVisibleFederation()` are `true`
Method	getRenovationCampusSession
Description	Gets the session for retrieving renovation to campus mappings.
Return	`osid.room.construction.RenovationCampusSession`		a `RenovationCampusSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRenovationCampus()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRenovationCampus()` is `true.`
Method	getRenovationCampusAssignmentSession
Description	Gets the session for assigning renovation to campus mappings.
Return	`osid.room.construction.RenovationCampusAssignmentSession`		a `RenovationCampusAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRenovationCampusAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRenovationCampusAssignment()` is `true.`
Method	getRenovationSmartCampusSession
Description	Gets the session associated with the renovation smart campus for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the campus
Return	`osid.room.construction.RenovationSmartCampusSession`		a `RenovationSmartCampusSession`
Errors	NOT_FOUND		`campusId` not found
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRenovationSmartCampus()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRenovationSmartCampus()` is `true.`
Method	getProjectLookupSession
Description	Gets the `OsidSession` associated with the project lookup service.
Return	`osid.room.construction.ProjectLookupSession`		a `ProjectLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProjectLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProjectLookup()` is `true.`
Method	getProjectLookupSessionForCampus
Description	Gets the `OsidSession` associated with the project lookup service for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Project`
Return	`osid.room.construction.ProjectLookupSession`		a `ProjectLookupSession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProjectLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProjectLookup()` and `supportsVisibleFederation()` are `true`
Method	getProjectQuerySession
Description	Gets the `OsidSession` associated with the project query service.
Return	`osid.room.construction.ProjectQuerySession`		a `ProjectQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProjectQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProjectQuery()` is `true.`
Method	getProjectQuerySessionForCampus
Description	Gets the `OsidSession` associated with the project query service for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Project`
Return	`osid.room.construction.ProjectQuerySession`		a `ProjectQuerySession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProjectQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProjectQuery()` and `supportsVisibleFederation()` are `true`
Method	getProjectSearchSession
Description	Gets the `OsidSession` associated with the project search service.
Return	`osid.room.construction.ProjectSearchSession`		a `ProjectSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProjectSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProjectSearch()` is `true.`
Method	getProjectSearchSessionForCampus
Description	Gets the `OsidSession` associated with the project search service for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Project`
Return	`osid.room.construction.ProjectSearchSession`		a `ProjectSearchSession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProjectSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProjectSearch()` and `supportsVisibleFederation()` are `true`
Method	getProjectAdminSession
Description	Gets the `OsidSession` associated with the project administrative service.
Return	`osid.room.construction.ProjectAdminSession`		a `ProjectAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProjectAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProjectAdmin()` is `true.`
Method	getProjectAdminSessionForCampus
Description	Gets the `OsidSession` associated with the project administrative service for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Project`
Return	`osid.room.construction.ProjectAdminSession`		a `ProjectAdminSession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProjectAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProjectAdmin()` and `supportsVisibleFederation()` are `true`
Method	getProjectNotificationSession
Description	Gets the `OsidSession` associated with the project notification service.
Parameters	`osid.room.construction.ProjectReceiver`	`ProjectReceiver`	the receiver
Return	`osid.room.construction.ProjectNotificationSession`		a `ProjectNotificationSession`
Errors	NULL_ARGUMENT		`ProjectReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProjectNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProjectNotification()` is `true.`
Method	getProjectNotificationSessionForCampus
Description	Gets the `OsidSession` associated with the project notification service for the given campus.
Parameters	`osid.room.construction.ProjectReceiver`	`ProjectReceiver`	the receiver
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Campus`
Return	`osid.room.construction.ProjectNotificationSession`		a `ProjectNotificationSession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`ProjectReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProjectNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProjectNotification()` and `supportsVisibleFederation()` are `true`
Method	getProjectCampusSession
Description	Gets the session for retrieving project to campus mappings.
Return	`osid.room.construction.ProjectCampusSession`		a `ProjectCampusSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProjectCampus()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProjectCampus()` is `true.`
Method	getProjectCampusAssignmentSession
Description	Gets the session for assigning project to campus mappings.
Return	`osid.room.construction.ProjectCampusAssignmentSession`		a `ProjectCampusAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsProjectCampusAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProjectCampusAssignment()` is `true.`
Method	getProjectSmartCampusSession
Description	Gets the session associated with the project smart campus for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the campus
Return	`osid.room.construction.ProjectSmartCampusSession`		a `ProjectSmartCampusSession`
Errors	NOT_FOUND		`campusId` not found
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsProjectSmartCampus()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProjectSmartCampus()` is `true.`
Method	getRoomConstructionBatchManager
Description	Gets a `RoomConstructionBatchManager.`
Return	`osid.room.construction.batch.RoomConstructionBatchManager`		a `RoomConstructionBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRoomBatchConstruction()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRoomConstructionBatch()` is `true.`