public interface RoomSquattingManager extends OsidManager, RoomSquattingProfile
The room squatting manager provides access to room squatting sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
LeaseLookupSession:
a session to retrieve leasees
LeaseQuerySession:
a session to query leasees
LeaseSearchSession:
a session to search for
leasees LeaseAdminSession:
a session to create, update and
delete leasees LeaseNotificationSession:
a session to receive
notifications for changes in leasees LeaseCampusSession:
a session to look up lease
campus mappings LeaseCampusAssignmentSession:
a session to manage
lease campus mappings LeaseSmartCampusSession:
a session to manage smart
campuses of leasees DeedLookupSession:
a session to retrieve deeds
DeedQuerySession:
a session to query deeds DeedSearchSession:
a session to search for deeds
DeedAdminSession:
a session to create, update and
delete deeds DeedNotificationSession:
a session to receive
notifications for changes in deeds DeedCampusSession:
a session to look up deed
campus mappings DeedCampusAssignmentSession:
a session to manage
deed campus mappings DeedSmartCampusSession:
a session to manage smart
campuses of deeds The room squatting manager also provides a profile for determing the supported search types supported by this service.
Modifier and Type | Method and Description |
---|---|
DeedAdminSession |
getDeedAdminSession()
Gets the
OsidSession associated with the deed
administrative service. |
DeedAdminSession |
getDeedAdminSessionForCampus(Id campusId)
Gets the
OsidSession associated with the deed
administrative service for the given campus. |
DeedCampusAssignmentSession |
getDeedCampusAssignmentSession()
Gets the session for assigning deed to campus mappings.
|
DeedCampusSession |
getDeedCampusSession()
Gets the session for retrieving deed to campus mappings.
|
DeedLookupSession |
getDeedLookupSession()
Gets the
OsidSession associated with the deed lookup
service. |
DeedLookupSession |
getDeedLookupSessionForCampus(Id campusId)
Gets the
OsidSession associated with the deed lookup
service for the given campus. |
DeedNotificationSession |
getDeedNotificationSession(DeedReceiver DeedReceiver)
Gets the
OsidSession associated with the deed
notification service. |
DeedNotificationSession |
getDeedNotificationSessionForCampus(DeedReceiver DeedReceiver,
Id campusId)
Gets the
OsidSession associated with the deed
notification service for the given campus. |
DeedQuerySession |
getDeedQuerySession()
Gets the
OsidSession associated with the deed query
service. |
DeedQuerySession |
getDeedQuerySessionForCampus(Id campusId)
Gets the
OsidSession associated with the deed query
service for the given campus. |
DeedSearchSession |
getDeedSearchSession()
Gets the
OsidSession associated with the deed search
service. |
DeedSearchSession |
getDeedSearchSessionForCampus(Id campusId)
Gets the
OsidSession associated with the deed search
service for the given campus. |
DeedSmartCampusSession |
getDeedSmartCampusSession(Id campusId)
Gets the session associated with the deed smart campus for the given
campus.
|
LeaseAdminSession |
getLeaseAdminSession()
Gets the
OsidSession associated with the lease
administrative service. |
LeaseAdminSession |
getLeaseAdminSessionForCampus(Id campusId)
Gets the
OsidSession associated with the lease
administrative service for the given campus. |
LeaseCampusAssignmentSession |
getLeaseCampusAssignmentSession()
Gets the session for assigning lease to campus mappings.
|
LeaseCampusSession |
getLeaseCampusSession()
Gets the session for retrieving lease to campus mappings.
|
LeaseLookupSession |
getLeaseLookupSession()
Gets the
OsidSession associated with the lease lookup
service. |
LeaseLookupSession |
getLeaseLookupSessionForCampus(Id campusId)
Gets the
OsidSession associated with the lease lookup
service for the given campus. |
LeaseNotificationSession |
getLeaseNotificationSession(LeaseReceiver leaseReceiver)
Gets the
OsidSession associated with the lease
notification service. |
LeaseNotificationSession |
getLeaseNotificationSessionForCampus(LeaseReceiver leaseReceiver,
Id campusId)
Gets the
OsidSession associated with the lease
notification service for the given campus. |
LeaseQuerySession |
getLeaseQuerySession()
Gets the
OsidSession associated with the lease query
service. |
LeaseQuerySession |
getLeaseQuerySessionForCampus(Id campusId)
Gets the
OsidSession associated with the lease query
service for the given campus. |
LeaseSearchSession |
getLeaseSearchSession()
Gets the
OsidSession associated with the lease search
service. |
LeaseSearchSession |
getLeaseSearchSessionForCampus(Id campusId)
Gets the
OsidSession associated with the lease search
service for the given campus. |
LeaseSmartCampusSession |
getLeaseSmartCampusSession(Id campusId)
Gets the session associated with the lease smart campus for the given
campus.
|
RoomSquattingBatchManager |
getRoomSquattingBatchManager()
Gets a
RoomSquattingBatchManager. |
changeBranch, initialize, rollbackService
close
getDeedRecordTypes, getDeedSearchRecordTypes, getLeaseRecordTypes, getLeaseSearchRecordTypes, supportsDeedAdmin, supportsDeedCampus, supportsDeedCampusAssignment, supportsDeedLookup, supportsDeedNotification, supportsDeedQuery, supportsDeedRecordType, supportsDeedSearch, supportsDeedSearchRecordType, supportsDeedSmartCampus, supportsLeaseAdmin, supportsLeaseCampus, supportsLeaseCampusAssignment, supportsLeaseLookup, supportsLeaseNotification, supportsLeaseQuery, supportsLeaseRecordType, supportsLeaseSearch, supportsLeaseSearchRecordType, supportsLeaseSmartCampus, supportsRoomSquattingBatch, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
LeaseLookupSession getLeaseLookupSession() throws OperationFailedException
OsidSession
associated with the lease lookup
service. LeaseLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLeaseLookup()
is false
optional
- This method must be implemented if
supportsLeaseLookup()
is true.
LeaseLookupSession getLeaseLookupSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the lease lookup
service for the given campus.campusId
- the Id
of the Lease
LeaseLookupSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLeaseLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsLeaseLookup()
and
supportsVisibleFederation()
are true
LeaseQuerySession getLeaseQuerySession() throws OperationFailedException
OsidSession
associated with the lease query
service. LeaseQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLeaseQuery()
is false
optional
- This method must be implemented if
supportsLeaseQuery()
is true.
LeaseQuerySession getLeaseQuerySessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the lease query
service for the given campus.campusId
- the Id
of the Lease
LeaseQuerySession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLeaseQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsLeaseQuery()
and
supportsVisibleFederation()
are true
LeaseSearchSession getLeaseSearchSession() throws OperationFailedException
OsidSession
associated with the lease search
service. LeaseSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLeaseSearch()
is false
optional
- This method must be implemented if
supportsLeaseSearch()
is true.
LeaseSearchSession getLeaseSearchSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the lease search
service for the given campus.campusId
- the Id
of the Lease
LeaseSearchSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLeaseSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsLeaseSearch()
and
supportsVisibleFederation()
are true
LeaseAdminSession getLeaseAdminSession() throws OperationFailedException
OsidSession
associated with the lease
administrative service. LeaseAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLeaseAdmin()
is false
optional
- This method must be implemented if
supportsLeaseAdmin()
is true.
LeaseAdminSession getLeaseAdminSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the lease
administrative service for the given campus.campusId
- the Id
of the Lease
LeaseAdminSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLeaseAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsLeaseAdmin()
and
supportsVisibleFederation()
are true
LeaseNotificationSession getLeaseNotificationSession(LeaseReceiver leaseReceiver) throws OperationFailedException
OsidSession
associated with the lease
notification service.leaseReceiver
- the receiver LeaseNotificationSession
NullArgumentException
- leaseReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLeaseNotification()
is false
optional
- This method must be implemented if
supportsLeaseNotification()
is true.
LeaseNotificationSession getLeaseNotificationSessionForCampus(LeaseReceiver leaseReceiver, Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the lease
notification service for the given campus.leaseReceiver
- the receivercampusId
- the Id
of the Campus
LeaseNotificationSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- leaseReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLeaseNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsLeaseNotification()
and
supportsVisibleFederation()
are true
LeaseCampusSession getLeaseCampusSession() throws OperationFailedException
LeaseCampusSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsLeaseCampus()
is false
optional
- This method must be implemented if
supportsLeaseCampus()
is true.
LeaseCampusAssignmentSession getLeaseCampusAssignmentSession() throws OperationFailedException
LeaseCampusAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLeaseCampusAssignment()
is false
optional
- This method must be implemented if
supportsLeaseCampusAssignment()
is true.
LeaseSmartCampusSession getLeaseSmartCampusSession(Id campusId) throws NotFoundException, OperationFailedException
campusId
- the Id
of the campus LeaseSmartCampusSession
NotFoundException
- campusId
not foundNullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsLeaseSmartCampus()
is false
optional
- This method must be implemented if
supportsLeaseSmartCampus()
is true.
DeedLookupSession getDeedLookupSession() throws OperationFailedException
OsidSession
associated with the deed lookup
service. DeedLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeedLookup()
is false
optional
- This method must be implemented if
supportsDeedLookup()
is true.
DeedLookupSession getDeedLookupSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the deed lookup
service for the given campus.campusId
- the Id
of the Deed
DeedLookupSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeedLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsDeedLookup()
and
supportsVisibleFederation()
are true
DeedQuerySession getDeedQuerySession() throws OperationFailedException
OsidSession
associated with the deed query
service. DeedQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeedQuery()
is false
optional
- This method must be implemented if
supportsDeedQuery()
is true.
DeedQuerySession getDeedQuerySessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the deed query
service for the given campus.campusId
- the Id
of the Deed
DeedQuerySession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeedQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsDeedQuery()
and
supportsVisibleFederation()
are true
DeedSearchSession getDeedSearchSession() throws OperationFailedException
OsidSession
associated with the deed search
service. DeedSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeedSearch()
is false
optional
- This method must be implemented if
supportsDeedSearch()
is true.
DeedSearchSession getDeedSearchSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the deed search
service for the given campus.campusId
- the Id
of the Deed
DeedSearchSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeedSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsDeedSearch()
and
supportsVisibleFederation()
are true
DeedAdminSession getDeedAdminSession() throws OperationFailedException
OsidSession
associated with the deed
administrative service. DeedAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeedAdmin()
is false
optional
- This method must be implemented if
supportsDeedAdmin()
is true.
DeedAdminSession getDeedAdminSessionForCampus(Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the deed
administrative service for the given campus.campusId
- the Id
of the Deed
DeedAdminSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeedAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsDeedAdmin()
and
supportsVisibleFederation()
are true
DeedNotificationSession getDeedNotificationSession(DeedReceiver DeedReceiver) throws OperationFailedException
OsidSession
associated with the deed
notification service.DeedReceiver
- the receiver DeedNotificationSession
NullArgumentException
- DeedReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDeedNotification()
is false
optional
- This method must be implemented if
supportsDeedNotification()
is true.
DeedNotificationSession getDeedNotificationSessionForCampus(DeedReceiver DeedReceiver, Id campusId) throws NotFoundException, OperationFailedException
OsidSession
associated with the deed
notification service for the given campus.DeedReceiver
- the receivercampusId
- the Id
of the Campus
DeedNotificationSession
NotFoundException
- no Campus
found by
the given Id
NullArgumentException
- DeedReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDeedNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDeedNotification()
and
supportsVisibleFederation()
are true
DeedCampusSession getDeedCampusSession() throws OperationFailedException
DeedCampusSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsDeedCampus()
is false
optional
- This method must be implemented if
supportsDeedCampus()
is true.
DeedCampusAssignmentSession getDeedCampusAssignmentSession() throws OperationFailedException
DeedCampusAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDeedCampusAssignment()
is false
optional
- This method must be implemented if
supportsDeedCampusAssignment()
is true.
DeedSmartCampusSession getDeedSmartCampusSession(Id campusId) throws NotFoundException, OperationFailedException
campusId
- the Id
of the campus DeedSmartCampusSession
NotFoundException
- campusId
not foundNullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDeedSmartCampus()
is false
optional
- This method must be implemented if
supportsDeedSmartCampus()
is true.
RoomSquattingBatchManager getRoomSquattingBatchManager() throws OperationFailedException
RoomSquattingBatchManager.
RoomSquattingBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRoomSquattingBatch()
is false
optional
- This method must be implemented if
supportsRoomSquattingBatch()
is true.