public interface FoundrySearch extends OsidSearch
The search interface for governing foundry searches.
Modifier and Type | Method and Description |
---|---|
FoundrySearchRecord |
getFoundrySearchRecord(Type foundrySearchRecordType)
Gets the foundry search record corresponding to the given foundry
search record
Type. |
void |
orderFoundryResults(FoundrySearchOrder foundrySearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongFoundries(IdList foundryIds)
Execute this search among the given list of foundries.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongFoundries(IdList foundryIds)
foundryIds
- list of foundriesNullArgumentException
- foundryIds
is
null
mandatory
- This method must be implemented. void orderFoundryResults(FoundrySearchOrder foundrySearchOrder)
foundrySearchOrder
- foundry search orderNullArgumentException
- foundrySearchOrder
is null
UnsupportedException
- foundrySearchOrder
is not of this servicemandatory
- This method must be implemented. FoundrySearchRecord getFoundrySearchRecord(Type foundrySearchRecordType) throws OperationFailedException
Type.
This method is be used to retrieve
an object implementing the requested record.foundrySearchRecordType
- a foundry search record typeNullArgumentException
- foundrySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(foundrySearchRecordType)
is false
mandatory
- This method must be implemented.