public interface PublisherSearch extends OsidSearch
The search interface for governing publisher searches.
Modifier and Type | Method and Description |
---|---|
PublisherSearchRecord |
getPublisherSearchRecord(Type publisherSearchRecordType)
Gets the publisher search record corresponding to the given publisher
search record
Type. |
void |
orderPublisherResults(PublisherSearchOrder publishersearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongPublishers(IdList publisherIds)
Execute this search among the given list of publishers.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongPublishers(IdList publisherIds)
publisherIds
- list of publishersNullArgumentException
- publisherIds
is
null
mandatory
- This method must be implemented. void orderPublisherResults(PublisherSearchOrder publishersearchOrder)
publishersearchOrder
- publisher search orderNullArgumentException
- publishersearchOrder
is null
UnsupportedException
- publishersearchOrder
is not of this servicemandatory
- This method must be implemented. PublisherSearchRecord getPublisherSearchRecord(Type publisherSearchRecordType) throws OperationFailedException
Type.
This method must be used to
retrieve an object implementing the requested record.publisherSearchRecordType
- a publisher search record typeNullArgumentException
-
publishersearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(publishersearchRecordType)
is
false
mandatory
- This method must be implemented.