Interface RoomSquattingManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, RoomSquattingProfile, Sourceable

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.

Method Summary

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

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 RoomSquattingProfile

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

Modifier and Type	Method	Description
TypeList	getDeedRecordTypes()	Gets the supported Deed record types.
TypeList	getDeedSearchRecordTypes()	Gets the supported deed search record types.
TypeList	getLeaseRecordTypes()	Gets the supported Lease record types.
TypeList	getLeaseSearchRecordTypes()	Gets the supported lease search record types.
boolean	supportsDeedAdmin()	Tests for the availability of a deed administrative service for creating and deleting deeds.
boolean	supportsDeedCampus()	Tests if a deed to campus lookup session is available.
boolean	supportsDeedCampusAssignment()	Tests if a deed to campus assignment session is available.
boolean	supportsDeedLookup()	Tests for the availability of a deed lookup service.
boolean	supportsDeedNotification()	Tests for the availability of a deed notification service.
boolean	supportsDeedQuery()	Tests if querying deeds is available.
boolean	supportsDeedRecordType(Type deedRecordType)	Tests if the given Deed record type is supported.
boolean	supportsDeedSearch()	Tests if searching for deeds is available.
boolean	supportsDeedSearchRecordType(Type deedSearchRecordType)	Tests if the given deed search record type is supported.
boolean	supportsDeedSmartCampus()	Tests if a deed smart campus session is available.
boolean	supportsLeaseAdmin()	Tests for the availability of a lease administrative service for creating and deleting leasees.
boolean	supportsLeaseCampus()	Tests if a lease to campus lookup session is available.
boolean	supportsLeaseCampusAssignment()	Tests if a lease to campus assignment session is available.
boolean	supportsLeaseLookup()	Tests for the availability of a lease lookup service.
boolean	supportsLeaseNotification()	Tests for the availability of a lease notification service.
boolean	supportsLeaseQuery()	Tests if querying leasees is available.
boolean	supportsLeaseRecordType(Type leaseRecordType)	Tests if the given Lease record type is supported.
boolean	supportsLeaseSearch()	Tests if searching for leasees is available.
boolean	supportsLeaseSearchRecordType(Type leaseSearchRecordType)	Tests if the given lease search record type is supported.
boolean	supportsLeaseSmartCampus()	Tests if a lease smart campus session is available.
boolean	supportsRoomSquattingBatch()	Tests if a service to manage squatters in bulk is available.
boolean	supportsVisibleFederation()	Tests if any deed 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

getLeaseLookupSession

LeaseLookupSession getLeaseLookupSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the lease lookup service.

Returns:

a LeaseLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsLeaseLookup()} is {@code true} .

getLeaseLookupSessionForCampus

LeaseLookupSession getLeaseLookupSessionForCampus(Id campusId)
                                           throws NotFoundException,
OperationFailedException

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

Parameters:

campusId - the Id of the Lease

Returns:

a LeaseLookupSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLeaseLookup()} and {@code supportsVisibleFederation()} are {@code true}

getLeaseQuerySession

LeaseQuerySession getLeaseQuerySession()
                                throws OperationFailedException

Gets the OsidSession associated with the lease query service.

Returns:

a LeaseQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsLeaseQuery()} is {@code true} .

getLeaseQuerySessionForCampus

LeaseQuerySession getLeaseQuerySessionForCampus(Id campusId)
                                         throws NotFoundException,
OperationFailedException

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

Parameters:

campusId - the Id of the Lease

Returns:

a LeaseQuerySession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLeaseQuery()} and {@code supportsVisibleFederation()} are {@code true}

getLeaseSearchSession

LeaseSearchSession getLeaseSearchSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the lease search service.

Returns:

a LeaseSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsLeaseSearch()} is {@code true} .

getLeaseSearchSessionForCampus

LeaseSearchSession getLeaseSearchSessionForCampus(Id campusId)
                                           throws NotFoundException,
OperationFailedException

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

Parameters:

campusId - the Id of the Lease

Returns:

a LeaseSearchSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLeaseSearch()} and {@code supportsVisibleFederation()} are {@code true}

getLeaseAdminSession

LeaseAdminSession getLeaseAdminSession()
                                throws OperationFailedException

Gets the OsidSession associated with the lease administrative service.

Returns:

a LeaseAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsLeaseAdmin()} is {@code true} .

getLeaseAdminSessionForCampus

LeaseAdminSession getLeaseAdminSessionForCampus(Id campusId)
                                         throws NotFoundException,
OperationFailedException

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

Parameters:

campusId - the Id of the Lease

Returns:

a LeaseAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLeaseAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getLeaseNotificationSession

LeaseNotificationSession getLeaseNotificationSession(LeaseReceiver leaseReceiver)
                                              throws OperationFailedException

Gets the OsidSession associated with the lease notification service.

Parameters:

leaseReceiver - the receiver

Returns:

a LeaseNotificationSession

Throws:

NullArgumentException - leaseReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsLeaseNotification()} is {@code true} .

getLeaseNotificationSessionForCampus

LeaseNotificationSession getLeaseNotificationSessionForCampus(LeaseReceiver leaseReceiver,
 Id campusId)
                                                       throws NotFoundException,
OperationFailedException

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

Parameters:

leaseReceiver - the receiver

campusId - the Id of the Campus

Returns:

a LeaseNotificationSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - leaseReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLeaseNotification()} and {@code supportsVisibleFederation()} are {@code true}

getLeaseCampusSession

LeaseCampusSession getLeaseCampusSession()
                                  throws OperationFailedException

Gets the session for retrieving lease to campus mappings.

Returns:

a LeaseCampusSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseCampus() is false

Compliance:

optional - This method must be implemented if {@code supportsLeaseCampus()} is {@code true} .

getLeaseCampusAssignmentSession

LeaseCampusAssignmentSession getLeaseCampusAssignmentSession()
                                                      throws OperationFailedException

Gets the session for assigning lease to campus mappings.

Returns:

a LeaseCampusAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseCampusAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsLeaseCampusAssignment()} is {@code true} .

getLeaseSmartCampusSession

LeaseSmartCampusSession getLeaseSmartCampusSession(Id campusId)
                                            throws NotFoundException,
OperationFailedException

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

Parameters:

campusId - the Id of the campus

Returns:

a LeaseSmartCampusSession

Throws:

NotFoundException - campusId not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseSmartCampus() is false

Compliance:

optional - This method must be implemented if {@code supportsLeaseSmartCampus()} is {@code true} .

getDeedLookupSession

DeedLookupSession getDeedLookupSession()
                                throws OperationFailedException

Gets the OsidSession associated with the deed lookup service.

Returns:

a DeedLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsDeedLookup()} is {@code true} .

getDeedLookupSessionForCampus

DeedLookupSession getDeedLookupSessionForCampus(Id campusId)
                                         throws NotFoundException,
OperationFailedException

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

Parameters:

campusId - the Id of the Deed

Returns:

a DeedLookupSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDeedLookup()} and {@code supportsVisibleFederation()} are {@code true}

getDeedQuerySession

DeedQuerySession getDeedQuerySession()
                              throws OperationFailedException

Gets the OsidSession associated with the deed query service.

Returns:

a DeedQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDeedQuery()} is {@code true} .

getDeedQuerySessionForCampus

DeedQuerySession getDeedQuerySessionForCampus(Id campusId)
                                       throws NotFoundException,
OperationFailedException

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

Parameters:

campusId - the Id of the Deed

Returns:

a DeedQuerySession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDeedQuery()} and {@code supportsVisibleFederation()} are {@code true}

getDeedSearchSession

DeedSearchSession getDeedSearchSession()
                                throws OperationFailedException

Gets the OsidSession associated with the deed search service.

Returns:

a DeedSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsDeedSearch()} is {@code true} .

getDeedSearchSessionForCampus

DeedSearchSession getDeedSearchSessionForCampus(Id campusId)
                                         throws NotFoundException,
OperationFailedException

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

Parameters:

campusId - the Id of the Deed

Returns:

a DeedSearchSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDeedSearch()} and {@code supportsVisibleFederation()} are {@code true}

getDeedAdminSession

DeedAdminSession getDeedAdminSession()
                              throws OperationFailedException

Gets the OsidSession associated with the deed administrative service.

Returns:

a DeedAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsDeedAdmin()} is {@code true} .

getDeedAdminSessionForCampus

DeedAdminSession getDeedAdminSessionForCampus(Id campusId)
                                       throws NotFoundException,
OperationFailedException

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

Parameters:

campusId - the Id of the Deed

Returns:

a DeedAdminSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDeedAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getDeedNotificationSession

DeedNotificationSession getDeedNotificationSession(DeedReceiver DeedReceiver)
                                            throws OperationFailedException

Gets the OsidSession associated with the deed notification service.

Parameters:

DeedReceiver - the receiver

Returns:

a DeedNotificationSession

Throws:

NullArgumentException - DeedReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsDeedNotification()} is {@code true} .

getDeedNotificationSessionForCampus

DeedNotificationSession getDeedNotificationSessionForCampus(DeedReceiver DeedReceiver,
 Id campusId)
                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

DeedReceiver - the receiver

campusId - the Id of the Campus

Returns:

a DeedNotificationSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - DeedReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDeedNotification()} and {@code supportsVisibleFederation()} are {@code true}

getDeedCampusSession

DeedCampusSession getDeedCampusSession()
                                throws OperationFailedException

Gets the session for retrieving deed to campus mappings.

Returns:

a DeedCampusSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedCampus() is false

Compliance:

optional - This method must be implemented if {@code supportsDeedCampus()} is {@code true} .

getDeedCampusAssignmentSession

DeedCampusAssignmentSession getDeedCampusAssignmentSession()
                                                    throws OperationFailedException

Gets the session for assigning deed to campus mappings.

Returns:

a DeedCampusAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedCampusAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsDeedCampusAssignment()} is {@code true} .

getDeedSmartCampusSession

DeedSmartCampusSession getDeedSmartCampusSession(Id campusId)
                                          throws NotFoundException,
OperationFailedException

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

Parameters:

campusId - the Id of the campus

Returns:

a DeedSmartCampusSession

Throws:

NotFoundException - campusId not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedSmartCampus() is false

Compliance:

optional - This method must be implemented if {@code supportsDeedSmartCampus()} is {@code true} .

getRoomSquattingBatchManager

RoomSquattingBatchManager getRoomSquattingBatchManager()
                                                throws OperationFailedException

Gets a RoomSquattingBatchManager .

Returns:

a RoomSquattingBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomSquattingBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomSquattingBatch()} is {@code true} .