org.osid.financials.budgeting

Interface BudgetEntryBusinessSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface BudgetEntryBusinessSession
extends OsidSession

This session provides methods to retrieve BudgetEntry to Business mappings. An BudgetEntry 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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupBudgetEntryBusinessMappings() Tests if this user can perform lookups of entry/business mappings.
BudgetEntryList	getActivitieByBusiness(Id businessId) Gets the list of BudgetEntry associated with a Business.
BudgetEntryList	getActivitieByBusinesses(IdList businessIds) Gets the list of BudgetEntries corresponding to a list of Business objects.
IdList	getBudgetEntryIdsByBusiness(Id businessId) Gets the list of BudgetEntry Ids associated with a Business.
IdList	getBudgetEntryIdsByBusinesses(IdList businessIds) Gets the list of BudgetEntry Ids corresponding to a list of Business objects.
BusinessList	getBusinessesByBudgetEntry(Id budgetEntryId) Gets the Business objects mapped to an BudgetEntry.
IdList	getBusinessIdsByBudgetEntry(Id budgetEntryId) Gets the Business Ids mapped to an BudgetEntry.
void	useComparativeBudgetEntryBusinessView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryBudgetEntryBusinessView() A complete view of the BudgetEntry and Business returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupBudgetEntryBusinessMappings

boolean canLookupBudgetEntryBusinessMappings()

Tests if this user can perform lookups of entry/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.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeBudgetEntryBusinessView

void useComparativeBudgetEntryBusinessView()

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.

Compliance:

mandatory - This method is must be implemented.

usePlenaryBudgetEntryBusinessView

void usePlenaryBudgetEntryBusinessView()

A complete view of the BudgetEntry 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.

Compliance:

mandatory - This method is must be implemented.

getBudgetEntryIdsByBusiness

IdList getBudgetEntryIdsByBusiness(Id businessId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the list of BudgetEntry Ids associated with a Business.

Parameters:

businessId - Id of the Business

Returns:

list of related budget entry Ids

Throws:

NotFoundException - businessId is not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitieByBusiness

BudgetEntryList getActivitieByBusiness(Id businessId)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Gets the list of BudgetEntry associated with a Business.

Parameters:

businessId - Id of the Business

Returns:

list of related entries

Throws:

NotFoundException - businessId is not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBudgetEntryIdsByBusinesses

IdList getBudgetEntryIdsByBusinesses(IdList businessIds)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Parameters:

businessIds - list of catalog Ids

Returns:

list of budget entry Ids

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActivitieByBusinesses

BudgetEntryList getActivitieByBusinesses(IdList businessIds)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

businessIds - list of catalog Ids

Returns:

list of entries

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessIdsByBudgetEntry

IdList getBusinessIdsByBudgetEntry(Id budgetEntryId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the Business Ids mapped to an BudgetEntry.

Parameters:

budgetEntryId - Id of an BudgetEntry

Returns:

list of businesses

Throws:

NotFoundException - budgetEntryId is not found

NullArgumentException - budgetEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessesByBudgetEntry

BusinessList getBusinessesByBudgetEntry(Id budgetEntryId)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the Business objects mapped to an BudgetEntry.

Parameters:

budgetEntryId - Id of an BudgetEntry

Returns:

list of businesses

Throws:

NotFoundException - budgetEntryId is not found

NullArgumentException - budgetEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.