Interface CreditBillingSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CreditBillingSession
extends OsidSession

This session provides methods to retrieve Credit to Billing mappings. A Credit may appear in multiple Billings . Each Billing may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupCreditBillingMappings()	Tests if this user can perform lookups of credit/billing mappings.
IdList	getBillingIdsByCredit(Id creditId)	Gets the list of Billing Ids mapped to a Credit .
BillingList	getBillingsByCredit(Id creditId)	Gets the list of Billing objects mapped to a Credit .
IdList	getCreditIdsByBilling(Id billingId)	Gets the list of Credit Ids associated with a Billing .
IdList	getCreditIdsByBillings(IdList billingIds)	Gets the list of Credit Ids corresponding to a list of Billing objects.
CreditList	getCreditsByBilling(Id billingId)	Gets the list of Credits associated with a Billing .
CreditList	getCreditsByBillings(IdList billingIds)	Gets the list of Credits corresponding to a list of Billings .
void	useComparativeBillingView()	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	usePlenaryBillingView()	A complete view of the Credit and Billing returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupCreditBillingMappings

boolean canLookupCreditBillingMappings()

Tests if this user can perform lookups of credit/billing mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeBillingView

void useComparativeBillingView()

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.

usePlenaryBillingView

void usePlenaryBillingView()

A complete view of the Credit and Billing 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.

getCreditIdsByBilling

IdList getCreditIdsByBilling(Id billingId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Credit Ids associated with a Billing .

Parameters:

billingId - Id of a Billings .

Returns:

list of related credit Ids

Throws:

NotFoundException - billingId is not found

NullArgumentException - billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCreditsByBilling

CreditList getCreditsByBilling(Id billingId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Credits associated with a Billing .

Parameters:

billingId - Id of a Billing

Returns:

list of related credits

Throws:

NotFoundException - billingId is not found

NullArgumentException - billingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCreditIdsByBillings

IdList getCreditIdsByBillings(IdList billingIds)
                       throws OperationFailedException,
PermissionDeniedException

Gets the list of Credit Ids corresponding to a list of Billing objects.

Parameters:

billingIds - list of billing Ids

Returns:

list of credit Ids

Throws:

NullArgumentException - billingIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCreditsByBillings

CreditList getCreditsByBillings(IdList billingIds)
                         throws OperationFailedException,
PermissionDeniedException

Gets the list of Credits corresponding to a list of Billings .

Parameters:

billingIds - list of billing Ids

Returns:

list of credits

Throws:

NullArgumentException - billingIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBillingIdsByCredit

IdList getBillingIdsByCredit(Id creditId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Billing Ids mapped to a Credit .

Parameters:

creditId - Id of a Credit

Returns:

list of billing Ids

Throws:

NotFoundException - creditId is not found

NullArgumentException - creditId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBillingsByCredit

BillingList getBillingsByCredit(Id creditId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Billing objects mapped to a Credit .

Parameters:

creditId - Id of a Credit

Returns:

list of billings

Throws:

NotFoundException - creditId is not found

NullArgumentException - creditId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.