org.osid.room.squatting

Interface RoomSquattingProxyManager

All Superinterfaces:

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

public interface RoomSquattingProxyManager
extends OsidProxyManager, RoomSquattingProfile

The room squatting manager provides access to room squatting 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:

• 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

Methods

Modifier and Type	Method and Description
DeedAdminSession	getDeedAdminSession(Proxy proxy) Gets the OsidSession associated with the deed administrative service.
DeedAdminSession	getDeedAdminSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the deed administration service for the given campus.
DeedCampusAssignmentSession	getDeedCampusAssignmentSession(Proxy proxy) Gets the session for assigning deed to campus mappings.
DeedCampusSession	getDeedCampusSession(Proxy proxy) Gets the session for retrieving deed to campus mappings.
DeedLookupSession	getDeedLookupSession(Proxy proxy) Gets the OsidSession associated with the deed lookup service.
DeedLookupSession	getDeedLookupSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the deed lookup service for the given campus.
DeedNotificationSession	getDeedNotificationSession(DeedReceiver DeedReceiver, Proxy proxy) Gets the OsidSession associated with the deed notification service.
DeedNotificationSession	getDeedNotificationSessionForCampus(DeedReceiver DeedReceiver, Id campusId, Proxy proxy) Gets the OsidSession associated with the deed notification service for the given campus.
DeedQuerySession	getDeedQuerySession(Proxy proxy) Gets the OsidSession associated with the deed query service.
DeedQuerySession	getDeedQuerySessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the deed query service for the given campus.
DeedSearchSession	getDeedSearchSession(Proxy proxy) Gets the OsidSession associated with the deed search service.
DeedSearchSession	getDeedSearchSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the deed search service for the given campus.
DeedSmartCampusSession	getDeedSmartCampusSession(Id campusId, Proxy proxy) Gets the session for managing dynamic deed campuses for the given campus.
LeaseAdminSession	getLeaseAdminSession(Proxy proxy) Gets the OsidSession associated with the lease administrative service.
LeaseAdminSession	getLeaseAdminSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the lease administration service for the given campus.
LeaseCampusAssignmentSession	getLeaseCampusAssignmentSession(Proxy proxy) Gets the session for assigning lease to campus mappings.
LeaseCampusSession	getLeaseCampusSession(Proxy proxy) Gets the session for retrieving lease to campus mappings.
LeaseLookupSession	getLeaseLookupSession(Proxy proxy) Gets the OsidSession associated with the lease lookup service.
LeaseLookupSession	getLeaseLookupSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the lease lookup service for the given campus.
LeaseNotificationSession	getLeaseNotificationSession(LeaseReceiver leaseReceiver, Proxy proxy) Gets the OsidSession associated with the lease notification service.
LeaseNotificationSession	getLeaseNotificationSessionForCampus(LeaseReceiver leaseReceiver, Id campusId, Proxy proxy) Gets the OsidSession associated with the lease notification service for the given campus.
LeaseQuerySession	getLeaseQuerySession(Proxy proxy) Gets the OsidSession associated with the lease query service.
LeaseQuerySession	getLeaseQuerySessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the lease query service for the given campus.
LeaseSearchSession	getLeaseSearchSession(Proxy proxy) Gets the OsidSession associated with the lease search service.
LeaseSearchSession	getLeaseSearchSessionForCampus(Id campusId, Proxy proxy) Gets the OsidSession associated with the lease search service for the given campus.
LeaseSmartCampusSession	getLeaseSmartCampusSession(Id campusId, Proxy proxy) Gets the session for managing dynamic lease campuses for the given campus.
RoomSquattingBatchProxyManager	getRoomSquattingBatchProxyManager() Gets a RoomSquattingBatchProxyManager.

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.squatting.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

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

getLeaseLookupSession

LeaseLookupSession getLeaseLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the lease lookup service.

Parameters:

proxy - a proxy

Returns:

a LeaseLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseLookup() is false

Compliance:

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

getLeaseLookupSessionForCampus

