org.osid.financials.posting

Interface PostEntryBusinessAssignmentSession

All Superinterfaces:

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

public interface PostEntryBusinessAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignPostEntryToBusiness(Id postEntryId, Id businessId) Adds an existing PostEntry to a Business.
boolean	canAssignPostEntries() Tests if this user can alter entry/business mappings.
boolean	canAssignPostEntriesToBusiness(Id businessId) Tests if this user can alter entry/business mappings.
IdList	getAssignableBusinessIds(Id businessId) Gets a list of businesses including and under the given business node in which any post entry can be assigned.
IdList	getAssignableBusinessIdsForPostEntry(Id businessId, Id postEntryId) Gets a list of businesses including and under the given business node in which a specific post entry can be assigned.
void	unassignPostEntryFromBusiness(Id postEntryId, Id businessId) Removes a PostEntry from a Business.

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

canAssignPostEntries

boolean canAssignPostEntries()

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

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignPostEntriesToBusiness

boolean canAssignPostEntriesToBusiness(Id businessId)

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

Parameters:

businessId - the Id of the Business

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - businessId is null

Compliance:

mandatory - This method must be implemented.

getAssignableBusinessIds

IdList getAssignableBusinessIds(Id businessId)
                                throws OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

list of assignable business Ids

Throws:

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableBusinessIdsForPostEntry

IdList getAssignableBusinessIdsForPostEntry(Id businessId,
                                          Id postEntryId)
                                            throws OperationFailedException

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

Parameters:

businessId - the Id of the Business

postEntryId - the Id of the PostEntry

Returns:

list of assignable business Ids

Throws:

NullArgumentException - businessId or postEntryId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignPostEntryToBusiness

void assignPostEntryToBusiness(Id postEntryId,
                             Id businessId)
                               throws AlreadyExistsException,
                                      NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Adds an existing PostEntry to a Business.

Parameters:

postEntryId - the Id of the PostEntry

businessId - the Id of the Business

Throws:

AlreadyExistsException - postEntryId is already assigned to businessId

NotFoundException - postEntryId or businessId not found

NullArgumentException - postEntryId or businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignPostEntryFromBusiness

void unassignPostEntryFromBusiness(Id postEntryId,
                                 Id businessId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Removes a PostEntry from a Business.

Parameters:

postEntryId - the Id of the PostEntry

businessId - the Id of the Business

Throws:

NotFoundException - postEntryId or businessId not found or postEntryId not assigned to businessId

NullArgumentException - postEntryId or businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.