Interface CompetencySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CompetencySearch
extends OsidSearch

The search interface for governing competency searches.

Method Summary

Modifier and Type	Method	Description
CompetencySearchRecord	getCompetencySearchRecord(Type competencySearchRecordType)	Gets the competency search record corresponding to the given competency search record Type .This method is used to retrieve an object implementing the requested record.
void	orderCompetencyResults(CompetencySearchOrder competencySearchOrder)	Specify an ordering to the search results.
void	searchAmongCompetencies(IdList competencyIds)	Execute this search among the given list of competencies.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongCompetencies

void searchAmongCompetencies(IdList competencyIds)

Execute this search among the given list of competencies.

Parameters:

competencyIds - list of competencies

Throws:

NullArgumentException - competencyIds is null

Compliance:

mandatory - This method must be implemented.

orderCompetencyResults

void orderCompetencyResults(CompetencySearchOrder competencySearchOrder)

Specify an ordering to the search results.

Parameters:

competencySearchOrder - competency search order

Throws:

NullArgumentException - competencySearchOrder is null

UnsupportedException - competencySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCompetencySearchRecord

CompetencySearchRecord getCompetencySearchRecord(Type competencySearchRecordType)
                                          throws OperationFailedException

Gets the competency search record corresponding to the given competency search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

competencySearchRecordType - a competency search record type

Returns:

the competency search record

Throws:

NullArgumentException - competencySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(competencySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.