public interface ActivityUnitSearch extends OsidSearch
The search interface for governing activity unit searches.
Modifier and Type | Method and Description |
---|---|
ActivityUnitSearchRecord |
getActivityUnitSearchRecord(Type activityUnitSearchRecordType)
Gets the activity unit search record corresponding to the given
activity unit search record
Type. |
void |
orderActivityUnitResults(ActivityUnitSearchOrder activityUnitSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongActivityUnits(IdList activityUnitIds)
Execute this search among the given list of activity units.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongActivityUnits(IdList activityUnitIds)
activityUnitIds
- list of activity unitsNullArgumentException
- activityUnitIds
is null
mandatory
- This method must be implemented. void orderActivityUnitResults(ActivityUnitSearchOrder activityUnitSearchOrder)
activityUnitSearchOrder
- activity unit search orderNullArgumentException
- activityUnitSearchOrder
is null
UnsupportedException
- activityUnitSearchOrder
is not of this servicemandatory
- This method must be implemented. ActivityUnitSearchRecord getActivityUnitSearchRecord(Type activityUnitSearchRecordType) throws OperationFailedException
Type.
This method is used
to retrieve an object implementing the requested record.activityUnitSearchRecordType
- a activity unit search record
typeNullArgumentException
-
activityUnitSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(activityUnitSearchRecordType)
is
false
mandatory
- This method must be implemented.