Interface SequenceRuleEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SequenceRuleEnablerLookupSession
extends OsidSession

This session provides methods for retrieving SequenceRuleEnablers .

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 bank view: All sequence rule enabler methods in this session operate, retrieve and pertain to sequence rule enablers defined explicitly in the current bank. Using an isolated view is useful for managing SequenceRuleEnablers with the SequenceRuleEnablerAdminSession .
• federated bank view: All sequence rule enabler methods in this session operate, retrieve and pertain to all sequence rule enablers defined in this bank and any other sequence rule enablers implicitly available in this bank through bank inheritence.
• active sequence rule enabler view: All sequence rule enabler lookup methods return active sequence rule enablers.
• any active sequence rule enabler view: sequence rule enablers of any active or inactive status 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 useFederatedBankView() and useIsolatedBankView() behave as a radio group and one should be selected before invoking the methods in this session.

Method Summary

Modifier and Type	Method	Description
boolean	canLookupSequenceRuleEnablers()	Tests if this user can perform SequenceRuleEnablers lookups.
Bank	getBank()	Gets the Bank associated with this session.
Id	getBankId()	Gets the Bank Id associated with this session.
SequenceRuleEnabler	getSequenceRuleEnabler(Id sequenceRuleEnablerId)	Gets the SequenceRuleEnabler specified by its Id .
SequenceRuleEnablerList	getSequenceRuleEnablers()	Gets all SequenceRuleEnablers .
SequenceRuleEnablerList	getSequenceRuleEnablersByGenusType(Type sequenceRuleEnablerGenusType)	Gets a SequenceRuleEnablerList corresponding to the given sequence rule enabler genus Type which does not include sequence rule enablers of genus types derived from the specified Type .
SequenceRuleEnablerList	getSequenceRuleEnablersByIds(IdList sequenceRuleEnablerIds)	Gets a SequenceRuleEnablerList corresponding to the given IdList .
SequenceRuleEnablerList	getSequenceRuleEnablersByParentGenusType(Type sequenceRuleEnablerGenusType)	Gets a SequenceRuleEnablerList corresponding to the given sequence rule enabler genus Type and include any additional sequence rule enablers with genus types derived from the specified Type .
SequenceRuleEnablerList	getSequenceRuleEnablersByRecordType(Type sequenceRuleEnablerRecordType)	Gets a SequenceRuleEnablerList containing the given sequence rule enabler record Type .
SequenceRuleEnablerList	getSequenceRuleEnablersOnDate(DateTime from, DateTime to)	Gets a SequenceRuleEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.
SequenceRuleEnablerList	getSequenceRuleEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets a SequenceRuleEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.
void	useActiveSequenceRuleEnablerView()	Only active sequence rule enablers are returned by methods in this session.
void	useAnyStatusSequenceRuleEnablerView()	All active and inactive sequence rule enablers are returned by methods in this session.
void	useComparativeSequenceRuleEnablerView()	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	useFederatedBankView()	Federates the view for methods in this session.
void	useIsolatedBankView()	Isolates the view for methods in this session.
void	usePlenarySequenceRuleEnablerView()	A complete view of the SequenceRuleEnabler 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

getBankId

Id getBankId()

Gets the Bank Id associated with this session.

Returns:

the Bank Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBank

Bank getBank()
      throws OperationFailedException,
PermissionDeniedException

Gets the Bank associated with this session.

Returns:

the bank

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupSequenceRuleEnablers

boolean canLookupSequenceRuleEnablers()

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

useComparativeSequenceRuleEnablerView

void useComparativeSequenceRuleEnablerView()

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.

usePlenarySequenceRuleEnablerView

void usePlenarySequenceRuleEnablerView()

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

useFederatedBankView

void useFederatedBankView()

Federates the view for methods in this session. A federated view will include sequence rule enablers in banks which are children of this bank in the bank hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedBankView

void useIsolatedBankView()

Isolates the view for methods in this session. An isolated view restricts lookups to this bank only.

Compliance:

mandatory - This method is must be implemented.

useActiveSequenceRuleEnablerView

void useActiveSequenceRuleEnablerView()

Only active sequence rule enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusSequenceRuleEnablerView

void useAnyStatusSequenceRuleEnablerView()

All active and inactive sequence rule enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getSequenceRuleEnabler

SequenceRuleEnabler getSequenceRuleEnabler(Id sequenceRuleEnablerId)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the SequenceRuleEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned SequenceRuleEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a SequenceRuleEnabler and retained for compatibility. In active mode, sequence rule enablers are returned that are currently active. In any status mode, active and inactive sequence rule enablers are returned.

Parameters:

sequenceRuleEnablerId - Id of the SequenceRuleEnabler

Returns:

the sequence rule enabler

Throws:

NotFoundException - sequenceRuleEnablerId not found

