org.osid.assessment.authoring

Interface SequenceRuleEnablerRuleLookupSession

All Superinterfaces:

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

public interface SequenceRuleEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve SequenceRuleEnabler to SequenceRule mappings. a Step with multiple SequenceRuleEnablers means any positive rule evaluation across the enablers result in an effective SequenceRule.

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
• isolated bank view: All methods in this session operate, retrieve and pertain sequence rule enablers defined explicitly in the current bank
• federated bank view: All 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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupSequenceRuleEnablerRules() Tests if this user can perform lookups of sequence rule enabler/sequence rule mappings.
Bank	getBank() Gets the Bank associated with this session.
Id	getBankId() Gets the Bank Id associated with this session.
IdList	getSequenceRuleEnablerIdsForSequenceRule(Id sequenceRuleId) Gets the SequenceRuleEnabler Id associated with a SequenceRule.
SequenceRuleEnablerList	getSequenceRuleEnablersForSequenceRule(Id sequenceRuleId) Gets the SequenceRuleEnablers associated with a SequenceRule.
IdList	getSequenceRuleIdsForSequenceRuleEnabler(Id sequenceRuleEnablerId) Gets the SequenceRule Ids mapped to a SequenceRuleEnabler.
SequenceRuleList	getSequenceRulesForSequenceRuleEnabler(Id sequenceRuleEnablerId) Gets the SequenceRules mapped to a SequenceRuleEnabler.
void	useComparativeSequenceRuleEnablerRuleView() 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	usePlenarySequenceRuleEnablerRuleView() A complete view of the SequenceRuleEnabler and SequenceRule 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

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.

canLookupSequenceRuleEnablerRules

boolean canLookupSequenceRuleEnablerRules()

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

useComparativeSequenceRuleEnablerRuleView

void useComparativeSequenceRuleEnablerRuleView()

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.

usePlenarySequenceRuleEnablerRuleView

void usePlenarySequenceRuleEnablerRuleView()

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

getSequenceRuleEnablerIdsForSequenceRule

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

Gets the SequenceRuleEnabler Id associated with a SequenceRule.

Parameters:

sequenceRuleId - Id of the SequenceRule

Returns:

the sequence rule enabler Ids

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.

getSequenceRuleEnablersForSequenceRule

SequenceRuleEnablerList getSequenceRuleEnablersForSequenceRule(Id sequenceRuleId)
                                                               throws NotFoundException,
                                                                      OperationFailedException,
                                                                      PermissionDeniedException

Gets the SequenceRuleEnablers associated with a SequenceRule.

Parameters:

sequenceRuleId - Id of the SequenceRule

Returns:

the sequence rule enablers

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.

getSequenceRuleIdsForSequenceRuleEnabler

IdList getSequenceRuleIdsForSequenceRuleEnabler(Id sequenceRuleEnablerId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the SequenceRule Ids mapped to a SequenceRuleEnabler.

Parameters:

sequenceRuleEnablerId - Id of a SequenceRuleEnabler

Returns:

list of sequence rule Ids

Throws:

NotFoundException - sequenceRuleEnablerId is not found

NullArgumentException - sequenceRuleEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSequenceRulesForSequenceRuleEnabler

SequenceRuleList getSequenceRulesForSequenceRuleEnabler(Id sequenceRuleEnablerId)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Gets the SequenceRules mapped to a SequenceRuleEnabler.

Parameters:

sequenceRuleEnablerId - Id of a SequenceRuleEnabler

Returns:

list of sequence rules

Throws:

NotFoundException - sequenceRuleEnablerId is not found

NullArgumentException - sequenceRuleEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.