Interface | osid.control.ActionGroupSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing action group searches. | ||
Method | searchAmongActionGroups | ||
Description |
Execute this search among the given list of action groups. | ||
Parameters | osid.id.IdList | actionGroupIds | list of action groups |
Errors | NULL_ARGUMENT | actionGroupIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderActionGroupResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.control.ActionGroupSearchOrder | actionGroupSearchOrder | action group search order |
Errors | NULL_ARGUMENT | actionGroupSearchOrder is null | |
UNSUPPORTED | actionGroupSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActionGroupSearchRecord | ||
Description |
Gets the action group search record corresponding to
the given action group search record | ||
Parameters | osid.type.Type | actionGroupSearchRecordType | an action group search record type |
Return | osid.control.records.ActionGroupSearchRecord | the action group search record | |
Errors | NULL_ARGUMENT | actionGroupSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(actionGroupSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |