public interface ProgramEntrySearch extends OsidSearch
The search interface for governing program entry searches.
Modifier and Type | Method and Description |
---|---|
ProgramEntrySearchRecord |
getProgramEntrySearchRecord(Type programEntrySearchRecordType)
Gets the program entry search record corresponding to the given
program entry search record
Type. |
void |
orderProgramEntryResults(ProgramEntrySearchOrder programEntrySearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongProgramEntries(IdList programEntryIds)
Execute this search among the given list of program entries.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongProgramEntries(IdList programEntryIds)
programEntryIds
- list of program entry Ids
NullArgumentException
- programEntryIds
is null
mandatory
- This method must be implemented. void orderProgramEntryResults(ProgramEntrySearchOrder programEntrySearchOrder)
programEntrySearchOrder
- program entry search orderNullArgumentException
- programEntrySearchOrder
is null
UnsupportedException
- programEntrySearchOrder
is not of this servicemandatory
- This method must be implemented. ProgramEntrySearchRecord getProgramEntrySearchRecord(Type programEntrySearchRecordType) throws OperationFailedException
Type.
This method is used
to retrieve an object implementing the requested record.programEntrySearchRecordType
- a program entry search record
typeNullArgumentException
-
programEntrySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(programEntrySearchRecordType)
is
false
mandatory
- This method must be implemented.