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.
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. |
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
RenovationLookupSession getRenovationLookupSession() throws OperationFailedException
OsidSession
associated with the renovation
lookup service. RenovationLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRenovationLookup()
is false
optional
- This method must be implemented if
supportsRenovationLookup()
is true.
RenovationLookupSession getRenovationLookupSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the renovation
lookup service for the given campus.campusId
- the Id
of the Renovation
RenovationLookupSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRenovationLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRenovationLookup()
and
supportsVisibleFederation()
are true
RenovationQuerySession getRenovationQuerySession() throws OperationFailedException
OsidSession
associated with the renovation
query service. RenovationQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRenovationQuery()
is false
optional
- This method must be implemented if
supportsRenovationQuery()
is true.
RenovationQuerySession getRenovationQuerySessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the renovation
query service for the given campus.campusId
- the Id
of the Renovation
RenovationQuerySession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRenovationQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRenovationQuery()
and
supportsVisibleFederation()
are true
RenovationSearchSession getRenovationSearchSession() throws OperationFailedException
OsidSession
associated with the renovation
search service. RenovationSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRenovationSearch()
is false
optional
- This method must be implemented if
supportsRenovationSearch()
is true.
RenovationSearchSession getRenovationSearchSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the renovation
search service for the given campus.campusId
- the Id
of the Renovation
RenovationSearchSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRenovationSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRenovationSearch()
and
supportsVisibleFederation()
are true
RenovationAdminSession getRenovationAdminSession() throws OperationFailedException
OsidSession
associated with the renovation
administrative service. RenovationAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRenovationAdmin()
is false
optional
- This method must be implemented if
supportsRenovationAdmin()
is true.
RenovationAdminSession getRenovationAdminSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the renovation
administrative service for the given campus.campusId
- the Id
of the Renovation
RenovationAdminSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRenovationAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRenovationAdmin()
and
supportsVisibleFederation()
are true
RenovationNotificationSession getRenovationNotificationSession(RenovationReceiver renovationReceiver) throws OperationFailedException
OsidSession
associated with the renovation
notification service.renovationReceiver
- the receiver RenovationNotificationSession
NullArgumentException
- renovationReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRenovationNotification()
is false
optional
- This method must be implemented if
supportsRenovationNotification()
is true.
RenovationNotificationSession getRenovationNotificationSessionForCampus(RenovationReceiver renovationReceiver, Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the renovation
notification service for the given campus.renovationReceiver
- the receivercampusId
- the Id
of the Campus
RenovationNotificationSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- renovationReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRenovationNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRenovationNotification()
and
supportsVisibleFederation()
are true
RenovationCampusSession getRenovationCampusSession() throws OperationFailedException
RenovationCampusSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRenovationCampus()
is false
optional
- This method must be implemented if
supportsRenovationCampus()
is true.
RenovationCampusAssignmentSession getRenovationCampusAssignmentSession() throws OperationFailedException
RenovationCampusAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRenovationCampusAssignment()
is false
optional
- This method must be implemented if
supportsRenovationCampusAssignment()
is
true.
RenovationSmartCampusSession getRenovationSmartCampusSession(Id campusId) throws NotFoundException, OperationFailedException
campusId
- the Id
of the campus RenovationSmartCampusSession
NotFoundException
- campusId
not foundNullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRenovationSmartCampus()
is false
optional
- This method must be implemented if
supportsRenovationSmartCampus()
is true.
ProjectLookupSession getProjectLookupSession() throws OperationFailedException
OsidSession
associated with the project lookup
service. ProjectLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProjectLookup()
is false
optional
- This method must be implemented if
supportsProjectLookup()
is true.
ProjectLookupSession getProjectLookupSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the project lookup
service for the given campus.campusId
- the Id
of the Project
ProjectLookupSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProjectLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsProjectLookup()
and
supportsVisibleFederation()
are true
ProjectQuerySession getProjectQuerySession() throws OperationFailedException
OsidSession
associated with the project query
service. ProjectQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProjectQuery()
is false
optional
- This method must be implemented if
supportsProjectQuery()
is true.
ProjectQuerySession getProjectQuerySessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the project query
service for the given campus.campusId
- the Id
of the Project
ProjectQuerySession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProjectQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsProjectQuery()
and
supportsVisibleFederation()
are true
ProjectSearchSession getProjectSearchSession() throws OperationFailedException
OsidSession
associated with the project search
service. ProjectSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProjectSearch()
is false
optional
- This method must be implemented if
supportsProjectSearch()
is true.
ProjectSearchSession getProjectSearchSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the project search
service for the given campus.campusId
- the Id
of the Project
ProjectSearchSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProjectSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsProjectSearch()
and
supportsVisibleFederation()
are true
ProjectAdminSession getProjectAdminSession() throws OperationFailedException
OsidSession
associated with the project
administrative service. ProjectAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProjectAdmin()
is false
optional
- This method must be implemented if
supportsProjectAdmin()
is true.
ProjectAdminSession getProjectAdminSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the project
administrative service for the given campus.campusId
- the Id
of the Project
ProjectAdminSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProjectAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsProjectAdmin()
and
supportsVisibleFederation()
are true
ProjectNotificationSession getProjectNotificationSession(ProjectReceiver ProjectReceiver) throws OperationFailedException
OsidSession
associated with the project
notification service.ProjectReceiver
- the receiver ProjectNotificationSession
NullArgumentException
- ProjectReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProjectNotification()
is false
optional
- This method must be implemented if
supportsProjectNotification()
is true.
ProjectNotificationSession getProjectNotificationSessionForCampus(ProjectReceiver ProjectReceiver, Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the project
notification service for the given campus.ProjectReceiver
- the receivercampusId
- the Id
of the Campus
ProjectNotificationSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- ProjectReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProjectNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProjectNotification()
and
supportsVisibleFederation()
are true
ProjectCampusSession getProjectCampusSession() throws OperationFailedException
ProjectCampusSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProjectCampus()
is false
optional
- This method must be implemented if
supportsProjectCampus()
is true.
ProjectCampusAssignmentSession getProjectCampusAssignmentSession() throws OperationFailedException
ProjectCampusAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProjectCampusAssignment()
is false
optional
- This method must be implemented if
supportsProjectCampusAssignment()
is true.
ProjectSmartCampusSession getProjectSmartCampusSession(Id campusId) throws NotFoundException, OperationFailedException
campusId
- the Id
of the campus ProjectSmartCampusSession
NotFoundException
- campusId
not foundNullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProjectSmartCampus()
is false
optional
- This method must be implemented if
supportsProjectSmartCampus()
is true.
RoomConstructionBatchManager getRoomConstructionBatchManager() throws OperationFailedException
RoomConstructionBatchManager.
RoomConstructionBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRoomBatchConstruction()
is false
optional
- This method must be implemented if
supportsRoomConstructionBatch()
is true.