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

Modifier and Type	Method	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 Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type.

Method Details

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.