public interface CatalogEnablerSearch extends OsidSearch
The search interface for governing catalog enabler searches.
Modifier and Type | Method and Description |
---|---|
CatalogEnablerSearchRecord |
getCatalogEnablerSearchRecord(Type catalogEnablerSearchRecordType)
Gets the catalog enabler search record corresponding to the given
catalog enabler search record
Type. |
void |
orderCatalogEnablerResults(CatalogEnablerSearchOrder catalogEnablerSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCatalogEnablers(IdList catalogEnablerIds)
Execute this search among the given list of catalog enablers.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCatalogEnablers(IdList catalogEnablerIds)
catalogEnablerIds
- list of catalog enablersNullArgumentException
- catalogEnablerIds
is null
mandatory
- This method must be implemented. void orderCatalogEnablerResults(CatalogEnablerSearchOrder catalogEnablerSearchOrder)
catalogEnablerSearchOrder
- catalog enabler search orderNullArgumentException
-
catalogEnablerSearchOrder
is null
UnsupportedException
- catalogEnablerSearchOrder
is not of this servicemandatory
- This method must be implemented. CatalogEnablerSearchRecord getCatalogEnablerSearchRecord(Type catalogEnablerSearchRecordType) throws OperationFailedException
Type.
This method is used
to retrieve an object implementing the requested record.catalogEnablerSearchRecordType
- a catalog enabler search record
typeNullArgumentException
-
catalogEnablerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(catalogEnablerSearchRecordType)
is
false
mandatory
- This method must be implemented.