OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.PeriodSearchSession
Implementsosid.billing.PeriodQuerySession
Description

This session provides methods for searching among Period objects. The search query is constructed using the PeriodQuery.

getPeriodsByQuery() is the basic search method and returns a list of Periods. A more advanced search may be performed with getPeriodsBySearch(). It accepts a PeriodSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPeriodsBySearch() returns a PeriodsSearchResults that can be used to access the resulting PeriodList or be used to perform a search within the result set through PeriodSearch.

This session defines views that offer differing behaviors for searching.

  • federated business view: searches include periods in businesses of which this business is an ancestor in the business hierarchy
  • isolated business view: searches are restricted to periods in this business

Periods may have a query record indicated by their respective record types. The query record is accessed via the PeriodQuery.

MethodgetPeriodSearch
Description

Gets a period search.

Returnosid.billing.PeriodSearchthe period search
CompliancemandatoryThis method must be implemented.
MethodgetPeriodSearchOrder
Description

Gets a period search order. The PeriodSearchOrder is supplied to a PeriodSearch to specify the ordering of results.

Returnosid.billing.PeriodSearchOrderthe period search order
CompliancemandatoryThis method must be implemented.
MethodgetPeriodsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.billing.PeriodQueryperiodQuerythe period query
osid.billing.PeriodSearchperiodSearchthe period search
Returnosid.billing.PeriodSearchResultsthe period search results
ErrorsNULL_ARGUMENT periodQuery or periodSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED periodQuery or periodSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPeriodQueryFromInspector
Description

Gets a period query from an inspector. The inspector is available from a PeriodSearchResults.

Parametersosid.billing.PeriodQueryInspectorperiodQueryInspectora period query inspector
Returnosid.billing.PeriodQuerythe period query
ErrorsNULL_ARGUMENT periodQueryInspector is null
UNSUPPORTED periodQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.