Interface SequenceRuleBankSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SequenceRuleBankSession
extends OsidSession

This session provides methods to retrieve SequenceRule to Bank mappings. a SequenceRule may appear in multiple Bank objects. Each bank 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	canLookupSequenceRuleBankMappings()	Tests if this user can perform lookups of sequence rule/bank mappings.
IdList	getBankIdsBySequenceRule(Id sequenceRuleId)	Gets the Bank Ids mapped to a SequenceRule .
BankList	getBanksBySequenceRule(Id sequenceRuleId)	Gets the Banks mapped to a SequenceRule .
IdList	getSequenceRuleIdsByBank(Id bankId)	Gets the list of SequenceRuleIds associated with a Bank .
IdList	getSequenceRuleIdsByBanks(IdList bankIds)	Gets the list of SequenceRule Ids corresponding to a list of Banks .
SequenceRuleList	getSequenceRulesByBank(Id bankId)	Gets the list of sequence rule associated with a Bank .
SequenceRuleList	getSequenceRulesByBanks(IdList bankIds)	Gets the list of sequence rule corresponding to a list of Banks .
void	useComparativeSequenceRuleBankView()	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	usePlenarySequenceRuleBankView()	A complete view of the SequenceRule and Bank 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

canLookupSequenceRuleBankMappings

boolean canLookupSequenceRuleBankMappings()

Tests if this user can perform lookups of sequence rule/bank 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 intended as 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.

useComparativeSequenceRuleBankView

void useComparativeSequenceRuleBankView()

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.

usePlenarySequenceRuleBankView

void usePlenarySequenceRuleBankView()

A complete view of the SequenceRule and Bank 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.

getSequenceRuleIdsByBank

IdList getSequenceRuleIdsByBank(Id bankId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of SequenceRuleIds associated with a Bank .

Parameters:

bankId - Id of the Bank

Returns:

list of related sequence rule Ids

Throws:

NotFoundException - bankId is not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSequenceRulesByBank

SequenceRuleList getSequenceRulesByBank(Id bankId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of sequence rule associated with a Bank .

Parameters:

bankId - Id of the Bank

Returns:

list of related sequence rules

Throws:

NotFoundException - bankId is not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSequenceRuleIdsByBanks

IdList getSequenceRuleIdsByBanks(IdList bankIds)
                          throws OperationFailedException,
PermissionDeniedException

Gets the list of SequenceRule Ids corresponding to a list of Banks .

Parameters:

bankIds - list of bank Ids

Returns:

list of sequence rule Ids

Throws:

NullArgumentException - bankIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSequenceRulesByBanks

SequenceRuleList getSequenceRulesByBanks(IdList bankIds)
                                  throws OperationFailedException,
PermissionDeniedException

Gets the list of sequence rule corresponding to a list of Banks .

Parameters:

bankIds - list of bank Ids

Returns:

list of sequence rules

Throws:

NullArgumentException - bankIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBankIdsBySequenceRule

IdList getBankIdsBySequenceRule(Id sequenceRuleId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Bank Ids mapped to a SequenceRule .

Parameters:

sequenceRuleId - Id of a SequenceRule

Returns:

list of banks

Throws:

NotFoundException - sequenceRuleId is not found

NullArgumentException - sequenceRuleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBanksBySequenceRule

BankList getBanksBySequenceRule(Id sequenceRuleId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Banks mapped to a SequenceRule .

Parameters:

sequenceRuleId - Id of a SequenceRule

Returns:

list of banks

Throws:

NotFoundException - sequenceRuleId is not found

NullArgumentException - sequenceRuleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.