OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.BusinessLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving Business objects.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Businesses it can access, without breaking execution. However, an assessment may only be useful if all Businesses referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

MethodcanLookupBusinesses
Description

Tests if this user can perform Business lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeBusinessView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryBusinessView
Description

A complete view of the Business returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetBusiness
Description

Gets the Business specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Business may have a different Id than requested, such as the case where a duplicate Id was assigned to a Business and retained for compatibility.

Parametersosid.id.IdbusinessId Id of the Business
Returnosid.financials.Businessthe business
ErrorsNOT_FOUND businessId not found
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetBusinessesByIds
Description

Gets a BusinessList corresponding to the given IdList. In plenary mode, the returned list contains all of the businesses specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Businesses may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListbusinessIdsthe list of Ids to retrieve
Returnosid.financials.BusinessListthe returned Business list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT businessIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBusinessesByGenusType
Description

Gets a BusinessList corresponding to the given business genus Type which does not include businesses of types derived from the specified Type. In plenary mode, the returned list contains all known businesses or an error results. Otherwise, the returned list may contain only those businesses that are accessible through this session.

Parametersosid.type.TypebusinessGenusTypea business genus type
Returnosid.financials.BusinessListthe returned Business list
ErrorsNULL_ARGUMENT businessGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBusinessesByParentGenusType
Description

Gets a BusinessList corresponding to the given business genus Type and include any additional businesses with genus types derived from the specified Type. In plenary mode, the returned list contains all known businesses or an error results. Otherwise, the returned list may contain only those businesses that are accessible through this session.

Parametersosid.type.TypebusinessGenusTypea business genus type
Returnosid.financials.BusinessListthe returned Business list
ErrorsNULL_ARGUMENT businessGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBusinessesByRecordType
Description

Gets a BusinessList containing the given business record Type. In plenary mode, the returned list contains all known businesses or an error results. Otherwise, the returned list may contain only those businesses that are accessible through this session.

Parametersosid.type.TypebusinessRecordTypea business record type
Returnosid.financials.BusinessListthe returned Business list
ErrorsNULL_ARGUMENT businessRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBusinessesByProvider
Description

Gets a BusinessList for the given provider. In plenary mode, the returned list contains all known businesses or an error results. Otherwise, the returned list may contain only those businesses that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.financials.BusinessListthe returned Business list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBusinesses
Description

Gets all Businesses. In plenary mode, the returned list contains all known businesses or an error results. Otherwise, the returned list may contain only those businesses that are accessible through this session.

Returnosid.financials.BusinessLista list of Businesses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.