org.osid.financials.posting

Interface PostEntryLookupSession

All Superinterfaces:

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

public interface PostEntryLookupSession
extends OsidSession

This session provides methods for retrieving PostEntry objects. The PostEntry represents a period in which payers are offered.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition
• isolated business view: All post entry methods in this session operate, retrieve and pertain to post entries defined explicitly in the current business. Using an isolated view is useful for managing PostEntries with the PostEntryAdminSession.
• federated business view: All post entry methods in this session operate, retrieve and pertain to all post entries defined in this business and any other post entries implicitly available in this business through business inheritence.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedBusinessView() and useIsolatedBusinessView() behave as a radio group and one should be selected before invoking any lookup methods.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupPostEntries() Tests if this user can perform PostEntry lookups.
Business	getBusiness() Gets the Business associated with this session.
Id	getBusinessId() Gets the Business Id associated with this session.
PostEntryList	getPostEntries() Gets all PostEntries.
PostEntryList	getPostEntriesByAccount(Id accountId) Gets a PostEntryList for the given account.
PostEntryList	getPostEntriesByAccountAndActivity(Id accountId, Id activityId) Gets a PostEntryList for the given activity and account.
PostEntryList	getPostEntriesByAccountAndActivityAndFiscalPeriod(Id accountId, Id activityId, Id fiscalPeriodId) Gets a PostEntryList for the given account in a fiscal period.
PostEntryList	getPostEntriesByAccountAndFiscalPeriod(Id accountId, Id fiscalPeriodId) Gets a PostEntryList for the given account in a fiscal period.
PostEntryList	getPostEntriesByActivity(Id activityId) Gets a PostEntryList for the given activity.
PostEntryList	getPostEntriesByActivityAndFiscalPeriod(Id activityId, Id fiscalPeriodId) Gets a PostEntryList for the given activity in a fiscal period.
PostEntryList	getPostEntriesByDate(DateTime from, DateTime to) Gets a PostEntryList posted within given date range inclusive.
PostEntryList	getPostEntriesByFiscalPeriod(Id fiscalPeriodId) Gets a PostEntryList in the given fiscal period.
PostEntryList	getPostEntriesByGenusType(Type entryGenusType) Gets a PostEntryList corresponding to the given post entry genus Type which does not include post entries of genus types derived from the specified Type.
PostEntryList	getPostEntriesByIds(IdList postEntryIds) Gets a PostEntryList corresponding to the given IdList.
PostEntryList	getPostEntriesByParentGenusType(Type entryGenusType) Gets a PostEntryList corresponding to the given post entry genus Type and include any additional post entries with genus types derived from the specified Type.
PostEntryList	getPostEntriesByRecordType(Type postEntryRecordType) Gets q PostEntryList containing the given post entry record Type.
PostEntryList	getPostEntriesForPost(Id postId) Gets a PostEntryList for the given post.
PostEntry	getPostEntry(Id postEntryId) Gets the PostEntry specified by its Id.
void	useComparativePostEntryView() 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	useFederatedBusinessView() Federates the view for methods in this session.
void	useIsolatedBusinessView() Isolates the view for methods in this session.
void	usePlenaryPostEntryView() A complete view of the PostEntry 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

getBusinessId

Id getBusinessId()

Gets the Business Id associated with this session.

Returns:

the Business Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBusiness

Business getBusiness()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Business associated with this session.

Returns:

the business

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupPostEntries

boolean canLookupPostEntries()

Tests if this user can perform PostEntry lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativePostEntryView

void useComparativePostEntryView()

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.

usePlenaryPostEntryView

void usePlenaryPostEntryView()

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

useFederatedBusinessView

void useFederatedBusinessView()

Federates the view for methods in this session. A federated view will include post entries in businesses which are children of this business in the business hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedBusinessView

void useIsolatedBusinessView()

Isolates the view for methods in this session. An isolated view restricts lookups to this business only.

Compliance:

mandatory - This method is must be implemented.

getPostEntry

PostEntry getPostEntry(Id postEntryId)
                       throws NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Gets the PostEntry specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned PostEntry may have a different Id than requested, such as the case where a duplicate Id was assigned to a PostEntry and retained for compatibility.

Parameters:

postEntryId - Id of the PostEntry

Returns:

the entry

Throws:

NotFoundException - postEntryId not found

NullArgumentException - postEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getPostEntriesByIds

PostEntryList getPostEntriesByIds(IdList postEntryIds)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Gets a PostEntryList corresponding to the given IdList. In plenary mode, the returned list contains all of the post entries specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible PostEntries may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

