Interface FiscalPeriodSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface FiscalPeriodSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
FiscalPeriodQueryInspector	getFiscalPeriodQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
FiscalPeriodList	getFiscalPeriods()	Gets the fiscal period list resulting from a search.
FiscalPeriodSearchResultsRecord	getFiscalPeriodSearchResultsRecord(Type fiscalPeriodSearchRecordType)	Gets the fiscal period search results record corresponding to the given fiscal period 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

getFiscalPeriods

FiscalPeriodList getFiscalPeriods()

Gets the fiscal period list resulting from a search.

Returns:

the fiscal period list

Throws:

IllegalStateException - the fiscal period list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodQueryInspector

FiscalPeriodQueryInspector getFiscalPeriodQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodSearchResultsRecord

FiscalPeriodSearchResultsRecord getFiscalPeriodSearchResultsRecord(Type fiscalPeriodSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

fiscalPeriodSearchRecordType - a fiscal period search record type

Returns:

the fiscal period search results record

Throws:

NullArgumentException - fiscalPeriodSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(fiscalPeriodSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.