public interface RelevancyEnablerSearch extends OsidSearch
The search interface for governing relevancy enabler searches.
Modifier and Type | Method and Description |
---|---|
RelevancyEnablerSearchRecord |
getRelevancyEnablerSearchRecord(Type relevancyEnablerSearchRecordType)
Gets the relevancy enabler search record corresponding to the given
relevancy enabler search record
Type. |
void |
orderRelevancyEnablerResults(RelevancyEnablerSearchOrder relevancyEnablerSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongRelevancyEnablers(IdList relevancyEnablerIds)
Execute this search among the given list of relevancy enablers.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongRelevancyEnablers(IdList relevancyEnablerIds)
relevancyEnablerIds
- list of relevancy enablersNullArgumentException
- relevancyEnablerIds
is null
mandatory
- This method must be implemented. void orderRelevancyEnablerResults(RelevancyEnablerSearchOrder relevancyEnablerSearchOrder)
relevancyEnablerSearchOrder
- relevancy enabler search orderNullArgumentException
-
relevancyEnablerSearchOrder
is null
UnsupportedException
-
relevancyEnablerSearchOrder
is not of this servicemandatory
- This method must be implemented. RelevancyEnablerSearchRecord getRelevancyEnablerSearchRecord(Type relevancyEnablerSearchRecordType) throws OperationFailedException
Type.
This method is
used to retrieve an object implementing the requested record.relevancyEnablerSearchRecordType
- a relevancy enabler search
record typeNullArgumentException
-
relevancyEnablerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(relevancyEnablerSearchRecordType)
is
false
mandatory
- This method must be implemented.