public interface EffortSearch extends OsidSearch
The search interface for governing effort searches.
Modifier and Type | Method and Description |
---|---|
EffortSearchRecord |
getEffortSearchRecord(Type effortSearchRecordType)
Gets the effort search record corresponding to the given effort search
record
Type. |
void |
orderEffortResults(EffortSearchOrder effortSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongEfforts(IdList effortIds)
Execute this search among the given list of efforts.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongEfforts(IdList effortIds)
effortIds
- list of effortsNullArgumentException
- effortIds
is
null
mandatory
- This method must be implemented. void orderEffortResults(EffortSearchOrder effortSearchOrder)
effortSearchOrder
- effort search orderNullArgumentException
- effortSearchOrder
is null
UnsupportedException
- effortSearchOrder
is not of this servicemandatory
- This method must be implemented. EffortSearchRecord getEffortSearchRecord(Type effortSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.effortSearchRecordType
- an effort search record typeNullArgumentException
- effortSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(effortSearchRecordType)
is false
mandatory
- This method must be implemented.