org.osid.financials.posting

Interface PostEntrySmartBusinessSession

All Superinterfaces:

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

public interface PostEntrySmartBusinessSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A PostEntryQuery can be retrieved from this session and mapped to this Business to create a virtual collection of PostEntries. The post entries may be sequenced using the PostEntrySearchOrder from this session.

This Business has a default query that matches any post entry and a default search order that specifies no sequencing. The queries may be examined using a PostEntryQueryInspector. The query may be modified by converting the inspector back to a PostEntryQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyPostEntryQuery(PostEntryQuery postEntryQuery) Applies a post entry query to this business.
void	applyPostEntrySequencing(PostEntrySearchOrder postEntrySearchOrder) Applies a post entry search order to this business.
boolean	canManageSmartBusinesses() Tests if this user can manage smart businesses.
Business	getBusiness() Gets the Business associated with this session.
Id	getBusinessId() Gets the Business Id associated with this session.
PostEntryQuery	getPostEntryQuery() Gets a post entry query.
PostEntryQuery	getPostEntryQueryFromInspector(PostEntryQueryInspector postEntryQueryInspector) Gets a post entry query from an inspector.
PostEntrySearchOrder	getPostEntrySearchOrder() Gets a post entry search order.
PostEntryQueryInspector	inspectPostEntryQuery() Gets a post entry query inspector for this 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

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.

canManageSmartBusinesses

boolean canManageSmartBusinesses()

Tests if this user can manage smart businesses. A return of true does not guarantee successful assessment. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart business management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getPostEntryQuery

PostEntryQuery getPostEntryQuery()

Gets a post entry query.

Returns:

the post entry query

Compliance:

mandatory - This method must be implemented.

getPostEntrySearchOrder

PostEntrySearchOrder getPostEntrySearchOrder()

Gets a post entry search order.

Returns:

the post entry search order

Compliance:

mandatory - This method must be implemented.

applyPostEntryQuery

void applyPostEntryQuery(PostEntryQuery postEntryQuery)
                         throws OperationFailedException,
                                PermissionDeniedException

Applies a post entry query to this business.

Parameters:

postEntryQuery - the post entry query

Throws:

NullArgumentException - postEntryQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - postEntryQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectPostEntryQuery

PostEntryQueryInspector inspectPostEntryQuery()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets a post entry query inspector for this business.

Returns:

the post entry query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyPostEntrySequencing

void applyPostEntrySequencing(PostEntrySearchOrder postEntrySearchOrder)
                              throws OperationFailedException,
                                     PermissionDeniedException

Applies a post entry search order to this business.

Parameters:

postEntrySearchOrder - the post entry search order

Throws:

NullArgumentException - postEntrySearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - postEntrySearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getPostEntryQueryFromInspector

PostEntryQuery getPostEntryQueryFromInspector(PostEntryQueryInspector postEntryQueryInspector)

Gets a post entry query from an inspector.

Parameters:

postEntryQueryInspector - a query inspector

Returns:

the post entry query

Throws:

NullArgumentException - postEntryQueryInspector is null

UnsupportedException - postEntryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.