org.osid.assessment.authoring

Interface SequenceRuleEnablerSmartBankSession

All Superinterfaces:

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

public interface SequenceRuleEnablerSmartBankSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic bank. a SequenceRuleEnablerQuery can be retrieved from this session and mapped to this Bank to create a virtual collection of sequence rule enablers. The sequence rule enablers may be sequenced using the SequenceRuleEnablerSearchOrder from this session.

This Bank has a default query that matches any sequence rule enabler and a default search order that specifies no sequencing. The queries may be examined using a SequenceRuleEnablerQueryInspector. The query may be modified by converting the inspector back to a SequenceRuleEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applySequenceRuleEnablerQuery(SequenceRuleEnablerQuery sequenceRuleEnablerQuery) Applies a sequence rule enabler query to this bank.
void	applySequenceRuleEnablerSequencing(SequenceRuleEnablerSearchOrder sequenceRuleEnablerSearchOrder) Applies a sequence rule enabler search order to this bank.
boolean	canManageSmartBanks() Tests if this user can manage smart bank.
Bank	getBank() Gets the Bank associated with this session.
Id	getBankId() Gets the Bank Id associated with this session.
SequenceRuleEnablerQuery	getSequenceRuleEnablerQuery() Gets a sequence rule enabler query.
SequenceRuleEnablerQuery	getSequenceRuleEnablerQueryFromInspector(SequenceRuleEnablerQueryInspector sequenceRuleEnablerQueryInspector) Gets a sequence rule enabler query from an inspector.
SequenceRuleEnablerSearchOrder	getSequenceRuleEnablerSearchOrder() Gets a sequence rule enabler search order.
SequenceRuleEnablerQueryInspector	inspectSequenceRuleEnablerQuery() Gets a sequence rule enabler query inspector for this bank.

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.

canManageSmartBanks

boolean canManageSmartBanks()

Tests if this user can manage smart bank. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart bank management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getSequenceRuleEnablerQuery

SequenceRuleEnablerQuery getSequenceRuleEnablerQuery()

Gets a sequence rule enabler query.

Returns:

the sequence rule enabler query

Compliance:

mandatory - This method must be implemented.

getSequenceRuleEnablerSearchOrder

SequenceRuleEnablerSearchOrder getSequenceRuleEnablerSearchOrder()

Gets a sequence rule enabler search order.

Returns:

the sequence rule enabler search order

Compliance:

mandatory - This method must be implemented.

applySequenceRuleEnablerQuery

void applySequenceRuleEnablerQuery(SequenceRuleEnablerQuery sequenceRuleEnablerQuery)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Applies a sequence rule enabler query to this bank.

Parameters:

sequenceRuleEnablerQuery - the sequence rule enabler query

Throws:

NullArgumentException - sequenceRuleEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - sequenceRuleEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectSequenceRuleEnablerQuery

SequenceRuleEnablerQueryInspector inspectSequenceRuleEnablerQuery()
                                                                  throws OperationFailedException,
                                                                         PermissionDeniedException

Gets a sequence rule enabler query inspector for this bank.

Returns:

the sequence rule enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applySequenceRuleEnablerSequencing

void applySequenceRuleEnablerSequencing(SequenceRuleEnablerSearchOrder sequenceRuleEnablerSearchOrder)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Applies a sequence rule enabler search order to this bank.

Parameters:

sequenceRuleEnablerSearchOrder - the sequence rule enabler search order

Throws:

NullArgumentException - sequenceRuleEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - sequenceRuleEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getSequenceRuleEnablerQueryFromInspector

SequenceRuleEnablerQuery getSequenceRuleEnablerQueryFromInspector(SequenceRuleEnablerQueryInspector sequenceRuleEnablerQueryInspector)

Gets a sequence rule enabler query from an inspector.

Parameters:

sequenceRuleEnablerQueryInspector - a sequence rule enabler query inspector

Returns:

the sequence rule enabler query

Throws:

NullArgumentException - sequenceRuleEnablerQueryInspector is null

UnsupportedException - sequenceRuleEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.