public interface ActionGroupSearch extends OsidSearch
The search interface for governing action group searches.
Modifier and Type | Method and Description |
---|---|
ActionGroupSearchRecord |
getActionGroupSearchRecord(Type actionGroupSearchRecordType)
Gets the action group search record corresponding to the given action
group search record
Type. |
void |
orderActionGroupResults(ActionGroupSearchOrder actionGroupSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongActionGroups(IdList actionGroupIds)
Execute this search among the given list of action groups.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongActionGroups(IdList actionGroupIds)
actionGroupIds
- list of action groupsNullArgumentException
- actionGroupIds
is null
mandatory
- This method must be implemented. void orderActionGroupResults(ActionGroupSearchOrder actionGroupSearchOrder)
actionGroupSearchOrder
- action group search orderNullArgumentException
- actionGroupSearchOrder
is null
UnsupportedException
- actionGroupSearchOrder
is not of this servicemandatory
- This method must be implemented. ActionGroupSearchRecord getActionGroupSearchRecord(Type actionGroupSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.actionGroupSearchRecordType
- an action group search record typeNullArgumentException
-
actionGroupSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(actionGroupSearchRecordType)
is
false
mandatory
- This method must be implemented.