public interface PublisherQuerySession extends OsidSession
This session provides methods for searching Publisher
objects. The search query is constructed using the PublisherQuery.
The publisher record Type
also specifies the record
for the publisher query.
Publishers may have a query record indicated by their respective
record types. The query record is accessed via the PublisherQuery.
The returns in this session may not be cast directly to these
interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchPublishers()
Tests if this user can perform
Publisher searches. |
PublisherQuery |
getPublisherQuery()
Gets a publisher query.
|
PublisherList |
getPublishersByQuery(PublisherQuery publisherQuery)
Gets a list of
Publishers matching the given publisher
query. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchPublishers()
Publisher
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. PublisherQuery getPublisherQuery()
mandatory
- This method must be implemented. PublisherList getPublishersByQuery(PublisherQuery publisherQuery) throws OperationFailedException, PermissionDeniedException
Publishers
matching the given publisher
query.publisherQuery
- the publisher query PublisherList
NullArgumentException
- publisherQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- publisherQuery
is
not of this servicemandatory
- This method must be implemented.