Interface CompetencySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CompetencySearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
CompetencyList	getCompetencies()	Gets the competency list resulting from a search.
CompetencyQueryInspector	getCompetencyQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
CompetencySearchResultsRecord	getCompetencySearchResultsRecord(Type competencySearchRecordType)	Gets the competency search results record corresponding to the given competency search record Type .This method is used to retrieve an object implementing the requested record.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getCompetencies

CompetencyList getCompetencies()

Gets the competency list resulting from a search.

Returns:

the competency list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getCompetencyQueryInspector

CompetencyQueryInspector getCompetencyQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the competency query inspector

Compliance:

mandatory - This method must be implemented.

getCompetencySearchResultsRecord

CompetencySearchResultsRecord getCompetencySearchResultsRecord(Type competencySearchRecordType)
                                                        throws OperationFailedException

Gets the competency search results 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 results record

Throws:

NullArgumentException - competencySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(competencySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.