org.osid.billing

Interface EntryLookupSession

All Superinterfaces:

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

public interface EntryLookupSession
extends OsidSession

This session provides methods for retrieving Entry objects.

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 entry methods in this session operate, retrieve and pertain to entries defined explicitly in the current business. Using an isolated view is useful for managing Entries with the EntryAdminSession.
• federated business view: All entry methods in this session operate, retrieve and pertain to all entries defined in this business and any other entries implicitly available in this business through business inheritence.
• effective entry view: All entry lookup methods return entries where the current date falls in between the effective dates inclusive.
• any effective entry view: Entries of any effective date are returned from methods.

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	canLookupEntries() Tests if this user can perform Entry lookups.
Business	getBusiness() Gets the Business associated with this session.
Id	getBusinessId() Gets the Business Id associated with this session.
EntryList	getEntries() Gets all Entries.
EntryList	getEntriesByGenusType(Type entryGenusType) Gets an EntryList corresponding to the given entry genus Type which does not include entries of genus types derived from the specified Type.
EntryList	getEntriesByIds(IdList entryIds) Gets an EntryList corresponding to the given IdList.
EntryList	getEntriesByParentGenusType(Type entryGenusType) Gets an EntryList corresponding to the given entry genus Type and include any additional entries with genus types derived from the specified Type.
EntryList	getEntriesByPeriod(Id periodId) Gets an EntryList in the given billing period.
EntryList	getEntriesByPeriodForCustomer(Id customerId, Id periodId) Gets an EntryList for the given customer in a billing period.
EntryList	getEntriesByPeriodForCustomerAndItem(Id customerId, Id itemId, Id periodId) Gets an EntryList for the given customer and item in a billing period.
EntryList	getEntriesByPeriodForCustomerAndItemOnDate(Id customerId, Id itemId, Id periodId, DateTime from, DateTime to) Gets an EntryList for the given customer and item in a billing period and effective during the entire given date range inclusive but not confined to the date range.
EntryList	getEntriesByPeriodForCustomerOnDate(Id customerId, Id periodId, DateTime from, DateTime to) Gets an EntryList in the given billing period for the given customer and effective during the entire given date range inclusive but not confined to the date range.
EntryList	getEntriesByPeriodForItem(Id itemId, Id periodId) Gets an EntryList for the given item in a billing period.
EntryList	getEntriesByPeriodForItemOnDate(Id itemId, Id periodId, DateTime from, DateTime to) Gets an EntryList in the given billing period for the given item and effective during the entire given date range inclusive but not confined to the date range.
EntryList	getEntriesByRecordType(Type entryRecordType) Gets an EntryList containing the given entry record Type.
EntryList	getEntriesForCustomer(Id customerId) Gets an EntryList for the given customer.
EntryList	getEntriesForCustomerAndItem(Id customerId, Id itemId) Gets an EntryList for the given customer and item.
EntryList	getEntriesForCustomerAndItemOnDate(Id customerId, Id itemId, DateTime from, DateTime to) Gets an EntryList for the given customer and item and effective during the entire given date range inclusive but not confined to the date range.
EntryList	getEntriesForCustomerOnDate(Id customerId, DateTime from, DateTime to) Gets an EntryList for the given customer and effective during the entire given date range inclusive but not confined to the date range.
EntryList	getEntriesForItem(Id itemId) Gets an EntryList for the given item.
EntryList	getEntriesForItemOnDate(Id itemId, DateTime from, DateTime to) Gets an EntryList for the given item and effective during the entire given date range inclusive but not confined to the date range.
EntryList	getEntriesOnDate(DateTime from, DateTime to) Gets an EntryList effective during the entire given date range inclusive but not confined to the date range.
Entry	getEntry(Id entryId) Gets the Entry specified by its Id.
void	useAnyEffectiveEntryView() All entries of any effective dates are returned by methods in this session.
void	useComparativeEntryView() 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	useEffectiveEntryView() Only entries whose effective dates are current are returned by methods in this session.
void	useFederatedBusinessView() Federates the view for methods in this session.
void	useIsolatedBusinessView() Isolates the view for methods in this session.
void	usePlenaryEntryView() A complete view of the Entry 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.

canLookupEntries

boolean canLookupEntries()

Tests if this user can perform Entry 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.

useComparativeEntryView

void useComparativeEntryView()

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.

usePlenaryEntryView

void usePlenaryEntryView()

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

useEffectiveEntryView

void useEffectiveEntryView()

Only entries whose effective dates are current are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveEntryView

void useAnyEffectiveEntryView()

All entries of any effective dates are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getEntry

Entry getEntry(Id entryId)
               throws NotFoundException,
                      OperationFailedException,
                      PermissionDeniedException

Gets the Entry specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Entry may have a different Id than requested, such as the case where a duplicate Id was assigned to an Entry and retained for compatibility. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.

Parameters:

entryId - Id of the Entry

Returns:

the entry

Throws:

NotFoundException - entryId not found

NullArgumentException - entryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getEntriesByIds

EntryList getEntriesByIds(IdList entryIds)
                          throws NotFoundException,
                                 OperationFailedException,
                                 PermissionDeniedException

Gets an EntryList corresponding to the given IdList. In plenary mode, the returned list contains all of the 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 Entries may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.

Parameters:

entryIds - the list of Ids to retrieve

Returns:

the returned Entry list

Throws:

NotFoundException - an Id was not found

NullArgumentException - entryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByGenusType

EntryList getEntriesByGenusType(Type entryGenusType)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

