OSID Logo
OSID Specifications
billing package
Version 3.1.0
Interfaceosid.billing.EntrySearchSession
Implementsosid.billing.EntryQuerySession
Used Byosid.billing.BillingManager
osid.billing.BillingProxyManager
Description

This session provides methods for searching among Entries. The search query is constructed using the EntryQuery.

getEntriesByQuery() is the basic search method and returns a list of Entrys. A more advanced search may be performed with getEntrysBySearch(). It accepts an EntrySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getEntriesBySearch() returns an EntrySearchResults that can be used to access the resulting EntryList or be used to perform a search within the result set through EntrySearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetEntrySearch
Description

Gets an entry search.

Returnosid.billing.EntrySearch the entry search
Compliancemandatory This method must be implemented.
MethodgetEntrySearchOrder
Description

Gets an entry search order. The EntrySearchOrder is supplied to an EntrySearch to specify the ordering of results.

Returnosid.billing.EntrySearchOrder the entry search order
Compliancemandatory This method must be implemented.
MethodgetEntriesBySearch
Description

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

Parametersosid.billing.EntryQueryentryQuery the entry query
osid.billing.EntrySearchentrySearch the entry search
Returnosid.billing.EntrySearchResults the entry search results
ErrorsNULL_ARGUMENT entryQuery or entrySearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED entryQuery or entrySearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetEntryQueryFromInspector
Description

Gets an entry query from an inspector. The inspector is available from an EntrySearchResults.

Parametersosid.billing.EntryQueryInspectorentryQueryInspector an entry query inspector
Returnosid.billing.EntryQuery the entry query
ErrorsNULL_ARGUMENT entryQueryInspector is null
UNSUPPORTED entryQueryInspector is not of this service
Compliancemandatory This method must be implemented.