public interface ObjectiveSearch extends OsidSearch
ObjectiveSearch
defines the interface for specifying
objective search options.
Modifier and Type | Method and Description |
---|---|
ObjectiveSearchRecord |
getObjectiveSearchRecord(Type objectiveSearchRecordType)
Gets the objective search record corresponding to the given objective
search record
Type. |
void |
orderObjectiveResults(ObjectiveSearchOrder objectiveSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongObjectives(IdList objectiveIds)
Execute this search among the given list of objectives.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongObjectives(IdList objectiveIds)
objectiveIds
- list of objectivesNullArgumentException
- objectiveIds
is
null
mandatory
- This method must be implemented. void orderObjectiveResults(ObjectiveSearchOrder objectiveSearchOrder)
objectiveSearchOrder
- objective search orderNullArgumentException
- objectiveSearchOrder
is null
UnsupportedException
- objectiveSearchOrder
is not of this servicemandatory
- This method must be implemented. ObjectiveSearchRecord getObjectiveSearchRecord(Type objectiveSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.objectiveSearchRecordType
- an objective search record typeNullArgumentException
-
objectiveSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasSearchRecordType(objectiveSearchRecordType)
is
false
mandatory
- This method must be implemented.