OSID Logo
OSID Specifications
financials package
Version 3.1.0
Interfaceosid.financials.FiscalPeriodBusinessAssignmentSession
Implementsosid.OsidSession
Used Byosid.financials.FinancialsManager
osid.financials.FinancialsProxyManager
Description

This session provides methods to re-assign FiscalPeriods to Businesses. A FiscalPeriod may appear in multiple Businesses 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
Compliancemandatory This 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.IdbusinessId the Id of the Business
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT businessId is null
Compliancemandatory This 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.IdbusinessId the Id of the Business
Returnosid.id.IdList list of assignable business Ids
ErrorsNULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This 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.IdbusinessId the Id of the Business
osid.id.IdfiscalPeriodId the Id of the FiscalPeriod
Returnosid.id.IdList list of assignable business Ids
ErrorsNULL_ARGUMENT businessId or fiscalPeriodId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignFiscalPeriodToBusiness
Description

Adds an existing FiscalPeriod to a Business.

Parametersosid.id.IdfiscalPeriodId the Id of the FiscalPeriod
osid.id.IdbusinessId the 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_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignFiscalPeriodFromBusiness
Description

Removes a FiscalPeriod from a Business.

Parametersosid.id.IdfiscalPeriodId the Id of the FiscalPeriod
osid.id.IdbusinessId the 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_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignFiscalPeriodToBusiness
Description

Moves a FiscalPeriod from one Business to another. Mappings to other Businesses are unaffected.

Parametersosid.id.IdfiscalPeriodId the Id of the FiscalPeriod
osid.id.IdfromBusinessId the Id of the current Business
osid.id.IdtoBusinessId the Id of the destination Business
ErrorsALREADY_EXISTS fiscalPeriodId already assigned to toB usinessId
NOT_FOUND fiscalPeriodId,, fromBusinessId, or toBusinessId not found or fiscalPeriodId, not mapped to fromBusinessId
NULL_ARGUMENT fiscalPeriodId,, fromBusinessId, or toBusinessId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.