LeaseLookupSession getLeaseLookupSessionForCampus(Id campusId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a LeaseLookupSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLeaseLookup() and supportsVisibleFederation() are true

getLeaseQuerySession

LeaseQuerySession getLeaseQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the lease query service.

Parameters:

proxy - a proxy

Returns:

a LeaseQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseQuery() is false

Compliance:

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

getLeaseQuerySessionForCampus

LeaseQuerySession getLeaseQuerySessionForCampus(Id campusId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a LeaseQuerySession

Throws:

NotFoundException - no Lease found by the given Id

NullArgumentException - campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLeaseQuery() and supportsVisibleFederation() are true

getLeaseSearchSession

LeaseSearchSession getLeaseSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the lease search service.

Parameters:

proxy - a proxy

Returns:

a LeaseSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseSearch() is false

Compliance:

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

getLeaseSearchSessionForCampus

LeaseSearchSession getLeaseSearchSessionForCampus(Id campusId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a LeaseSearchSession

Throws:

NotFoundException - no Lease found by the given Id

NullArgumentException - campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLeaseSearch() and supportsVisibleFederation() are true

getLeaseAdminSession

LeaseAdminSession getLeaseAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the lease administrative service.

Parameters:

proxy - a proxy

Returns:

a LeaseAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseAdmin() is false

Compliance:

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

getLeaseAdminSessionForCampus

LeaseAdminSession getLeaseAdminSessionForCampus(Id campusId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a LeaseAdminSession

Throws:

NotFoundException - no Lease found by the given Id

NullArgumentException - campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLeaseAdmin() and supportsVisibleFederation() are true

getLeaseNotificationSession

LeaseNotificationSession getLeaseNotificationSession(LeaseReceiver leaseReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the lease notification service.

Parameters:

leaseReceiver - the receiver

proxy - a proxy

Returns:

a LeaseNotificationSession

Throws:

NullArgumentException - leaseReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseNotification() is false

Compliance:

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

getLeaseNotificationSessionForCampus

LeaseNotificationSession getLeaseNotificationSessionForCampus(LeaseReceiver leaseReceiver,
                                                            Id campusId,
                                                            Proxy proxy)
                                                              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

proxy - a proxy

Returns:

a LeaseNotificationSession

Throws:

NotFoundException - no Lease found by the given Id

NullArgumentException - leaseReceiver, campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLeaseNotification() and supportsVisibleFederation() are true

getLeaseCampusSession

LeaseCampusSession getLeaseCampusSession(Proxy proxy)
                                         throws OperationFailedException

Gets the session for retrieving lease to campus mappings.

Parameters:

proxy - a proxy

Returns:

a LeaseCampusSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseCampus() is false

Compliance:

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

getLeaseCampusAssignmentSession

LeaseCampusAssignmentSession getLeaseCampusAssignmentSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the session for assigning lease to campus mappings.

Parameters:

proxy - a proxy

Returns:

a LeaseCampusAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseCampusAssignment() is false

Compliance:

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

getLeaseSmartCampusSession

LeaseSmartCampusSession getLeaseSmartCampusSession(Id campusId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

campusId - the Id of a campus

proxy - a proxy

Returns:

a LeaseSmartCampusSession

Throws:

NotFoundException - campusId not found

NullArgumentException - campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLeaseSmartCampus() is false

Compliance:

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

getDeedLookupSession

DeedLookupSession getDeedLookupSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the deed lookup service.

Parameters:

proxy - a proxy

Returns:

a DeedLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedLookup() is false

Compliance:

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

getDeedLookupSessionForCampus

DeedLookupSession getDeedLookupSessionForCampus(Id campusId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a DeedLookupSession

Throws:

NotFoundException - no Campus found by the given Id

NullArgumentException - campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeedLookup() and supportsVisibleFederation() are true

getDeedQuerySession

DeedQuerySession getDeedQuerySession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the deed query service.

Parameters:

proxy - a proxy

Returns:

a DeedQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedQuery() is false

Compliance:

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

getDeedQuerySessionForCampus

DeedQuerySession getDeedQuerySessionForCampus(Id campusId,
                                            Proxy proxy)
                                              throws NotFoundException,
                                                     OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a DeedQuerySession

Throws:

NotFoundException - no Deed found by the given Id

NullArgumentException - campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeedQuery() and supportsVisibleFederation() are true

getDeedSearchSession

DeedSearchSession getDeedSearchSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the deed search service.

Parameters:

proxy - a proxy

Returns:

a DeedSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedSearch() is false

Compliance:

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

getDeedSearchSessionForCampus

DeedSearchSession getDeedSearchSessionForCampus(Id campusId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a DeedSearchSession

Throws:

NotFoundException - no Deed found by the given Id

NullArgumentException - campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeedSearch() and supportsVisibleFederation() are true

getDeedAdminSession

DeedAdminSession getDeedAdminSession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the deed administrative service.

Parameters:

proxy - a proxy

Returns:

a DeedAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedAdmin() is false

Compliance:

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

getDeedAdminSessionForCampus

DeedAdminSession getDeedAdminSessionForCampus(Id campusId,
                                            Proxy proxy)
                                              throws NotFoundException,
                                                     OperationFailedException

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

Parameters:

campusId - the Id of the Campus

proxy - a proxy

Returns:

a DeedAdminSession

Throws:

NotFoundException - no Deed found by the given Id

NullArgumentException - campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeedAdmin() and supportsVisibleFederation() are true

getDeedNotificationSession

DeedNotificationSession getDeedNotificationSession(DeedReceiver DeedReceiver,
                                                 Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the deed notification service.

Parameters:

DeedReceiver - the receiver

proxy - a proxy

Returns:

a DeedNotificationSession

Throws:

NullArgumentException - DeedReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedNotification() is false

Compliance:

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

getDeedNotificationSessionForCampus

DeedNotificationSession getDeedNotificationSessionForCampus(DeedReceiver DeedReceiver,
                                                          Id campusId,
                                                          Proxy proxy)
                                                            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

proxy - a proxy

Returns:

a DeedNotificationSession

Throws:

NotFoundException - no Deed found by the given Id

NullArgumentException - DeedReceiver, campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeedNotification() and supportsVisibleFederation() are true

getDeedCampusSession

DeedCampusSession getDeedCampusSession(Proxy proxy)
                                       throws OperationFailedException

Gets the session for retrieving deed to campus mappings.

Parameters:

proxy - a proxy

Returns:

a DeedCampusSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedCampus() is false

Compliance:

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

getDeedCampusAssignmentSession

DeedCampusAssignmentSession getDeedCampusAssignmentSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the session for assigning deed to campus mappings.

Parameters:

proxy - a proxy

Returns:

a DeedCampusAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedCampusAssignment() is false

Compliance:

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

getDeedSmartCampusSession

DeedSmartCampusSession getDeedSmartCampusSession(Id campusId,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

campusId - the Id of a campus

proxy - a proxy

Returns:

a DeedSmartCampusSession

Throws:

NotFoundException - campusId not found

NullArgumentException - campusId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeedSmartCampus() is false

Compliance:

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

getRoomSquattingBatchProxyManager

RoomSquattingBatchProxyManager getRoomSquattingBatchProxyManager()
                                                                 throws OperationFailedException

Gets a RoomSquattingBatchProxyManager.

Returns:

a RoomSquattingBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRoomSquattingBatch() is false

Compliance:

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