postEntryIds - the list of Ids to retrieve

Returns:

the returned PostEntry list

Throws:

NotFoundException - an Id was not found

NullArgumentException - postEntryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostEntriesByGenusType

PostEntryList getPostEntriesByGenusType(Type entryGenusType)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets a PostEntryList corresponding to the given post entry genus Type which does not include post entries of genus types derived from the specified Type. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.

Parameters:

entryGenusType - a post entry genus type

Returns:

the returned PostEntry list

Throws:

NullArgumentException - entryGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostEntriesByParentGenusType

PostEntryList getPostEntriesByParentGenusType(Type entryGenusType)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets a PostEntryList corresponding to the given post entry genus Type and include any additional post entries with genus types derived from the specified Type. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.

Parameters:

entryGenusType - a post entry genus type

Returns:

the returned PostEntry list

Throws:

NullArgumentException - entryGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostEntriesByRecordType

PostEntryList getPostEntriesByRecordType(Type postEntryRecordType)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets q PostEntryList containing the given post entry record Type. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.

Parameters:

postEntryRecordType - a post entry record type

Returns:

the returned PostEntry list

Throws:

NullArgumentException - postEntryRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostEntriesForPost

PostEntryList getPostEntriesForPost(Id postId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a PostEntryList for the given post. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.

Parameters:

postId - a post Id

Returns:

the returned PostEntry list

Throws:

NullArgumentException - postId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostEntriesByFiscalPeriod

PostEntryList getPostEntriesByFiscalPeriod(Id fiscalPeriodId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets a PostEntryList in the given fiscal period. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.

Parameters:

fiscalPeriodId - a fiscal period Id

Returns:

the returned PostEntry list

Throws:

NullArgumentException - fiscalPeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostEntriesByDate

PostEntryList getPostEntriesByDate(DateTime from,
                                 DateTime to)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets a PostEntryList posted within given date range inclusive. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.

Parameters:

from - start of date range

to - end of date range

Returns:

the returned PostEntry list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostEntriesByAccount

PostEntryList getPostEntriesByAccount(Id accountId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets a PostEntryList for the given account. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.

Parameters:

accountId - an account Id

Returns:

the returned PostEntry list

Throws:

NullArgumentException - accountId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostEntriesByAccountAndFiscalPeriod

PostEntryList getPostEntriesByAccountAndFiscalPeriod(Id accountId,
                                                   Id fiscalPeriodId)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

Gets a PostEntryList for the given account in a fiscal period. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.

Parameters:

accountId - an account Id

fiscalPeriodId - a fiscal period Id

Returns:

the returned PostEntry list

Throws:

NullArgumentException - accountId or fiscalPeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostEntriesByActivity

PostEntryList getPostEntriesByActivity(Id activityId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets a PostEntryList for the given activity. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.

Parameters:

activityId - an activity Id

Returns:

the returned PostEntry list

Throws:

NullArgumentException - activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostEntriesByActivityAndFiscalPeriod

PostEntryList getPostEntriesByActivityAndFiscalPeriod(Id activityId,
                                                    Id fiscalPeriodId)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets a PostEntryList for the given activity in a fiscal period. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.

Parameters:

activityId - an activity Id

fiscalPeriodId - a fiscal period Id

Returns:

the returned PostEntry list

Throws:

NullArgumentException - activityId or fiscalPeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostEntriesByAccountAndActivity

PostEntryList getPostEntriesByAccountAndActivity(Id accountId,
                                               Id activityId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Gets a PostEntryList for the given activity and account. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.

Parameters:

accountId - an account Id

activityId - an activity Id

Returns:

the returned PostEntry list

Throws:

NullArgumentException - accountId or activityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostEntriesByAccountAndActivityAndFiscalPeriod

PostEntryList getPostEntriesByAccountAndActivityAndFiscalPeriod(Id accountId,
                                                              Id activityId,
                                                              Id fiscalPeriodId)
                                                                throws OperationFailedException,
                                                                       PermissionDeniedException

Gets a PostEntryList for the given account in a fiscal period. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.

Parameters:

accountId - an account Id

activityId - an activity Id

fiscalPeriodId - a fiscal period Id

Returns:

the returned PostEntry list

Throws:

NullArgumentException - accountId, activityId, or fiscalPeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPostEntries

PostEntryList getPostEntries()
                             throws OperationFailedException,
                                    PermissionDeniedException

Gets all PostEntries. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.

Returns:

a list of PostEntries

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.