Interface FiscalPeriodSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface FiscalPeriodSearch
extends OsidSearch

The search interface for governing fiscal period searches.

Method Summary

Modifier and Type	Method	Description
FiscalPeriodSearchRecord	getFiscalPeriodSearchRecord(Type fiscalPeriodSearchRecordType)	Gets the fiscal period search record corresponding to the given fiscal period search record Type .This method is used to retrieve an object implementing the requested record.
void	orderFiscalPeriodResults(FiscalPeriodSearchOrder fiscalPeriodSearchOrder)	Specify an ordering to the search results.
void	searchAmongFiscalPeriods(IdList fiscalPeriodIds)	Execute this search among the given list of fiscal periods.

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

searchAmongFiscalPeriods

void searchAmongFiscalPeriods(IdList fiscalPeriodIds)

Execute this search among the given list of fiscal periods.

Parameters:

fiscalPeriodIds - list of fiscal periods

Throws:

NullArgumentException - fiscalPeriodIds is null

Compliance:

mandatory - This method must be implemented.

orderFiscalPeriodResults

void orderFiscalPeriodResults(FiscalPeriodSearchOrder fiscalPeriodSearchOrder)

Specify an ordering to the search results.

Parameters:

fiscalPeriodSearchOrder - a fiscal period search order

Throws:

NullArgumentException - fiscalPeriodSearchOrder is null

UnsupportedException - fiscalPeriodSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodSearchRecord

FiscalPeriodSearchRecord getFiscalPeriodSearchRecord(Type fiscalPeriodSearchRecordType)
                                              throws OperationFailedException

Gets the fiscal period search 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 discal period search record type

Returns:

the fiscal period search record

Throws:

NullArgumentException - fiscalPeriodSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(fiscalPeriodSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.