org.osid.room.construction

Interface RoomConstructionManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, RoomConstructionProfile, Sourceable

public interface RoomConstructionManager
extends OsidManager, RoomConstructionProfile

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 Summary

Methods

Modifier and Type	Method and Description
ProjectAdminSession	getProjectAdminSession() Gets the OsidSession associated with the project administrative service.
ProjectAdminSession	getProjectAdminSessionForCampus(Id campusId) Gets the OsidSession associated with the project administrative service for the given campus.
ProjectCampusAssignmentSession	getProjectCampusAssignmentSession() Gets the session for assigning project to campus mappings.
ProjectCampusSession	getProjectCampusSession() Gets the session for retrieving project to campus mappings.
ProjectLookupSession	getProjectLookupSession() Gets the OsidSession associated with the project lookup service.
ProjectLookupSession	getProjectLookupSessionForCampus(Id campusId) Gets the OsidSession associated with the project lookup service for the given campus.
ProjectNotificationSession	getProjectNotificationSession(ProjectReceiver ProjectReceiver) Gets the OsidSession associated with the project notification service.
ProjectNotificationSession	getProjectNotificationSessionForCampus(ProjectReceiver ProjectReceiver, Id campusId) Gets the OsidSession associated with the project notification service for the given campus.
ProjectQuerySession	getProjectQuerySession() Gets the OsidSession associated with the project query service.
ProjectQuerySession	getProjectQuerySessionForCampus(Id campusId) Gets the OsidSession associated with the project query service for the given campus.
ProjectSearchSession	getProjectSearchSession() Gets the OsidSession associated with the project search service.
ProjectSearchSession	getProjectSearchSessionForCampus(Id campusId) Gets the OsidSession associated with the project search service for the given campus.
ProjectSmartCampusSession	getProjectSmartCampusSession(Id campusId) Gets the session associated with the project smart campus for the given campus.
RenovationAdminSession	getRenovationAdminSession() Gets the OsidSession associated with the renovation administrative service.
RenovationAdminSession	getRenovationAdminSessionForCampus(Id campusId) Gets the OsidSession associated with the renovation administrative service for the given campus.
RenovationCampusAssignmentSession	getRenovationCampusAssignmentSession() Gets the session for assigning renovation to campus mappings.
RenovationCampusSession	getRenovationCampusSession() Gets the session for retrieving renovation to campus mappings.
RenovationLookupSession	getRenovationLookupSession() Gets the OsidSession associated with the renovation lookup service.
RenovationLookupSession	getRenovationLookupSessionForCampus(Id campusId) Gets the OsidSession associated with the renovation lookup service for the given campus.
RenovationNotificationSession	getRenovationNotificationSession(RenovationReceiver renovationReceiver) Gets the OsidSession associated with the renovation notification service.
RenovationNotificationSession	getRenovationNotificationSessionForCampus(RenovationReceiver renovationReceiver, Id campusId) Gets the OsidSession associated with the renovation notification service for the given campus.
RenovationQuerySession	getRenovationQuerySession() Gets the OsidSession associated with the renovation query service.
RenovationQuerySession	getRenovationQuerySessionForCampus(Id campusId) Gets the OsidSession associated with the renovation query service for the given campus.
RenovationSearchSession	getRenovationSearchSession() Gets the OsidSession associated with the renovation search service.
RenovationSearchSession	getRenovationSearchSessionForCampus(Id campusId) Gets the OsidSession associated with the renovation search service for the given campus.
RenovationSmartCampusSession	getRenovationSmartCampusSession(Id campusId) Gets the session associated with the renovation smart campus for the given campus.
RoomConstructionBatchManager	getRoomConstructionBatchManager() Gets a RoomConstructionBatchManager.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.room.construction.RoomConstructionProfile

getProjectRecordTypes, getProjectSearchRecordTypes, getRenovationRecordTypes, getRenovationSearchRecordTypes, supportsProjectAdmin, supportsProjectCampus, supportsProjectCampusAssignment, supportsProjectLookup, supportsProjectNotification, supportsProjectQuery, supportsProjectRecordType, supportsProjectSearch, supportsProjectSearchRecordType, supportsProjectSmartCampus, supportsRenovationAdmin, supportsRenovationCampus, supportsRenovationCampusAssignment, supportsRenovationLookup, supportsRenovationNotification, supportsRenovationQuery, supportsRenovationRecordType, supportsRenovationSearch, supportsRenovationSearchRecordType, supportsRenovationSmartCampus, supportsRoomConstructionBatch, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getRenovationLookupSession

