Interface | osid.room.construction.RoomConstructionProxyManager | ||
---|---|---|---|
Implements | osid.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
The room construction manager also provides a profile for determing the supported search types supported by this service. | ||
Method | getRenovationLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.room.construction.RenovationLookupSession | a RenovationLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRenovationLookup() is false | ||
Compliance | optional | This method must be implemented if supportsRenovationLookup()
is true. | |
Method | getRenovationLookupSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Campus |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.room.construction.RenovationLookupSession | a RenovationLookupSession | |
Errors | NOT_FOUND | no Campus found by the given Id | |
NULL_ARGUMENT | campusId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.room.construction.RenovationQuerySession | a RenovationQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRenovationQuery() is false | ||
Compliance | optional | This method must be implemented if supportsRenovationQuery()
is true. | |
Method | getRenovationQuerySessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Campus |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.room.construction.RenovationQuerySession | a RenovationQuerySession | |
Errors | NOT_FOUND | no Renovation found by the given Id | |
NULL_ARGUMENT | campusId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.room.construction.RenovationSearchSession | a RenovationSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRenovationSearch() is false | ||
Compliance | optional | This method must be implemented if supportsRenovationSearch()
is true. | |
Method | getRenovationSearchSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Campus |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.room.construction.RenovationSearchSession | a RenovationSearchSession | |
Errors | NOT_FOUND | no Renovation found by the given Id | |
NULL_ARGUMENT | campusId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.room.construction.RenovationAdminSession | a RenovationAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRenovationAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsRenovationAdmin()
is true. | |
Method | getRenovationAdminSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Campus |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.room.construction.RenovationAdminSession | a RenovationAdminSession | |
Errors | NOT_FOUND | no Renovation found by the given Id | |
NULL_ARGUMENT | campusId or proxy 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 | ||
Parameters | osid.room.construction.RenovationReceiver | renovationReceiver | the receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.room.construction.RenovationNotificationSession | a RenovationNotificationSession | |
Errors | NULL_ARGUMENT | renovationReceiver or proxy 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 | ||
Parameters | osid.room.construction.RenovationReceiver | renovationReceiver | the receiver |
osid.id.Id | campusId | the Id of the Campus | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.room.construction.RenovationNotificationSession | a RenovationNotificationSession | |
Errors | NOT_FOUND | no Renovation found by the given Id | |
NULL_ARGUMENT | renovationReceiver, campusId or proxy 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. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.room.construction.RenovationCampusSession | a RenovationCampusSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
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. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.room.construction.RenovationCampusAssignmentSession | a RenovationCampusAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRenovationCampusAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsRenovationCampusAssignment() is true. | |
Method | getRenovationSmartCampusSession | ||
Description |
Gets the session for managing dynamic renovation campuses for the given campus. | ||
Parameters | osid.id.Id | campusId | the Id of a campus |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.room.construction.RenovationSmartCampusSession | a RenovationSmartCampusSession | |
Errors | NOT_FOUND | campusId not found | |
NULL_ARGUMENT | campusId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.room.construction.ProjectLookupSession | a ProjectLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProjectLookup() is false | ||
Compliance | optional | This method must be implemented if supportsProjectLookup()
is true. | |
Method | getProjectLookupSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Campus |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.room.construction.ProjectLookupSession | a ProjectLookupSession | |
Errors | NOT_FOUND | no Campus found by the given Id | |
NULL_ARGUMENT | campusId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.room.construction.ProjectQuerySession | a ProjectQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProjectQuery() is false | ||
Compliance | optional | This method must be implemented if supportsProjectQuery() is
true. | |
Method | getProjectQuerySessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Campus |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.room.construction.ProjectQuerySession | a ProjectQuerySession | |
Errors | NOT_FOUND | no Project found by the given Id | |
NULL_ARGUMENT | campusId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.room.construction.ProjectSearchSession | a ProjectSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProjectSearch() is false | ||
Compliance | optional | This method must be implemented if supportsProjectSearch()
is true. | |
Method | getProjectSearchSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Campus |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.room.construction.ProjectSearchSession | a ProjectSearchSession | |
Errors | NOT_FOUND | no Project found by the given Id | |
NULL_ARGUMENT | campusId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.room.construction.ProjectAdminSession | a ProjectAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProjectAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProjectAdmin() is
true. | |
Method | getProjectAdminSessionForCampus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | campusId | the Id of the Campus |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.room.construction.ProjectAdminSession | a ProjectAdminSession | |
Errors | NOT_FOUND | no Project found by the given Id | |
NULL_ARGUMENT | campusId or proxy 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 | ||
Parameters | osid.room.construction.ProjectReceiver | ProjectReceiver | the receiver |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.room.construction.ProjectNotificationSession | a ProjectNotificationSession | |
Errors | NULL_ARGUMENT | ProjectReceiver or proxy 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 | ||
Parameters | osid.room.construction.ProjectReceiver | ProjectReceiver | the receiver |
osid.id.Id | campusId | the Id of the Campus | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.room.construction.ProjectNotificationSession | a ProjectNotificationSession | |
Errors | NOT_FOUND | no Project found by the given Id | |
NULL_ARGUMENT | ProjectReceiver, campusId or proxy 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. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.room.construction.ProjectCampusSession | a ProjectCampusSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
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. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.room.construction.ProjectCampusAssignmentSession | a ProjectCampusAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProjectCampusAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsProjectCampusAssignment()
is true. | |
Method | getProjectSmartCampusSession | ||
Description |
Gets the session for managing dynamic project campuses for the given campus. | ||
Parameters | osid.id.Id | campusId | the Id of a campus |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.room.construction.ProjectSmartCampusSession | a ProjectSmartCampusSession | |
Errors | NOT_FOUND | campusId not found | |
NULL_ARGUMENT | campusId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProjectSmartCampus() is false | ||
Compliance | optional | This method must be implemented if supportsProjectSmartCampus()
is true. | |
Method | getRoomConstructionBatchProxyManager | ||
Description |
Gets a | ||
Return | osid.room.construction.batch.RoomConstructionBatchProxyManager | a RoomConstructionBatchProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRoomConstructionBatch() is false | ||
Compliance | optional | This method must be implemented if supportsRoomConstructionBatch()
is true. |