org.osid.room.construction

Interface RoomConstructionProxyManager

All Superinterfaces:

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

public interface RoomConstructionProxyManager
extends OsidProxyManager, RoomConstructionProfile

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.

Method Summary

Methods

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

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the renovation lookup service.

Parameters:

proxy - a proxy

Returns:

a RenovationLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a RenovationLookupSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the renovation query service.

Parameters:

proxy - a proxy

Returns:

a RenovationQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a RenovationQuerySession

Throws:

NotFoundException - no Renovation found by the given Id

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the renovation search service.

Parameters:

proxy - a proxy

Returns:

a RenovationSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a RenovationSearchSession

Throws:

NotFoundException - no Renovation found by the given Id

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the renovation administrative service.

Parameters:

proxy - a proxy

Returns:

a RenovationAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a RenovationAdminSession

Throws:

NotFoundException - no Renovation found by the given Id

NullArgumentException - campusId or proxy 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,
                                                             Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the renovation notification service.

Parameters:

renovationReceiver - the receiver

proxy - a proxy

Returns:

a RenovationNotificationSession

Throws:

NullArgumentException - renovationReceiver or proxy 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,
                                                                      Proxy proxy)
                                                                        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

proxy - a proxy

Returns:

a RenovationNotificationSession

Throws:

NotFoundException - no Renovation found by the given Id

NullArgumentException - renovationReceiver, campusId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the session for retrieving renovation to campus mappings.

Parameters:

proxy - a proxy

Returns:

a RenovationCampusSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRenovationCampus() is false

Compliance:

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

getRenovationCampusAssignmentSession

RenovationCampusAssignmentSession getRenovationCampusAssignmentSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the session for assigning renovation to campus mappings.

Parameters:

proxy - a proxy

Returns:

a RenovationCampusAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

campusId - the Id of a campus

proxy - a proxy

Returns:

a RenovationSmartCampusSession

Throws:

NotFoundException - campusId not found

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the project lookup service.

Parameters:

proxy - a proxy

Returns:

a ProjectLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a ProjectLookupSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the project query service.

Parameters:

proxy - a proxy

Returns:

a ProjectQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a ProjectQuerySession

Throws:

NotFoundException - no Project found by the given Id

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the project search service.

Parameters:

proxy - a proxy

Returns:

a ProjectSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a ProjectSearchSession

Throws:

NotFoundException - no Project found by the given Id

NullArgumentException - campusId or proxy 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(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the project administrative service.

Parameters:

proxy - a proxy

Returns:

a ProjectAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a ProjectAdminSession

Throws:

NotFoundException - no Project found by the given Id

NullArgumentException - campusId or proxy 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,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the project notification service.

Parameters:

ProjectReceiver - the receiver

proxy - a proxy

Returns:

a ProjectNotificationSession

Throws:

NullArgumentException - ProjectReceiver or proxy 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,
                                                                Proxy proxy)
                                                                  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

proxy - a proxy

Returns:

a ProjectNotificationSession

Throws:

NotFoundException - no Project found by the given Id

NullArgumentException - ProjectReceiver, campusId or proxy 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(Proxy proxy)
                                             throws OperationFailedException

Gets the session for retrieving project to campus mappings.

Parameters:

proxy - a proxy

Returns:

a ProjectCampusSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectCampus() is false

Compliance:

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

getProjectCampusAssignmentSession

ProjectCampusAssignmentSession getProjectCampusAssignmentSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the session for assigning project to campus mappings.

Parameters:

proxy - a proxy

Returns:

a ProjectCampusAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

campusId - the Id of a campus

proxy - a proxy

Returns:

a ProjectSmartCampusSession

Throws:

NotFoundException - campusId not found

NullArgumentException - campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProjectSmartCampus() is false

Compliance:

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

getRoomConstructionBatchProxyManager

RoomConstructionBatchProxyManager getRoomConstructionBatchProxyManager()
                                                                       throws OperationFailedException

Gets a RoomConstructionBatchProxyManager.

Returns:

a RoomConstructionBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomConstructionBatch() is false

Compliance:

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