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

This session provides methods to retrieve Activity to Business mappings. An Activity may appear in multiple Business objects. Each catalog may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

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

Tests if this user can perform lookups of activity/business mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeActivityBusinessView
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.
MethodusePlenaryActivityBusinessView
Description

A complete view of the Activity and 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.
MethodgetActivityIdsByBusiness
Description

Gets the list of Activity Ids associated with a Business.

Parametersosid.id.IdbusinessId Id of the Business
Returnosid.id.IdListlist of related activity Ids
ErrorsNOT_FOUND businessId is not found
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivitiesByBusiness
Description

Gets the list of Activity associated with a Business.

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

Gets the list of Activity Ids corresponding to a list of Business objects.

Parametersosid.id.IdListbusinessIdslist of catalog Ids
Returnosid.id.IdListlist of activity Ids
ErrorsNULL_ARGUMENT businessIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivitiesByBusinesses
Description

Gets the list of Activities corresponding to a list of Business objects.

Parametersosid.id.IdListbusinessIdslist of catalog Ids
Returnosid.financials.ActivityListlist of activities
ErrorsNULL_ARGUMENT businessIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBusinessIdsByActivity
Description

Gets the Business Ids mapped to an Activity.

Parametersosid.id.IdactivityId Id of an Activity
Returnosid.id.IdListlist of businesses
ErrorsNOT_FOUND activityId is not found
NULL_ARGUMENT activityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBusinessesByActivity
Description

Gets the Business objects mapped to an Activity.

Parametersosid.id.IdactivityId Id of an Activity
Returnosid.financials.BusinessListlist of businesses
ErrorsNOT_FOUND activityId is not found
NULL_ARGUMENT activityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.