public interface DeedSmartCampusSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A DeedQuery
can be retrieved from this session
and mapped to this Campus
to create a virtual collection of
Deeds.
The deeds may be sequenced using the
DeedSearchOrder
from this session.
This Campus
has a default query that matches any deed
and a default search order that specifies no sequencing. The queries may
be examined using a DeedQueryInspector.
The query may be
modified by converting the inspector back to a DeedQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyDeedQuery(DeedQuery deedQuery)
Applies a deed query to this campus.
|
void |
applyDeedSequencing(DeedSearchOrder deedSearchOrder)
Applies a deed 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. |
DeedQuery |
getDeedQuery()
Gets a deed query.
|
DeedQuery |
getDeedQueryFromInspector(DeedQueryInspector deedQueryInspector)
Gets a deed query from an inspector.
|
DeedSearchOrder |
getDeedSearchOrder()
Gets a deed search order.
|
DeedQueryInspector |
inspectDeedQuery()
Gets a deed 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. DeedQuery getDeedQuery()
mandatory
- This method must be implemented. DeedSearchOrder getDeedSearchOrder()
mandatory
- This method must be implemented. void applyDeedQuery(DeedQuery deedQuery) throws OperationFailedException, PermissionDeniedException
deedQuery
- the deed queryNullArgumentException
- deedQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- deedQuery
not of
this servicemandatory
- This method must be implemented. DeedQueryInspector inspectDeedQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyDeedSequencing(DeedSearchOrder deedSearchOrder) throws OperationFailedException, PermissionDeniedException
deedSearchOrder
- the deed search orderNullArgumentException
- deedSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- deedSearchOrder
did not originate from getDeedSearchOrder()
mandatory
- This method must be implemented. DeedQuery getDeedQueryFromInspector(DeedQueryInspector deedQueryInspector)
deedQueryInspector
- a query inspectorNullArgumentException
- deedQueryInspector
is null
UnsupportedException
- deedQueryInspector
is not of this servicemandatory
- This method must be implemented.