public interface SubjectQuerySession extends OsidSession
This session provides methods for searching Subject
objects. The search query is constructed using the SubjectQuery.
The subject record Type
also specifies the record
for the subject query.
This session defines views that offer differing behaviors for searching.
Subjects may have a query record indicated by their respective record
types. The query record is accessed via the SubjectQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchSubjects()
Tests if this user can perform
Subjects searches. |
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.
|
SubjectList |
getSubjectsByQuery(SubjectQuery subjectQuery)
Gets a list of
Subjects matching the given subject
query. |
void |
useFederatedOntologyView()
Federates the view for methods in this session.
|
void |
useIsolatedOntologyView()
Isolates the view for methods in this session.
|
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 canSearchSubjects()
Subjects
searches. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedOntologyView()
mandatory
- This method is must be implemented. void useIsolatedOntologyView()
mandatory
- This method is must be implemented. SubjectQuery getSubjectQuery()
mandatory
- This method must be implemented. SubjectList getSubjectsByQuery(SubjectQuery subjectQuery) throws OperationFailedException, PermissionDeniedException
Subjects
matching the given subject
query.subjectQuery
- the subject query SubjectList
NullArgumentException
- subjectQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- subjectQuery
is
not of this servicemandatory
- This method must be implemented.