org.osid.subscription

Interface PublisherSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, PublisherQuerySession

public interface PublisherSearchSession
extends PublisherQuerySession

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.

getPublishersByQuery() is the basic search method and returns a list of Publisher elements. A more advanced search may be performed with getPublishersBySearch(). It accepts a PublisherSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPublishersBySearch() returns a PublisherSearchResults that can be used to access the resulting PublisherList or be used to perform a search within the result set through PublisherSearch.

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.

Method Summary

Methods

Modifier and Type	Method and Description
PublisherQuery	getPublisherQueryFromInspector(PublisherQueryInspector publisherQueryInspector) Gets an entry query from an inspector.
PublisherSearchResults	getPublishersBySearch(PublisherQuery publisherQuery, PublisherSearch publisherSearch) Gets the search results matching the given search.
PublisherSearch	getPublisherSearch() Gets a publisher search.
PublisherSearchOrder	getPublisherSearchOrder() Gets a publisher search order.

Methods inherited from interface org.osid.subscription.PublisherQuerySession

canSearchPublishers, getPublisherQuery, getPublishersByQuery

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getPublisherSearch

PublisherSearch getPublisherSearch()

Gets a publisher search.

Returns:

the publisher search

Compliance:

mandatory - This method must be implemented.

getPublisherSearchOrder

PublisherSearchOrder getPublisherSearchOrder()

Gets a publisher search order. The PublisherSearchOrder is supplied to a PublisherSearch to specify the ordering of results.

Returns:

the publisher search order

Compliance:

mandatory - This method must be implemented.

getPublishersBySearch

PublisherSearchResults getPublishersBySearch(PublisherQuery publisherQuery,
                                           PublisherSearch publisherSearch)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Gets the search results matching the given search.

Parameters:

publisherQuery - the publisher query

publisherSearch - the publisher search

Returns:

the publisher search results

Throws:

NullArgumentException - publisherQuery or publisherSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - publisherQuery or publisherSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPublisherQueryFromInspector

PublisherQuery getPublisherQueryFromInspector(PublisherQueryInspector publisherQueryInspector)

Gets an entry query from an inspector. The inspector is available from an PublisherSearchResults.

Parameters:

publisherQueryInspector - a query inspector

Returns:

the entry query

Throws:

NullArgumentException - publisherQueryInspector is null

UnsupportedException - publisherQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.