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.
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCampusId()
Campus
Id
associated with this
session. Campus Id
associated with this sessionmandatory
- This method must be implemented. Campus getCampus() throws OperationFailedException, PermissionDeniedException
Campus
associated with this session. Campus
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartCampuses()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart campus management is not
authorized, true
otherwisemandatory
- This method must be implemented. LeaseQuery getLeaseQuery()
mandatory
- This method must be implemented. LeaseSearchOrder getLeaseSearchOrder()
mandatory
- This method must be implemented. void applyLeaseQuery(LeaseQuery leaseQuery) throws OperationFailedException, PermissionDeniedException
leaseQuery
- the lease queryNullArgumentException
- leaseQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- leaseQuery
not of
this servicemandatory
- This method must be implemented. LeaseQueryInspector inspectLeaseQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyLeaseSequencing(LeaseSearchOrder leaseSearchOrder) throws OperationFailedException, PermissionDeniedException
leaseSearchOrder
- the lease search orderNullArgumentException
- leaseSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- leaseSearchOrder
not of this servicemandatory
- This method must be implemented. LeaseQuery getLeaseQueryFromInspector(LeaseQueryInspector leaseQueryInspector)
leaseQueryInspector
- a query inspectorNullArgumentException
- leaseQueryInspector
is null
UnsupportedException
- leaseQueryInspector
is not of this servicemandatory
- This method must be implemented.