entryGenusType - an entry genus type

Returns:

the returned Entry list

Throws:

NullArgumentException - entryGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByParentGenusType

EntryList getEntriesByParentGenusType(Type entryGenusType)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

entryGenusType - an entry genus type

Returns:

the returned Entry list

Throws:

NullArgumentException - entryGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByRecordType

EntryList getEntriesByRecordType(Type entryRecordType)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets an EntryList containing the given entry record Type. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.

Parameters:

entryRecordType - an entry record type

Returns:

the returned Entry list

Throws:

NullArgumentException - entryRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByPeriod

EntryList getEntriesByPeriod(Id periodId)
                             throws OperationFailedException,
                                    PermissionDeniedException

Gets an EntryList in the given billing period. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.

Parameters:

periodId - a billing period Id

Returns:

the returned Entry list

Throws:

NullArgumentException - periodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesOnDate

EntryList getEntriesOnDate(DateTime from,
                         DateTime to)
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets an EntryList effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective entries and those currently expired are returned.

Parameters:

from - start of date range

to - end of date range

Returns:

the returned Entry 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.

getEntriesForCustomer

EntryList getEntriesForCustomer(Id customerId)
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets an EntryList for the given customer. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.

Parameters:

customerId - a customer Id

Returns:

the returned Entry list

Throws:

NullArgumentException - customerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesForCustomerOnDate

EntryList getEntriesForCustomerOnDate(Id customerId,
                                    DateTime from,
                                    DateTime to)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets an EntryList for the given customer and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective entries and those currently expired are returned.

Parameters:

customerId - a customer Id

from - start of date range

to - end of date range

Returns:

the returned Entry list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - customerId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByPeriodForCustomer

EntryList getEntriesByPeriodForCustomer(Id customerId,
                                      Id periodId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets an EntryList for the given customer in a billing period. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.

Parameters:

customerId - a customer Id

periodId - a billing period Id

Returns:

the returned Entry list

Throws:

NullArgumentException - customerId or periodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByPeriodForCustomerOnDate

EntryList getEntriesByPeriodForCustomerOnDate(Id customerId,
                                            Id periodId,
                                            DateTime from,
                                            DateTime to)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets an EntryList in the given billing period for the given customer and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective entries and those currently expired are returned.

Parameters:

customerId - a customer Id

periodId - a billing period Id

from - start of date range

to - end of date range

Returns:

the returned Entry list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - customerId, periodId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesForItem

EntryList getEntriesForItem(Id itemId)
                            throws OperationFailedException,
                                   PermissionDeniedException

Gets an EntryList for the given item. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.

Parameters:

itemId - an item Id

Returns:

the returned Entry list

Throws:

NullArgumentException - itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesForItemOnDate

EntryList getEntriesForItemOnDate(Id itemId,
                                DateTime from,
                                DateTime to)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Gets an EntryList for the given item and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective entries and those currently expired are returned.

Parameters:

itemId - an item Id

from - start of date range

to - end of date range

Returns:

the returned Entry list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - itemId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByPeriodForItem

EntryList getEntriesByPeriodForItem(Id itemId,
                                  Id periodId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets an EntryList for the given item in a billing period. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.

Parameters:

itemId - an item Id

periodId - a billing period Id

Returns:

the returned Entry list

Throws:

NullArgumentException - itemId or periodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByPeriodForItemOnDate

EntryList getEntriesByPeriodForItemOnDate(Id itemId,
                                        Id periodId,
                                        DateTime from,
                                        DateTime to)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets an EntryList in the given billing period for the given item and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective entries and those currently expired are returned.

Parameters:

itemId - an item Id

periodId - a billing period Id

from - start of date range

to - end of date range

Returns:

the returned Entry list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - itemId, periodId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesForCustomerAndItem

EntryList getEntriesForCustomerAndItem(Id customerId,
                                     Id itemId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets an EntryList for the given customer and item. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.

Parameters:

customerId - a customer Id

itemId - an item Id

Returns:

the returned Entry list

Throws:

NullArgumentException - customerId or itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesForCustomerAndItemOnDate

EntryList getEntriesForCustomerAndItemOnDate(Id customerId,
                                           Id itemId,
                                           DateTime from,
                                           DateTime to)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Gets an EntryList for the given customer and item and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective entries and those currently expired are returned.

Parameters:

customerId - a customer Id

itemId - an item Id

from - start of date range

to - end of date range

Returns:

the returned Entry list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - customerId, itemId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByPeriodForCustomerAndItem

EntryList getEntriesByPeriodForCustomerAndItem(Id customerId,
                                             Id itemId,
                                             Id periodId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Gets an EntryList for the given customer and item in a billing period. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.

Parameters:

customerId - a customer Id

itemId - an item Id

periodId - a period Id

Returns:

the returned Entry list

Throws:

NullArgumentException - customerId, itemId, or periodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByPeriodForCustomerAndItemOnDate

EntryList getEntriesByPeriodForCustomerAndItemOnDate(Id customerId,
                                                   Id itemId,
                                                   Id periodId,
                                                   DateTime from,
                                                   DateTime to)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

Gets an EntryList for the given customer and item in a billing period and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective entries and those currently expired are returned.

Parameters:

customerId - a customer Id

itemId - an item Id

periodId - a period Id

from - start of date range

to - end of date range

Returns:

the returned Entry list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - customerId, itemId, periodId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntries

EntryList getEntries()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets all Entries. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.

Returns:

a list of Entries

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.