public interface SubjectSmartOntologySession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A SubjectQuery
can be retrieved from this session
and mapped to this Ontology
to create a virtual collection
of Subjects.
The entries may be sequenced using the
SubjectSearchOrder
from this session.
This Ontology
has a default query that matches any
subject and a default search order that specifies no sequencing. The
queries may be examined using a SubjectQueryInspector.
The
query may be modified by converting the inspector back to a
SubjectQuery.
Modifier and Type | Method and Description |
---|---|
void |
applySubjectQuery(SubjectQuery subjectQuery)
Applies a subject query to this ontology.
|
void |
applySubjectSequencing(SubjectSearchOrder subjectSearchOrder)
Applies a subject search order to this ontology.
|
boolean |
canManageSmartOntologies()
Tests if this user can manage smart ontologies.
|
Ontology |
getOntology()
Gets the
Ontology associated with this session. |
Id |
getOntologyId()
Gets the
Ontology Id associated with
this session. |
SubjectQuery |
getSubjectQuery()
Gets a subject query.
|
SubjectQuery |
getSubjectQueryFromInspector(SubjectQueryInspector subjectQueryInspector)
Gets a subject query from an inspector.
|
SubjectSearchOrder |
getSubjectSearchOrder()
Gets a subject search order.
|
SubjectQueryInspector |
inspectSubjectQuery()
Gets a subject query inspector for this ontology.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOntologyId()
Ontology
Id
associated with
this session. Ontology Id
associated with this sessionmandatory
- This method must be implemented. Ontology getOntology() throws OperationFailedException, PermissionDeniedException
Ontology
associated with this session. Ontology
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartOntologies()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer smart operations. false
if smart ontology methods are not
authorized, true
otherwisemandatory
- This method must be implemented. SubjectQuery getSubjectQuery()
mandatory
- This method must be implemented. SubjectSearchOrder getSubjectSearchOrder()
mandatory
- This method must be implemented. void applySubjectQuery(SubjectQuery subjectQuery) throws OperationFailedException, PermissionDeniedException
subjectQuery
- the subject queryNullArgumentException
- subjectQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- subjectQuery
not
of this servicemandatory
- This method must be implemented. SubjectQueryInspector inspectSubjectQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applySubjectSequencing(SubjectSearchOrder subjectSearchOrder) throws OperationFailedException, PermissionDeniedException
subjectSearchOrder
- the subject search orderNullArgumentException
- subjectSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- subjectSearchOrder
not of this servicemandatory
- This method must be implemented. SubjectQuery getSubjectQueryFromInspector(SubjectQueryInspector subjectQueryInspector)
subjectQueryInspector
- a subject query inspectorNullArgumentException
- subjectQueryInspector
is null
UnsupportedException
- subjectQueryInspector
is not of this servicemandatory
- This method must be implemented.