public interface RelevancyEnablerQuerySession extends OsidSession
This session provides methods for searching among
RelevancyEnabler
objects. The search query is constructed using
the RelevancyEnablerQuery.
This session defines views that offer differing behaviors for searching.
Relevancy enablers may have a query record indicated by their
respective record types. The query record is accessed via the
RelevancyEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchRelevancyEnablers()
Tests if this user can perform
RelevancyEnabler
lookups. |
Ontology |
getOntology()
Gets the
Ontology associated with this session. |
Id |
getOntologyId()
Gets the
Ontology Id associated with
this session. |
RelevancyEnablerQuery |
getRelevancyEnablerQuery()
Gets a relevancy enabler query.
|
RelevancyEnablerList |
getRelevancyEnablersByQuery(RelevancyEnablerQuery relevancyEnablerQuery)
Gets a list of
RelevancyEnablers matching the given
relevancy enabler 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.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchRelevancyEnablers()
RelevancyEnabler
lookups. 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 not offer lookup
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. RelevancyEnablerQuery getRelevancyEnablerQuery()
mandatory
- This method must be implemented. RelevancyEnablerList getRelevancyEnablersByQuery(RelevancyEnablerQuery relevancyEnablerQuery) throws OperationFailedException, PermissionDeniedException
RelevancyEnablers
matching the given
relevancy enabler query.relevancyEnablerQuery
- the relevancy enabler query RelevancyEnablerList
NullArgumentException
- relevancyEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- relevancyEnablerQuery
is not of this servicemandatory
- This method must be implemented.