org.osid.control

Interface ActionGroup

All Superinterfaces:

Aggregateable, Browsable, Extensible, Identifiable, OsidObject

public interface ActionGroup
extends OsidObject, Aggregateable

An ActionGroup is a list of Actions to execute.

Method Summary

Methods

Modifier and Type	Method and Description
ActionGroupRecord	getActionGroupRecord(Type actionGroupRecordType) Gets the action group record corresponding to the given ActionGroup record Type.
IdList	getActionIds() Gets the action Ids.
ActionList	getActions() Gets the actions.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getActionIds

IdList getActionIds()

Gets the action Ids.

Returns:

the action Ids

Compliance:

mandatory - This method must be implemented.

getActions

ActionList getActions()
                      throws OperationFailedException

Gets the actions.

Returns:

the actions

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getActionGroupRecord

ActionGroupRecord getActionGroupRecord(Type actionGroupRecordType)
                                       throws OperationFailedException

Gets the action group record corresponding to the given ActionGroup record Type. This method is used to retrieve an object implementing the requested record. The actionGroupRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(actionGroupRecordType) is true .

Parameters:

actionGroupRecordType - the type of action group record to retrieve

Returns:

the action group record

Throws:

NullArgumentException - actionGroupRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(actionGroupRecordType) is false

Compliance:

mandatory - This method must be implemented.