public interface AwardEntrySearch extends OsidSearch
The search interface for governing award entry searches.
Modifier and Type | Method and Description |
---|---|
AwardEntrySearchRecord |
getAwardEntrySearchRecord(Type awardEntrySearchRecordType)
Gets the award entry search record corresponding to the given award
entry search record
Type. |
void |
orderAwardEntryResults(AwardEntrySearchOrder awardEntrySearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongAwardEntries(IdList awardEntryIds)
Execute this search among the given list of award entries.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongAwardEntries(IdList awardEntryIds)
awardEntryIds
- list of award entry Ids
NullArgumentException
- awardEntryIds
is
null
mandatory
- This method must be implemented. void orderAwardEntryResults(AwardEntrySearchOrder awardEntrySearchOrder)
awardEntrySearchOrder
- award entry search orderNullArgumentException
- awardEntrySearchOrder
is null
UnsupportedException
- awardEntrySearchOrder
is not of this servicemandatory
- This method must be implemented. AwardEntrySearchRecord getAwardEntrySearchRecord(Type awardEntrySearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.awardEntrySearchRecordType
- an award entry search record typeNullArgumentException
-
awardEntrySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(awardEntrySearchRecordType)
is
false
mandatory
- This method must be implemented.