public interface ProjectSmartCampusSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A ProjectQuery
can be retrieved from this session
and mapped to this Campus
to create a virtual collection of
Projects.
The projects may be sequenced using the
ProjectSearchOrder
from this session.
This Campus
has a default query that matches any
project and a default search order that specifies no sequencing. The
queries may be examined using a ProjectQueryInspector.
The
query may be modified by converting the inspector back to a
ProjectQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyProjectQuery(ProjectQuery projectQuery)
Applies a project query to this campus.
|
void |
applyProjectSequencing(ProjectSearchOrder projectSearchOrder)
Applies a project 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. |
ProjectQuery |
getProjectQuery()
Gets a project query.
|
ProjectQuery |
getProjectQueryFromInspector(ProjectQueryInspector projectQueryInspector)
Gets a project query from an inspector.
|
ProjectSearchOrder |
getProjectSearchOrder()
Gets a project search order.
|
ProjectQueryInspector |
inspectProjectQuery()
Gets a project 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. ProjectQuery getProjectQuery()
mandatory
- This method must be implemented. ProjectSearchOrder getProjectSearchOrder()
mandatory
- This method must be implemented. void applyProjectQuery(ProjectQuery projectQuery) throws OperationFailedException, PermissionDeniedException
projectQuery
- the project queryNullArgumentException
- projectQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- projectQuery
not
of this servicemandatory
- This method must be implemented. ProjectQueryInspector inspectProjectQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyProjectSequencing(ProjectSearchOrder projectSearchOrder) throws OperationFailedException, PermissionDeniedException
projectSearchOrder
- the project search orderNullArgumentException
- projectSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- projectSearchOrder
did not originate from getProjectSearchOrder()
mandatory
- This method must be implemented. ProjectQuery getProjectQueryFromInspector(ProjectQueryInspector projectQueryInspector)
projectQueryInspector
- a query inspectorNullArgumentException
- projectQueryInspector
is null
UnsupportedException
- projectQueryInspector
is not of this servicemandatory
- This method must be implemented.