org.osid.financials.posting

Interface PostEntryQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

PostEntrySearchSession

public interface PostEntryQuerySession
extends OsidSession

This session provides methods for searching among PostEntry objects. The search query is constructed using the PostEntryQuery.

This session defines views that offer differing behaviors for searching.

• federated business view: searches include post entries in businesses of which this business is an ancestor in the business hierarchy
• isolated business view: searches are restricted to post entries in this business

PostPost Entries may have a query record indicated by their respective record types. The query record is accessed via the PostEntryQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchPostEntries() 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	getPostEntriesByQuery(PostEntryQuery postEntryQuery) Gets a list of PostEntries matching the given post entry query.
PostEntryQuery	getPostEntryQuery() Gets a post entry query.
void	useFederatedBusinessView() Federates the view for methods in this session.
void	useIsolatedBusinessView() Isolates the view for methods in this session.

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.

canSearchPostEntries

boolean canSearchPostEntries()

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 not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedBusinessView

void useFederatedBusinessView()

Federates the view for methods in this session. A federated view will include post entries in business 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.

getPostEntryQuery

PostEntryQuery getPostEntryQuery()

Gets a post entry query.

Returns:

the post entry query

Compliance:

mandatory - This method must be implemented.

getPostEntriesByQuery

PostEntryList getPostEntriesByQuery(PostEntryQuery postEntryQuery)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a list of PostEntries matching the given post entry query.

Parameters:

postEntryQuery - the post entry query

Returns:

the returned PostEntryList

Throws:

NullArgumentException - postEntryQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - postEntryQuery is not of this service

Compliance:

mandatory - This method must be implemented.