public interface RelevancyQuerySession extends OsidSession
This session provides methods for searching Relevancy
objects. The search query is constructed using the RelevancyQuery.
The relevancy record Type
also specifies the record
for the relevancy query.
This session defines views that offer differing behaviors for searching.
Relevancies may have a query record indicated by their respective
record types. The query record is accessed via the RelevancyQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchRelevancies()
Tests if this user can perform
Relevancy searches. |
Ontology |
getOntology()
Gets the
Ontology associated with this session. |
Id |
getOntologyId()
Gets the
Ontology Id associated with
this session. |
RelevancyList |
getRelevanciesByQuery(RelevancyQuery relevancyQuery)
Gets a list of relevancies matching the given relevancy query.
|
RelevancyQuery |
getRelevancyQuery()
Gets a relevancy 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 canSearchRelevancies()
Relevancy
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. RelevancyQuery getRelevancyQuery()
mandatory
- This method must be implemented. RelevancyList getRelevanciesByQuery(RelevancyQuery relevancyQuery) throws OperationFailedException, PermissionDeniedException
relevancyQuery
- the relevancy query RelevancyList
NullArgumentException
- relevancyQuery is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- relevancyQuery
is
not of this servicemandatory
- This method must be implemented.