public interface DispatchQuerySession extends OsidSession
This session provides methods for searching Dispatch
objects. The search query is constructed using the DispatchQuery.
The dispatch record Type
also specifies the record
for the dispatch query.
Dispatches may have a query record indicated by their respective
record types. The query record is accessed via the DispatchQuery.
The returns in this session may not be cast directly to these
interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchDispatches()
Tests if this user can perform
Dispatch searches. |
DispatchList |
getDispatchesByQuery(DispatchQuery dispatchQuery)
Gets a list of
Dispatches matching the given dispatch
query. |
DispatchQuery |
getDispatchQuery()
Gets a dispatch query.
|
Publisher |
getPublisher()
Gets the
Publisher associated with this session. |
Id |
getPublisherId()
Gets the
Publisher Id associated with
this session. |
void |
useFederatedPublisherView()
Federates the view for methods in this session.
|
void |
useIsolatedPublisherView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getPublisherId()
Publisher
Id
associated with
this session. Publisher Id
associated with this sessionmandatory
- This method must be implemented. Publisher getPublisher() throws OperationFailedException, PermissionDeniedException
Publisher
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchDispatches()
Dispatch
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 useFederatedPublisherView()
mandatory
- This method is must be implemented. void useIsolatedPublisherView()
mandatory
- This method is must be implemented. DispatchQuery getDispatchQuery()
mandatory
- This method must be implemented. DispatchList getDispatchesByQuery(DispatchQuery dispatchQuery) throws OperationFailedException, PermissionDeniedException
Dispatches
matching the given dispatch
query.dispatchQuery
- the dispatch query DispatchList
NullArgumentException
- dispatchQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- dispatchQuery
is
not of this servicemandatory
- This method must be implemented.