Interface Competency

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Competency
extends OsidObject

A Competency is a skill required for a work.

Method Summary

Modifier and Type	Method	Description
CompetencyRecord	getCompetencyRecord(Type competencyRecordType)	Gets the competency record corresponding to the given Competency record Type .
IdList	getLearningObjectiveIds()	Gets the Ids of the learning objectives.
ObjectiveList	getLearningObjectives()	Gets the learning objectives.
boolean	hasLearningObjectives()	Tests if learning objectives are available for this competency.

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

hasLearningObjectives

boolean hasLearningObjectives()

Tests if learning objectives are available for this competency.

Returns:

true if learning objectives are available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLearningObjectiveIds

IdList getLearningObjectiveIds()

Gets the Ids of the learning objectives.

Returns:

the learning objective Ids

Throws:

IllegalStateException - hasLearningObjectives() is false

Compliance:

mandatory - This method must be implemented.

getLearningObjectives

ObjectiveList getLearningObjectives()
                             throws OperationFailedException

Gets the learning objectives.

Returns:

the learning objectives

Throws:

IllegalStateException - hasLearningObjectives() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getCompetencyRecord

CompetencyRecord getCompetencyRecord(Type competencyRecordType)
                              throws OperationFailedException

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

Parameters:

competencyRecordType - the type of competency record to retrieve

Returns:

the competency record

Throws:

NullArgumentException - competencyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(competencyRecordType) is false

Compliance:

mandatory - This method must be implemented.