org.osid.recipe

Interface Procedure

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Procedure
extends OsidObject

A Procedure is an action.

Method Summary

Methods

Modifier and Type	Method and Description
IdList	getLearningObjectiveIds() Gets the Ids of the learning objectives required to execute this procedure.
ObjectiveList	getLearningObjectives() Gets the learning objectives required to execute this procedure.
ProcedureRecord	getProcedureRecord(Type procedureRecordType) Gets the procedure record corresponding to the given Procedure record Type.

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

getLearningObjectiveIds

IdList getLearningObjectiveIds()

Gets the Ids of the learning objectives required to execute this procedure.

Returns:

the objective Ids

Compliance:

mandatory - This method must be implemented.

getLearningObjectives

ObjectiveList getLearningObjectives()
                                    throws OperationFailedException

Gets the learning objectives required to execute this procedure.

Returns:

the objectives

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getProcedureRecord

ProcedureRecord getProcedureRecord(Type procedureRecordType)
                                   throws OperationFailedException

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

Parameters:

procedureRecordType - the type of procedure record to retrieve

Returns:

the procedure record

Throws:

NullArgumentException - procedureRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(procedureRecordType) is false

Compliance:

mandatory - This method must be implemented.