RenovationLookupSession getRenovationLookupSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the renovation lookup service.

Returns:

a RenovationLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRenovationLookup() is false

Compliance:

optional - This method must be implemented if supportsRenovationLookup() is true.

getRenovationLookupSessionForCampus

RenovationLookupSession getRenovationLookupSessionForCampus(Id campusId)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

campusId - the Id of the Renovation

Returns:

a RenovationLookupSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRenovationLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRenovationLookup() and supportsVisibleFederation() are true

getRenovationQuerySession

RenovationQuerySession getRenovationQuerySession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the renovation query service.

Returns:

a RenovationQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRenovationQuery() is false

Compliance:

optional - This method must be implemented if supportsRenovationQuery() is true.

getRenovationQuerySessionForCampus

RenovationQuerySession getRenovationQuerySessionForCampus(Id campusId)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

campusId - the Id of the Renovation

Returns:

a RenovationQuerySession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRenovationQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRenovationQuery() and supportsVisibleFederation() are true

getRenovationSearchSession

RenovationSearchSession getRenovationSearchSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the renovation search service.

Returns:

a RenovationSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRenovationSearch() is false

Compliance:

optional - This method must be implemented if supportsRenovationSearch() is true.

getRenovationSearchSessionForCampus

RenovationSearchSession getRenovationSearchSessionForCampus(Id campusId)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

campusId - the Id of the Renovation

Returns:

a RenovationSearchSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRenovationSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRenovationSearch() and supportsVisibleFederation() are true

getRenovationAdminSession

RenovationAdminSession getRenovationAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the renovation administrative service.

Returns:

a RenovationAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRenovationAdmin() is false

Compliance:

optional - This method must be implemented if supportsRenovationAdmin() is true.

getRenovationAdminSessionForCampus

RenovationAdminSession getRenovationAdminSessionForCampus(Id campusId)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

campusId - the Id of the Renovation

Returns:

a RenovationAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRenovationAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRenovationAdmin() and supportsVisibleFederation() are true

getRenovationNotificationSession

RenovationNotificationSession getRenovationNotificationSession(RenovationReceiver renovationReceiver)
                                                               throws OperationFailedException

Gets the OsidSession associated with the renovation notification service.

Parameters:

renovationReceiver - the receiver

Returns:

a RenovationNotificationSession

Throws:

NullArgumentException - renovationReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRenovationNotification() is false

Compliance:

optional - This method must be implemented if supportsRenovationNotification() is true.

getRenovationNotificationSessionForCampus

RenovationNotificationSession getRenovationNotificationSessionForCampus(RenovationReceiver renovationReceiver,
                                                                      Id campusId)
                                                                        throws NotFoundException,
                                                                               OperationFailedException

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

Parameters:

renovationReceiver - the receiver

campusId - the Id of the Campus

Returns:

a RenovationNotificationSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - renovationReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRenovationNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRenovationNotification() and supportsVisibleFederation() are true

getRenovationCampusSession

RenovationCampusSession getRenovationCampusSession()
                                                   throws OperationFailedException

Gets the session for retrieving renovation to campus mappings.

Returns:

a RenovationCampusSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRenovationCampus() is false

Compliance:

optional - This method must be implemented if supportsRenovationCampus() is true.

getRenovationCampusAssignmentSession

RenovationCampusAssignmentSession getRenovationCampusAssignmentSession()
                                                                       throws OperationFailedException

Gets the session for assigning renovation to campus mappings.

Returns:

a RenovationCampusAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRenovationCampusAssignment() is false

Compliance:

optional - This method must be implemented if supportsRenovationCampusAssignment() is true.

getRenovationSmartCampusSession

