org.osid.room.squatting

Interface LeaseSmartCampusSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface LeaseSmartCampusSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A LeaseQuery can be retrieved from this session and mapped to this Campus to create a virtual collection of Leases. The leases may be sequenced using the LeaseSearchOrder from this session.

This Campus has a default query that matches any lease and a default search order that specifies no sequencing. The queries may be examined using a LeaseQueryInspector. The query may be modified by converting the inspector back to a LeaseQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyLeaseQuery(LeaseQuery leaseQuery) Applies a lease query to this campus.
void	applyLeaseSequencing(LeaseSearchOrder leaseSearchOrder) Applies a lease search order to this campus.
boolean	canManageSmartCampuses() Tests if this user can manage smart campuses.
Campus	getCampus() Gets the Campus associated with this session.
Id	getCampusId() Gets the Campus Id associated with this session.
LeaseQuery	getLeaseQuery() Gets a lease query.
LeaseQuery	getLeaseQueryFromInspector(LeaseQueryInspector leaseQueryInspector) Gets a lease query from an inspector.
LeaseSearchOrder	getLeaseSearchOrder() Gets a lease search order.
LeaseQueryInspector	inspectLeaseQuery() Gets a lease query inspector for this campus.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

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

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getCampusId

Id getCampusId()

Gets the Campus Id associated with this session.

Returns:

the Campus Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCampus

Campus getCampus()
                 throws OperationFailedException,
                        PermissionDeniedException

Gets the Campus associated with this session.

Returns:

the Campus associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartCampuses

boolean canManageSmartCampuses()

Tests if this user can manage smart campuses. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returns:

false if smart campus management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getLeaseQuery

LeaseQuery getLeaseQuery()

Gets a lease query.

Returns:

the lease query

Compliance:

mandatory - This method must be implemented.

getLeaseSearchOrder

LeaseSearchOrder getLeaseSearchOrder()

Gets a lease search order.

Returns:

the lease search order

Compliance:

mandatory - This method must be implemented.

applyLeaseQuery

void applyLeaseQuery(LeaseQuery leaseQuery)
                     throws OperationFailedException,
                            PermissionDeniedException

Applies a lease query to this campus.

Parameters:

leaseQuery - the lease query

Throws:

NullArgumentException - leaseQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - leaseQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectLeaseQuery

LeaseQueryInspector inspectLeaseQuery()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets a lease query inspector for this campus.

Returns:

the lease query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyLeaseSequencing

void applyLeaseSequencing(LeaseSearchOrder leaseSearchOrder)
                          throws OperationFailedException,
                                 PermissionDeniedException

Applies a lease search order to this campus.

Parameters:

leaseSearchOrder - the lease search order

Throws:

NullArgumentException - leaseSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - leaseSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getLeaseQueryFromInspector

LeaseQuery getLeaseQueryFromInspector(LeaseQueryInspector leaseQueryInspector)

Gets a lease query from an inspector.

Parameters:

leaseQueryInspector - a query inspector

Returns:

the lease query

Throws:

NullArgumentException - leaseQueryInspector is null

UnsupportedException - leaseQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.