org.osid.room.squatting

Interface LeaseQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

LeaseSearchSession

public interface LeaseQuerySession
extends OsidSession

This session provides methods for searching Lease objects. The search query is constructed using the LeaseQuery. The lease record Type also specifies the record for the lease query.

Leases may have a query record indicated by their respective record types. The query record is accessed via the LeaseQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchLeases() Tests if this user can perform Lease searches.
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.
LeaseList	getLeasesByQuery(LeaseQuery leaseQuery) Gets a list of Leases matching the given lease query.
void	useFederatedCampusView() Federates the view for methods in this session.
void	useIsolatedCampusView() Isolates the view for methods in this session.

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

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchLeases

boolean canSearchLeases()

Tests if this user can perform Lease searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedCampusView

void useFederatedCampusView()

Federates the view for methods in this session. A federated view will include leases in campuses which are children of this campus in the campus hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCampusView

void useIsolatedCampusView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.

Compliance:

mandatory - This method is must be implemented.

getLeaseQuery

LeaseQuery getLeaseQuery()

Gets a lease query.

Returns:

the lease query

Compliance:

mandatory - This method must be implemented.

getLeasesByQuery

LeaseList getLeasesByQuery(LeaseQuery leaseQuery)
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets a list of Leases matching the given lease query.

Parameters:

leaseQuery - the lease query

Returns:

the returned LeaseList

Throws:

NullArgumentException - leaseQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - leaseQuery is not of this service

Compliance:

mandatory - This method must be implemented.