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

This session provides methods to re-assign Activities to Business objects An Activity may appear in multiple Business objects and removing the last reference to an Activity is the equivalent of deleting it. Each Business may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an Activity to another Business is not a copy operation (eg: does not change its Id ).

MethodcanAssignActivities
Description

Tests if this user can alter activity/business mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignActivitiesToBusiness
Description

Tests if this user can alter activity/business mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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.

Parametersosid.id.IdbusinessIdthe Id of the Business
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT businessId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableBusinessIds
Description

Gets a list of businesses including and under the given business node in which any activity can be assigned.

Parametersosid.id.IdbusinessIdthe Id of the Business
Returnosid.id.IdListlist of assignable business Ids
ErrorsNULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableBusinessIdsForActivity
Description

Gets a list of businesses including and under the given business node in which a specific activity can be assigned.

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.id.IdactivityIdthe Id of the Activity
Returnosid.id.IdListlist of assignable business Ids
ErrorsNULL_ARGUMENT businessId or activityId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignActivityToBusiness
Description

Adds an existing Activity to a Business.

Parametersosid.id.IdactivityIdthe Id of the Activity
osid.id.IdbusinessIdthe Id of the Business
ErrorsALREADY_EXISTS activityId is already assigned to businessId
NOT_FOUND activityId or businessId not found
NULL_ARGUMENT activityId or businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignActivityFromBusiness
Description

Removes an Activity from a Business.

Parametersosid.id.IdactivityIdthe Id of the Activity
osid.id.IdbusinessIdthe Id of the Business
ErrorsNOT_FOUND activityId or businessId not found or activityId not assigned to businessId
NULL_ARGUMENT activityId or businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.