Interface RoomConstructionManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getProjectRecordTypes()	Gets the supported Project record types.
TypeList	getProjectSearchRecordTypes()	Gets the supported project search record types.
TypeList	getRenovationRecordTypes()	Gets the supported Renovation record types.
TypeList	getRenovationSearchRecordTypes()	Gets the supported renovation search record types.
boolean	supportsProjectAdmin()	Tests for the availability of a project administrative service for creating and deleting projects.
boolean	supportsProjectCampus()	Tests if a project to campus lookup session is available.
boolean	supportsProjectCampusAssignment()	Tests if a project to campus assignment session is available.
boolean	supportsProjectLookup()	Tests for the availability of a project lookup service.
boolean	supportsProjectNotification()	Tests for the availability of a project notification service.
boolean	supportsProjectQuery()	Tests if querying projects is available.
boolean	supportsProjectRecordType(Type projectRecordType)	Tests if the given Project record type is supported.
boolean	supportsProjectSearch()	Tests if searching for projects is available.
boolean	supportsProjectSearchRecordType(Type projectSearchRecordType)	Tests if the given project search record type is supported.
boolean	supportsProjectSmartCampus()	Tests if a project smart campus session is available.
boolean	supportsRenovationAdmin()	Tests for the availability of a renovation administrative service for creating and deleting renovationes.
boolean	supportsRenovationCampus()	Tests if a renovation to campus lookup session is available.
boolean	supportsRenovationCampusAssignment()	Tests if a renovation to campus assignment session is available.
boolean	supportsRenovationLookup()	Tests for the availability of a renovation lookup service.
boolean	supportsRenovationNotification()	Tests for the availability of a renovation notification service.
boolean	supportsRenovationQuery()	Tests if querying renovationes is available.
boolean	supportsRenovationRecordType(Type renovationRecordType)	Tests if the given Renovation record type is supported.
boolean	supportsRenovationSearch()	Tests if searching for renovationes is available.
boolean	supportsRenovationSearchRecordType(Type renovationSearchRecordType)	Tests if the given renovation search record type is supported.
boolean	supportsRenovationSmartCampus()	Tests if a renovation smart campus session is available.
boolean	supportsRoomConstructionBatch()	Tests if a service to manage construction in bulk is available.
boolean	supportsVisibleFederation()	Tests if any project federation is exposed.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsRenovationLookup()} is {@code 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 {@code supportsRenovationLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRenovationQuery()} is {@code 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 {@code supportsRenovationQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRenovationSearch()} is {@code 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 {@code supportsRenovationSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRenovationAdmin()} is {@code 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 {@code supportsRenovationAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRenovationNotification()} is {@code 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 {@code supportsRenovationNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRenovationCampus()} is {@code 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 {@code supportsRenovationCampusAssignment()} is {@code 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 {@code supportsRenovationSmartCampus()} is {@code 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 {@code supportsProjectLookup()} is {@code 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 {@code supportsProjectLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProjectQuery()} is {@code 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 {@code supportsProjectQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProjectSearch()} is {@code 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 {@code supportsProjectSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProjectAdmin()} is {@code 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 {@code supportsProjectAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProjectNotification()} is {@code 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 {@code supportsProjectNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProjectCampus()} is {@code 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 {@code supportsProjectCampusAssignment()} is {@code 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 {@code supportsProjectSmartCampus()} is {@code 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 {@code supportsRoomConstructionBatch()} is {@code true} .