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

This session provides methods to re-assign FiscalPeriods to Business objects A FiscalPeriod may appear in multiple Business objects and removing the last reference to a FiscalPeriod 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 a FiscalPeriod to another Business is not a copy operation (eg: does not change its Id ).

MethodcanAssignFiscalPeriods
Description

Tests if this user can alter fiscal period/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.
MethodcanAssignFiscalPeriodToBusiness
Description

Tests if this user can alter fiscal period/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 fiscal period 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.
MethodgetAssignableBusinessIdsForFiscalPeriod
Description

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

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.id.IdfiscalPeriodIdthe Id of the FiscalPeriod
Returnosid.id.IdListlist of assignable business Ids
ErrorsNULL_ARGUMENT businessId or fiscalPeriodId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignFiscalPeriodToBusiness
Description

Adds an existing FiscalPeriod to a Business.

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

Removes a FiscalPeriod from a Business.

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