OSID - osid.subscription.PublisherSearchSession Service Interface Definition

Interface	osid.subscription.PublisherSearchSession
Implements	`osid.subscription.PublisherQuerySession`
Used By	`osid.subscription.SubscriptionManager`
Used By	`osid.subscription.SubscriptionProxyManager`
Description	This session provides methods for searching `Publishers` . 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	getPublisherSearch
Description	Gets a publisher search.
Return	`osid.subscription.PublisherSearch`		the publisher search
Compliance	`mandatory`		This method must be implemented.
Method	getPublisherSearchOrder
Description	Gets a publisher search order. The `PublisherSearchOrder` is supplied to a `PublisherSearch` to specify the ordering of results.
Return	`osid.subscription.PublisherSearchOrder`		the publisher search order
Compliance	`mandatory`		This method must be implemented.
Method	getPublishersBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.subscription.PublisherQuery`	`publisherQuery`	the publisher query
Parameters	`osid.subscription.PublisherSearch`	`publisherSearch`	the publisher search
Return	`osid.subscription.PublisherSearchResults`		the publisher search results
Errors	NULL_ARGUMENT		`publisherQuery` or `publisherSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`publisherQuery` or `publisherSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPublisherQueryFromInspector
Description	Gets an entry query from an inspector. The inspector is available from an `PublisherSearchResults` .
Parameters	`osid.subscription.PublisherQueryInspector`	`publisherQueryInspector`	a query inspector
Return	`osid.subscription.PublisherQuery`		the entry query
Errors	NULL_ARGUMENT		`publisherQueryInspector` is `null`
Errors	UNSUPPORTED		`publisherQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.