public interface FiscalPeriodSearch extends OsidSearch
The search interface for governing fiscal period searches.
Modifier and Type | Method and Description |
---|---|
FiscalPeriodSearchRecord |
getFiscalPeriodSearchRecord(Type fiscalPeriodSearchRecordType)
Gets the fiscal period search record corresponding to the given fiscal
period search record
Type. |
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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongFiscalPeriods(IdList fiscalPeriodIds)
fiscalPeriodIds
- list of fiscal periodsNullArgumentException
- fiscalPeriodIds
is null
mandatory
- This method must be implemented. void orderFiscalPeriodResults(FiscalPeriodSearchOrder fiscalPeriodSearchOrder)
fiscalPeriodSearchOrder
- a fiscal period search orderNullArgumentException
- fiscalPeriodSearchOrder
is null
UnsupportedException
- fiscalPeriodSearchOrder
is not of this servicemandatory
- This method must be implemented. FiscalPeriodSearchRecord getFiscalPeriodSearchRecord(Type fiscalPeriodSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.fiscalPeriodSearchRecordType
- a discal period search record
typeNullArgumentException
-
fiscalPeriodSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(fiscalPeriodSearchRecordType)
is
false
mandatory
- This method must be implemented.