public interface RenovationSmartCampusSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A RenovationQuery
can be retrieved from this
session and mapped to this Campus
to create a virtual
collection of Renovations.
The renovations may be sequenced
using the RenovationSearchOrder
from this session.
This Campus
has a default query that matches any
renovation and a default search order that specifies no sequencing. The
queries may be examined using a RenovationQueryInspector.
The query may be modified by converting the inspector back to a
RenovationQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyRenovationQuery(RenovationQuery renovationQuery)
Applies a renovation query to this campus.
|
void |
applyRenovationSequencing(RenovationSearchOrder renovationSearchOrder)
Applies a renovation 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. |
RenovationQuery |
getRenovationQuery()
Gets a renovation query.
|
RenovationQuery |
getRenovationQueryFromInspector(RenovationQueryInspector renovationQueryInspector)
Gets a renovation query from an inspector.
|
RenovationSearchOrder |
getRenovationSearchOrder()
Gets a renovation search order.
|
RenovationQueryInspector |
inspectRenovationQuery()
Gets a renovation 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. RenovationQuery getRenovationQuery()
mandatory
- This method must be implemented. RenovationSearchOrder getRenovationSearchOrder()
mandatory
- This method must be implemented. void applyRenovationQuery(RenovationQuery renovationQuery) throws OperationFailedException, PermissionDeniedException
renovationQuery
- the renovation queryNullArgumentException
- renovationQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- renovationQuery
not of this servicemandatory
- This method must be implemented. RenovationQueryInspector inspectRenovationQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyRenovationSequencing(RenovationSearchOrder renovationSearchOrder) throws OperationFailedException, PermissionDeniedException
renovationSearchOrder
- the renovation search orderNullArgumentException
- renovationSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- renovationSearchOrder
not of this servicemandatory
- This method must be implemented. RenovationQuery getRenovationQueryFromInspector(RenovationQueryInspector renovationQueryInspector)
renovationQueryInspector
- a query inspectorNullArgumentException
- renovationQueryInspector
is null
UnsupportedException
- renovationQueryInspector
is not of this servicemandatory
- This method must be implemented.