public interface InquiryEnablerQuerySession extends OsidSession
This session provides methods for searching among InquiryEnabler
objects. The search query is constructed using the
InquiryEnablerQuery.
This session defines views that offer differing behaviors for searching.
Inquiry constrainer enablers may have a query record indicated by
their respective record types. The query record is accessed via the
InquiryEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchInquiryEnablers()
Tests if this user can perform
InquiryEnabler lookups. |
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
InquiryEnablerQuery |
getInquiryEnablerQuery()
Gets an inquiry enabler query.
|
InquiryEnablerList |
getInquiryEnablersByQuery(InquiryEnablerQuery inquiryEnablerQuery)
Gets a list of
InquiryEnablers matching the given
search. |
void |
useFederatedInquestView()
Federates the view for methods in this session.
|
void |
useIsolatedInquestView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getInquestId()
Inquest
Id
associated with this
session. Inquest Id
associated with this sessionmandatory
- This method must be implemented. Inquest getInquest() throws OperationFailedException, PermissionDeniedException
Inquest
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchInquiryEnablers()
InquiryEnabler
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 useFederatedInquestView()
mandatory
- This method is must be implemented. void useIsolatedInquestView()
mandatory
- This method is must be implemented. InquiryEnablerQuery getInquiryEnablerQuery()
mandatory
- This method must be implemented. InquiryEnablerList getInquiryEnablersByQuery(InquiryEnablerQuery inquiryEnablerQuery) throws OperationFailedException, PermissionDeniedException
InquiryEnablers
matching the given
search.inquiryEnablerQuery
- the inquiry constraienr enabler query InquiryEnablerList
NullArgumentException
- inquiryEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- inquiryEnablerQuery
is not of this servicemandatory
- This method must be implemented.