RenovationSmartCampusSession getRenovationSmartCampusSession(Id campusId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the session associated with the renovation smart campus for the given campus.

Parameters:

campusId - the Id of the campus

Returns:

a RenovationSmartCampusSession

Throws:

NotFoundException - campusId not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRenovationSmartCampus() is false

Compliance:

optional - This method must be implemented if supportsRenovationSmartCampus() is true.

getProjectLookupSession

ProjectLookupSession getProjectLookupSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the project lookup service.

Returns:

a ProjectLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectLookup() is false

Compliance:

optional - This method must be implemented if supportsProjectLookup() is true.

getProjectLookupSessionForCampus

ProjectLookupSession getProjectLookupSessionForCampus(Id campusId)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

campusId - the Id of the Project

Returns:

a ProjectLookupSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProjectLookup() and supportsVisibleFederation() are true

getProjectQuerySession

ProjectQuerySession getProjectQuerySession()
                                           throws OperationFailedException

Gets the OsidSession associated with the project query service.

Returns:

a ProjectQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectQuery() is false

Compliance:

optional - This method must be implemented if supportsProjectQuery() is true.

getProjectQuerySessionForCampus

ProjectQuerySession getProjectQuerySessionForCampus(Id campusId)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

campusId - the Id of the Project

Returns:

a ProjectQuerySession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProjectQuery() and supportsVisibleFederation() are true

getProjectSearchSession

ProjectSearchSession getProjectSearchSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the project search service.

Returns:

a ProjectSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectSearch() is false

Compliance:

optional - This method must be implemented if supportsProjectSearch() is true.

getProjectSearchSessionForCampus

ProjectSearchSession getProjectSearchSessionForCampus(Id campusId)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

campusId - the Id of the Project

Returns:

a ProjectSearchSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProjectSearch() and supportsVisibleFederation() are true

getProjectAdminSession

ProjectAdminSession getProjectAdminSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the project administrative service.

Returns:

a ProjectAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectAdmin() is false

Compliance:

optional - This method must be implemented if supportsProjectAdmin() is true.

getProjectAdminSessionForCampus

ProjectAdminSession getProjectAdminSessionForCampus(Id campusId)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

campusId - the Id of the Project

Returns:

a ProjectAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProjectAdmin() and supportsVisibleFederation() are true

getProjectNotificationSession

ProjectNotificationSession getProjectNotificationSession(ProjectReceiver ProjectReceiver)
                                                         throws OperationFailedException

Gets the OsidSession associated with the project notification service.

Parameters:

ProjectReceiver - the receiver

Returns:

a ProjectNotificationSession

Throws:

NullArgumentException - ProjectReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectNotification() is false

Compliance:

optional - This method must be implemented if supportsProjectNotification() is true.

getProjectNotificationSessionForCampus

ProjectNotificationSession getProjectNotificationSessionForCampus(ProjectReceiver ProjectReceiver,
                                                                Id campusId)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

ProjectReceiver - the receiver

campusId - the Id of the Campus

Returns:

a ProjectNotificationSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - ProjectReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProjectNotification() and supportsVisibleFederation() are true

getProjectCampusSession

ProjectCampusSession getProjectCampusSession()
                                             throws OperationFailedException

Gets the session for retrieving project to campus mappings.

Returns:

a ProjectCampusSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectCampus() is false

Compliance:

optional - This method must be implemented if supportsProjectCampus() is true.

getProjectCampusAssignmentSession

ProjectCampusAssignmentSession getProjectCampusAssignmentSession()
                                                                 throws OperationFailedException

Gets the session for assigning project to campus mappings.

Returns:

a ProjectCampusAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectCampusAssignment() is false

Compliance:

optional - This method must be implemented if supportsProjectCampusAssignment() is true.

getProjectSmartCampusSession

ProjectSmartCampusSession getProjectSmartCampusSession(Id campusId)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the session associated with the project smart campus for the given campus.

Parameters:

campusId - the Id of the campus

Returns:

a ProjectSmartCampusSession

Throws:

NotFoundException - campusId not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectSmartCampus() is false

Compliance:

optional - This method must be implemented if supportsProjectSmartCampus() is true.

getRoomConstructionBatchManager

RoomConstructionBatchManager getRoomConstructionBatchManager()
                                                             throws OperationFailedException

Gets a RoomConstructionBatchManager.

Returns:

a RoomConstructionBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomBatchConstruction() is false

Compliance:

optional - This method must be implemented if supportsRoomConstructionBatch() is true.