ProficiencySearchResults

All Superinterfaces:: Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProficiencySearchResults extends OsidSearchResults

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

Method Summary

Modifier and Type

Method

Description

ProficiencyList

getProficiencies()

Gets the proficiency list resulting from a search.

ProficiencyQueryInspector

getProficiencyQueryInspector()

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

ProficiencySearchResultsRecord

getProficiencySearchResultsRecord(Type proficiencySearchRecordType)

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

Methods inherited from interface Browsable
getProperties, getPropertiesByRecordType

Methods inherited from interface Extensible
getRecordTypes, hasRecordType

Methods inherited from interface OsidSearchResults
getResultSize

Method Details
- getProficiencies
  
  ProficiencyList getProficiencies()
  
  Gets the proficiency list resulting from a search.
  
  Returns:
  
  the proficiency list
  
  Throws:
  
  IllegalStateException - list already retrieved
  
  Compliance:
  mandatory - This method must be implemented.
- getProficiencyQueryInspector
  
  ProficiencyQueryInspector getProficiencyQueryInspector()
  
  Gets the inspector for the query to examine the terms used in the search.
  
  Returns:
  
  the proficiency query inspector
  
  Compliance:
  mandatory - This method must be implemented.
- getProficiencySearchResultsRecord
  
  ProficiencySearchResultsRecord getProficiencySearchResultsRecord(Type proficiencySearchRecordType) throws OperationFailedException
  
  Gets the proficiency search results record corresponding to the given proficiency search record Type.This method is used to retrieve an object implementing the requested record.
  
  Parameters:
  
  proficiencySearchRecordType - a proficiency search record type
  
  Returns:
  
  the proficiency search results record
  
  Throws:
  
  NullArgumentException - proficiencySearchRecordType is null
  
  OperationFailedException - unable to complete request
  
  UnsupportedException - hasRecordType(proficiencySearchRecordType) is false
  
  Compliance:
  mandatory - This method must be implemented.