NullArgumentException - sequenceRuleEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getSequenceRuleEnablersByIds

SequenceRuleEnablerList getSequenceRuleEnablersByIds(IdList sequenceRuleEnablerIds)
                                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a SequenceRuleEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the sequence rule enablers specified in the Id list, in the order of the list, including duplicates, or an error results if a Id in the supplied list is not found or inaccessible. Otherwise, inaccessible SequenceRuleEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, sequence rule enablers are returned that are currently active. In any status mode, active and inactive sequence rule enablers are returned.

Parameters:

sequenceRuleEnablerIds - the list of Ids to retrieve

Returns:

the returned SequenceRuleEnabler list

Throws:

NotFoundException - a Id was not found

NullArgumentException - sequenceRuleEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSequenceRuleEnablersByGenusType

SequenceRuleEnablerList getSequenceRuleEnablersByGenusType(Type sequenceRuleEnablerGenusType)
                                                    throws OperationFailedException,
PermissionDeniedException

Gets a SequenceRuleEnablerList corresponding to the given sequence rule enabler genus Type which does not include sequence rule enablers of genus types derived from the specified Type . In plenary mode, the returned list contains all known sequence rule enablers or an error results. Otherwise, the returned list may contain only those sequence rule enablers that are accessible through this session. In active mode, sequence rule enablers are returned that are currently active. In any status mode, active and inactive sequence rule enablers are returned.

Parameters:

sequenceRuleEnablerGenusType - a sequence rule enabler genus type

Returns:

the returned SequenceRuleEnabler list

Throws:

NullArgumentException - sequenceRuleEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSequenceRuleEnablersByParentGenusType

SequenceRuleEnablerList getSequenceRuleEnablersByParentGenusType(Type sequenceRuleEnablerGenusType)
                                                          throws OperationFailedException,
PermissionDeniedException

Gets a SequenceRuleEnablerList corresponding to the given sequence rule enabler genus Type and include any additional sequence rule enablers with genus types derived from the specified Type . In plenary mode, the returned list contains all known sequence rule enablers or an error results. Otherwise, the returned list may contain only those sequence rule enablers that are accessible through this session. In active mode, sequence rule enablers are returned that are currently active. In any status mode, active and inactive sequence rule enablers are returned.

Parameters:

sequenceRuleEnablerGenusType - a sequence rule enabler genus type

Returns:

the returned SequenceRuleEnabler list

Throws:

NullArgumentException - sequenceRuleEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSequenceRuleEnablersByRecordType

SequenceRuleEnablerList getSequenceRuleEnablersByRecordType(Type sequenceRuleEnablerRecordType)
                                                     throws OperationFailedException,
PermissionDeniedException

Gets a SequenceRuleEnablerList containing the given sequence rule enabler record Type . In plenary mode, the returned list contains all known sequence rule enablers or an error results. Otherwise, the returned list may contain only those sequence rule enablers that are accessible through this session. In active mode, sequence rule enablers are returned that are currently active. In any status mode, active and inactive sequence rule enablers are returned.

Parameters:

sequenceRuleEnablerRecordType - a sequence rule enabler record type

Returns:

the returned SequenceRuleEnabler list

Throws:

NullArgumentException - sequenceRuleEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSequenceRuleEnablersOnDate

SequenceRuleEnablerList getSequenceRuleEnablersOnDate(DateTime from,
 DateTime to)
                                               throws OperationFailedException,
PermissionDeniedException

Gets a SequenceRuleEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known sequence rule enablers or an error results. Otherwise, the returned list may contain only those sequence rule enablers that are accessible through this session. In active mode, sequence rule enablers are returned that are currently active. In any status mode, active and inactive sequence rule enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

the returned SequenceRuleEnabler list

Throws:

InvalidArgumentException - from is greater tha to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSequenceRuleEnablersOnDateWithAgent

SequenceRuleEnablerList getSequenceRuleEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                                        throws OperationFailedException,
PermissionDeniedException

Gets a SequenceRuleEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known sequence rule enablers or an error results. Otherwise, the returned list may contain only those sequence rule enablers that are accessible through this session. In active mode, sequence rule enablers are returned that are currently active. In any status mode, active and inactive sequence rule enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned SequenceRuleEnabler list

Throws:

InvalidArgumentException - from is greater tha to

NullArgumentException - agentId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSequenceRuleEnablers

SequenceRuleEnablerList getSequenceRuleEnablers()
                                         throws OperationFailedException,
PermissionDeniedException

Gets all SequenceRuleEnablers . In plenary mode, the returned list contains all known sequence rule enablers or an error results. Otherwise, the returned list may contain only those sequence rule enablers that are accessible through this session. In active mode, sequence rule enablers are returned that are currently active. In any status mode, active and inactive sequence rule enablers are returned.

Returns:

the returned SequenceRuleEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.