org.osid.assessment.authoring

Interface AssessmentAuthoringProxyManager

All Superinterfaces:

AssessmentAuthoringProfile, java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable

public interface AssessmentAuthoringProxyManager
extends OsidProxyManager, AssessmentAuthoringProfile

The assessment authoring manager provides access to assessment authoring sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

• AssessmentPartLookupSession: a session to retrieve assessment part
• AssessmentPartQuerySession: a session to query for assessment part
• AssessmentPartSearchSession: a session to search for assessment part
• AssessmentPartAdminSession: a session to create and delete assessment part
• AssessmentPartNotificationSession: a session to receive notifications pertaining to assessment part changes
• AssessmentPartBankSession: a session to look up assessment part bank mappings
• AssessmentPartBankAssignmentSession: a session to manage assessment part to bank mappings
• AssessmentPartSmartBankSession: a session to manage dynamic bank of assessment part
• AssessmentPartItemSession: a session to look up assessment part to item mappings
• AssessmentPartItemDesignSession: a session to map items to assessment parts

• SequenceRuleLookupSession: a session to retrieve sequence rule
• SequenceRuleQuerySession: a session to query for sequence rule
• SequenceRuleSearchSession: a session to search for sequence rule
• SequenceRuleAdminSession: a session to create and delete sequence rule
• SequenceRuleNotificationSession: a session to receive notifications pertaining to sequence rule changes
• SequenceRuleBankSession: a session to look up sequence rule bank mappings
• SequenceRuleBankAssignmentSession: a session to manage sequence rule to bank mappings
• SequenceRuleSmartBankSession: a session to manage dynamic bank of sequence rule

• SequenceRuleEnablerLookupSession: a session to retrieve sequence rule enablers
• SequenceRuleEnablerQuerySession: a session to query for sequence rule enablers
• SequenceRuleEnablerSearchSession: a session to search for sequence rule enablers
• SequenceRuleEnablerAdminSession: a session to create and delete sequence rule enablers
• SequenceRuleEnablerNotificationSession: a session to receive notifications pertaining to sequence rule enabler changes
• SequenceRuleEnablerBankSession: a session to look up sequence rule enabler bank mappings
• SequenceRuleEnablerBankAssignmentSession: a session to manage sequence rule enabler to bank mappings
• SequenceRuleEnablerSmartBankSession: a session to manage dynamic bank of sequence rule enablers
• SequenceRuleEnableRuleLookupSession: a session to look up sequence rule enabler mappings
• SequenceRuleEnablerRuleApplicationSession: a session to apply sequence rule enablers

Method Summary

Methods

Modifier and Type	Method and Description
AssessmentPartAdminSession	getAssessmentPartAdminSession(Proxy proxy) Gets the OsidSession associated with the assessment part administration service.
AssessmentPartAdminSession	getAssessmentPartAdminSessionForBank(Id bankId, Proxy proxy) Gets the OsidSession associated with the assessment part administration service for the given bank.
AssessmentPartBankAssignmentSession	getAssessmentPartBankAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning assessment part to bank.
AssessmentPartBankSession	getAssessmentPartBankSession(Proxy proxy) Gets the OsidSession to lookup assessment part/bank mappings for assessment parts.
AssessmentPartLookupSession	getAssessmentPartLookupSession(Proxy proxy) Gets the OsidSession associated with the assessment part lookup service.
AssessmentPartLookupSession	getAssessmentPartLookupSessionForBank(Id bankId, Proxy proxy) Gets the OsidSession associated with the assessment part lookup service for the given bank.
AssessmentPartNotificationSession	getAssessmentPartNotificationSession(AssessmentPartReceiver assessmentPartReceiver, Proxy proxy) Gets the OsidSession associated with the assessment part notification service.
AssessmentPartNotificationSession	getAssessmentPartNotificationSessionForBank(AssessmentPartReceiver assessmentPartReceiver, Id bankId, Proxy proxy) Gets the OsidSession associated with the assessment part notification service for the given bank.
AssessmentPartQuerySession	getAssessmentPartQuerySession(Proxy proxy) Gets the OsidSession associated with the assessment part query service.
AssessmentPartQuerySession	getAssessmentPartQuerySessionForBank(Id bankId, Proxy proxy) Gets the OsidSession associated with the assessment part query service for the given bank.
AssessmentPartSearchSession	getAssessmentPartSearchSession(Proxy proxy) Gets the OsidSession associated with the assessment part search service.
AssessmentPartSearchSession	getAssessmentPartSearchSessionForBank(Id bankId, Proxy proxy) Gets the OsidSession associated with the assessment part earch service for the given bank.
AssessmentPartSmartBankSession	getAssessmentPartSmartBankSession(Id bankId, Proxy proxy) Gets the OsidSession to manage assessment part smart bank.
SequenceRuleAdminSession	getSequenceRuleAdminSession(Proxy proxy) Gets the OsidSession associated with the sequence rule administration service.
SequenceRuleAdminSession	getSequenceRuleAdminSessionForBank(Id bankId, Proxy proxy) Gets the OsidSession associated with the sequence rule administration service for the given bank.
SequenceRuleBankAssignmentSession	getSequenceRuleBankAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning sequence rule to bank.
SequenceRuleBankSession	getSequenceRuleBankSession(Proxy proxy) Gets the OsidSession to lookup sequence rule/bank mappings for sequence rules.
SequenceRuleEnablerAdminSession	getSequenceRuleEnablerAdminSession(Proxy proxy) Gets the OsidSession associated with the sequence rule enabler administration service.
SequenceRuleEnablerAdminSession	getSequenceRuleEnablerAdminSessionForBank(Id bankId, Proxy proxy) Gets the OsidSession associated with the sequence rule enabler administration service for the given bank.
SequenceRuleEnablerBankAssignmentSession	getSequenceRuleEnablerBankAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning sequence rule enablers to bank.
SequenceRuleEnablerBankSession	getSequenceRuleEnablerBankSession(Proxy proxy) Gets the OsidSession to lookup sequence rule enabler/bank mappings for sequence rule enablers.
SequenceRuleEnablerLookupSession	getSequenceRuleEnablerLookupSession(Proxy proxy) Gets the OsidSession associated with the sequence rule enabler lookup service.
SequenceRuleEnablerLookupSession	getSequenceRuleEnablerLookupSessionForBank(Id bankId, Proxy proxy) Gets the OsidSession associated with the sequence rule enabler lookup service for the given bank.
SequenceRuleEnablerNotificationSession	getSequenceRuleEnablerNotificationSession(SequenceRuleEnablerReceiver sequenceRuleEnablerReceiver, Proxy proxy) Gets the OsidSession associated with the sequence rule enabler notification service.
SequenceRuleEnablerNotificationSession	getSequenceRuleEnablerNotificationSessionForBank(SequenceRuleEnablerReceiver sequenceRuleEnablerReceiver, Id bankId, Proxy proxy) Gets the OsidSession associated with the sequence rule enabler notification service for the given bank.
SequenceRuleEnablerQuerySession	getSequenceRuleEnablerQuerySession(Proxy proxy) Gets the OsidSession associated with the sequence rule enabler query service.
SequenceRuleEnablerQuerySession	getSequenceRuleEnablerQuerySessionForBank(Id bankId, Proxy proxy) Gets the OsidSession associated with the sequence rule enabler query service for the given bank.
SequenceRuleEnablerRuleApplicationSession	getSequenceRuleEnablerRuleApplicationSession(Proxy proxy) Gets the OsidSession associated with the sequence rule enabler assignment service.
SequenceRuleEnablerRuleApplicationSession	getSequenceRuleEnablerRuleApplicationSessionForBank(Id bankId, Proxy proxy) Gets the OsidSession associated with the sequence rule enabler assignment service for the given bank.
SequenceRuleEnablerRuleLookupSession	getSequenceRuleEnablerRuleLookupSession(Proxy proxy) Gets the OsidSession associated with the sequence rule enabler mapping lookup service .
SequenceRuleEnablerRuleLookupSession	getSequenceRuleEnablerRuleLookupSessionForBank(Id bankId, Proxy proxy) Gets the OsidSession associated with the sequence rule enabler mapping lookup service for the given bank.
SequenceRuleEnablerSearchSession	getSequenceRuleEnablerSearchSession(Proxy proxy) Gets the OsidSession associated with the sequence rule enabler search service.
SequenceRuleEnablerSearchSession	getSequenceRuleEnablerSearchSessionForBank(Id bankId, Proxy proxy) Gets the OsidSession associated with the sequence rule enablers earch service for the given bank.
SequenceRuleEnablerSmartBankSession	getSequenceRuleEnablerSmartBankSession(Id bankId, Proxy proxy) Gets the OsidSession to manage sequence rule enabler smart bank.
SequenceRuleLookupSession	getSequenceRuleLookupSession(Proxy proxy) Gets the OsidSession associated with the sequence rule lookup service.
SequenceRuleLookupSession	getSequenceRuleLookupSessionForBank(Id bankId, Proxy proxy) Gets the OsidSession associated with the sequence rule lookup service for the given bank.
SequenceRuleNotificationSession	getSequenceRuleNotificationSession(SequenceRuleReceiver sequenceRuleReceiver, Proxy proxy) Gets the OsidSession associated with the sequence rule notification service.
SequenceRuleNotificationSession	getSequenceRuleNotificationSessionForBank(SequenceRuleReceiver sequenceRuleReceiver, Id bankId, Proxy proxy) Gets the OsidSession associated with the sequence rule notification service for the given bank.
SequenceRuleQuerySession	getSequenceRuleQuerySession(Proxy proxy) Gets the OsidSession associated with the sequence rule query service.
SequenceRuleQuerySession	getSequenceRuleQuerySessionForBank(Id bankId, Proxy proxy) Gets the OsidSession associated with the sequence rule query service for the given bank.
SequenceRuleSearchSession	getSequenceRuleSearchSession(Proxy proxy) Gets the OsidSession associated with the sequence rule search service.
SequenceRuleSearchSession	getSequenceRuleSearchSessionForBank(Id bankId, Proxy proxy) Gets the OsidSession associated with the sequence rule earch service for the given bank.
SequenceRuleSmartBankSession	getSequenceRuleSmartBankSession(Id bankId, Proxy proxy) Gets the OsidSession to manage sequence rule smart bank.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.assessment.authoring.AssessmentAuthoringProfile

getAssessmentPartRecordTypes, getAssessmentPartSearchRecordTypes, getSequenceRuleEnablerRecordTypes, getSequenceRuleEnablerSearchRecordTypes, getSequenceRuleRecordTypes, getSequenceRuleSearchRecordTypes, supportsAssessmentPartAdmin, supportsAssessmentPartBank, supportsAssessmentPartBankAssignment, supportsAssessmentPartItem, supportsAssessmentPartItemDesign, supportsAssessmentPartLookup, supportsAssessmentPartNotification, supportsAssessmentPartQuery, supportsAssessmentPartRecordType, supportsAssessmentPartSearch, supportsAssessmentPartSearchRecordType, supportsAssessmentPartSmartBank, supportsSequenceRuleAdmin, supportsSequenceRuleBank, supportsSequenceRuleBankAssignment, supportsSequenceRuleEnablerAdmin, supportsSequenceRuleEnablerBank, supportsSequenceRuleEnablerBankAssignment, supportsSequenceRuleEnablerLookup, supportsSequenceRuleEnablerNotification, supportsSequenceRuleEnablerQuery, supportsSequenceRuleEnablerRecordType, supportsSequenceRuleEnablerRuleApplication, supportsSequenceRuleEnablerRuleLookup, supportsSequenceRuleEnablerSearch, supportsSequenceRuleEnablerSearchRecordType, supportsSequenceRuleEnablerSmartBank, supportsSequenceRuleLookup, supportsSequenceRuleNotification, supportsSequenceRuleQuery, supportsSequenceRuleRecordType, supportsSequenceRuleSearch, supportsSequenceRuleSearchRecordType, supportsSequenceRuleSmartBank, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getAssessmentPartLookupSession

AssessmentPartLookupSession getAssessmentPartLookupSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the assessment part lookup service.

Parameters:

proxy - a proxy

Returns:

an AssessmentPartLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartLookup() is false

Compliance:

optional - This method must be implemented if supportsAssessmentPartLookup() is true.

getAssessmentPartLookupSessionForBank

AssessmentPartLookupSession getAssessmentPartLookupSessionForBank(Id bankId,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

Gets the OsidSession associated with the assessment part lookup service for the given bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

an AssessmentPartLookupSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAssessmentPartLookup() and supportsVisibleFederation() are true.

getAssessmentPartQuerySession

AssessmentPartQuerySession getAssessmentPartQuerySession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the assessment part query service.

Parameters:

proxy - a proxy

Returns:

an AssessmentPartQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartQuery() is false

Compliance:

optional - This method must be implemented if supportsAssessmentPartQuery() is true.

getAssessmentPartQuerySessionForBank

AssessmentPartQuerySession getAssessmentPartQuerySessionForBank(Id bankId,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets the OsidSession associated with the assessment part query service for the given bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

an AssessmentPartQuerySession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAssessmentPartQuery() and supportsVisibleFederation() are true.

getAssessmentPartSearchSession

AssessmentPartSearchSession getAssessmentPartSearchSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the assessment part search service.

Parameters:

proxy - a proxy

Returns:

an AssessmentPartSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartSearch() is false

Compliance:

optional - This method must be implemented if supportsAssessmentPartSearch() is true.

getAssessmentPartSearchSessionForBank

AssessmentPartSearchSession getAssessmentPartSearchSessionForBank(Id bankId,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

Gets the OsidSession associated with the assessment part earch service for the given bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

an AssessmentPartSearchSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAssessmentPartSearch() and supportsVisibleFederation() are true.

getAssessmentPartAdminSession

AssessmentPartAdminSession getAssessmentPartAdminSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the assessment part administration service.

Parameters:

proxy - a proxy

Returns:

an AssessmentPartAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartAdmin() is false

Compliance:

optional - This method must be implemented if supportsAssessmentPartAdmin() is true.

getAssessmentPartAdminSessionForBank

AssessmentPartAdminSession getAssessmentPartAdminSessionForBank(Id bankId,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets the OsidSession associated with the assessment part administration service for the given bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

an AssessmentPartAdminSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAssessmentPartAdmin() and supportsVisibleFederation() are true.

getAssessmentPartNotificationSession

AssessmentPartNotificationSession getAssessmentPartNotificationSession(AssessmentPartReceiver assessmentPartReceiver,
                                                                     Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with the assessment part notification service.

Parameters:

assessmentPartReceiver - the notification callback

proxy - a proxy

Returns:

an AssessmentPartNotificationSession

Throws:

NullArgumentException - assessmentPartReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartNotification() is false

Compliance:

optional - This method must be implemented if supportsAssessmentPartNotification() is true.

getAssessmentPartNotificationSessionForBank

AssessmentPartNotificationSession getAssessmentPartNotificationSessionForBank(AssessmentPartReceiver assessmentPartReceiver,
                                                                            Id bankId,
                                                                            Proxy proxy)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException

Gets the OsidSession associated with the assessment part notification service for the given bank.

Parameters:

assessmentPartReceiver - the notification callback

bankId - the Id of the Bank

proxy - a proxy

Returns:

an AssessmentPartNotificationSession

Throws:

NotFoundException - no bank found by the given Id

NullArgumentException - assessmentPartReceiver, bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAssessmentPartNotification() and supportsVisibleFederation() are true.

getAssessmentPartBankSession

AssessmentPartBankSession getAssessmentPartBankSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession to lookup assessment part/bank mappings for assessment parts.

Parameters:

proxy - a proxy

Returns:

an AssessmentPartBankSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartBank() is false

Compliance:

optional - This method must be implemented if supportsAssessmentPartBank() is true.

getAssessmentPartBankAssignmentSession

AssessmentPartBankAssignmentSession getAssessmentPartBankAssignmentSession(Proxy proxy)
                                                                           throws OperationFailedException

Gets the OsidSession associated with assigning assessment part to bank.

Parameters:

proxy - a proxy

Returns:

an AssessmentPartBankAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartBankAssignment() is false

Compliance:

optional - This method must be implemented if supportsAssessmentPartBankAssignment() is true.

getAssessmentPartSmartBankSession

AssessmentPartSmartBankSession getAssessmentPartSmartBankSession(Id bankId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession to manage assessment part smart bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

an AssessmentPartSmartBankSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartSmartBank() is false

Compliance:

optional - This method must be implemented if supportsAssessmentPartSmartBank() is true.

getSequenceRuleLookupSession

SequenceRuleLookupSession getSequenceRuleLookupSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the sequence rule lookup service.

Parameters:

proxy - a proxy

Returns:

a SequenceRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleLookup() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleLookup() is true.

getSequenceRuleLookupSessionForBank

SequenceRuleLookupSession getSequenceRuleLookupSessionForBank(Id bankId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the sequence rule lookup service for the given bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

a SequenceRuleLookupSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleLookup() and supportsVisibleFederation() are true.

getSequenceRuleQuerySession

SequenceRuleQuerySession getSequenceRuleQuerySession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the sequence rule query service.

Parameters:

proxy - a proxy

Returns:

a SequenceRuleQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleQuery() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleQuery() is true.

getSequenceRuleQuerySessionForBank

SequenceRuleQuerySession getSequenceRuleQuerySessionForBank(Id bankId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

Gets the OsidSession associated with the sequence rule query service for the given bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

a SequenceRuleQuerySession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleQuery() and supportsVisibleFederation() are true.

getSequenceRuleSearchSession

SequenceRuleSearchSession getSequenceRuleSearchSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the sequence rule search service.

Parameters:

proxy - a proxy

Returns:

a SequenceRuleSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleSearch() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleSearch() is true.

getSequenceRuleSearchSessionForBank

SequenceRuleSearchSession getSequenceRuleSearchSessionForBank(Id bankId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the sequence rule earch service for the given bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

a SequenceRuleSearchSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleSearch() and supportsVisibleFederation() are true.

getSequenceRuleAdminSession

SequenceRuleAdminSession getSequenceRuleAdminSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the sequence rule administration service.

Parameters:

proxy - a proxy

Returns:

a SequenceRuleAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleAdmin() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleAdmin() is true.

getSequenceRuleAdminSessionForBank

SequenceRuleAdminSession getSequenceRuleAdminSessionForBank(Id bankId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

Gets the OsidSession associated with the sequence rule administration service for the given bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

a SequenceRuleAdminSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleAdmin() and supportsVisibleFederation() are true.

getSequenceRuleNotificationSession

SequenceRuleNotificationSession getSequenceRuleNotificationSession(SequenceRuleReceiver sequenceRuleReceiver,
                                                                 Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the sequence rule notification service.

Parameters:

sequenceRuleReceiver - the notification callback

proxy - a proxy

Returns:

a SequenceRuleNotificationSession

Throws:

NullArgumentException - sequenceRuleReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleNotification() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleNotification() is true.

getSequenceRuleNotificationSessionForBank

SequenceRuleNotificationSession getSequenceRuleNotificationSessionForBank(SequenceRuleReceiver sequenceRuleReceiver,
                                                                        Id bankId,
                                                                        Proxy proxy)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

Gets the OsidSession associated with the sequence rule notification service for the given bank.

Parameters:

sequenceRuleReceiver - the notification callback

bankId - the Id of the Bank

proxy - a proxy

Returns:

a SequenceRuleNotificationSession

Throws:

NotFoundException - no bank found by the given Id

NullArgumentException - sequenceRuleReceiver, bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleNotification() and supportsVisibleFederation() are true.

getSequenceRuleBankSession

SequenceRuleBankSession getSequenceRuleBankSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession to lookup sequence rule/bank mappings for sequence rules.

Parameters:

proxy - a proxy

Returns:

a SequenceRuleBankSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleBank() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleBank() is true.

getSequenceRuleBankAssignmentSession

SequenceRuleBankAssignmentSession getSequenceRuleBankAssignmentSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with assigning sequence rule to bank.

Parameters:

proxy - a proxy

Returns:

a SequenceRuleBankAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleBankAssignment() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleBankAssignment() is true.

getSequenceRuleSmartBankSession

SequenceRuleSmartBankSession getSequenceRuleSmartBankSession(Id bankId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession to manage sequence rule smart bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

a SequenceRuleSmartBankSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleSmartBank() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleSmartBank() is true.

getSequenceRuleEnablerLookupSession

SequenceRuleEnablerLookupSession getSequenceRuleEnablerLookupSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the sequence rule enabler lookup service.

Parameters:

proxy - a proxy

Returns:

a SequenceRuleEnablerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerLookup() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerLookup() is true.

getSequenceRuleEnablerLookupSessionForBank

SequenceRuleEnablerLookupSession getSequenceRuleEnablerLookupSessionForBank(Id bankId,
                                                                          Proxy proxy)
                                                                            throws NotFoundException,
                                                                                   OperationFailedException

Gets the OsidSession associated with the sequence rule enabler lookup service for the given bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

a SequenceRuleEnablerLookupSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerLookup() and supportsVisibleFederation() are true.

getSequenceRuleEnablerQuerySession

SequenceRuleEnablerQuerySession getSequenceRuleEnablerQuerySession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the sequence rule enabler query service.

Parameters:

proxy - a proxy

Returns:

a SequenceRuleEnablerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerQuery() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerQuery() is true.

getSequenceRuleEnablerQuerySessionForBank

SequenceRuleEnablerQuerySession getSequenceRuleEnablerQuerySessionForBank(Id bankId,
                                                                        Proxy proxy)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

Gets the OsidSession associated with the sequence rule enabler query service for the given bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

a SequenceRuleEnablerQuerySession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerQuery() and supportsVisibleFederation() are true.

getSequenceRuleEnablerSearchSession

SequenceRuleEnablerSearchSession getSequenceRuleEnablerSearchSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the sequence rule enabler search service.

Parameters:

proxy - a proxy

Returns:

a SequenceRuleEnablerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerSearch() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerSearch() is true.

getSequenceRuleEnablerSearchSessionForBank

SequenceRuleEnablerSearchSession getSequenceRuleEnablerSearchSessionForBank(Id bankId,
                                                                          Proxy proxy)
                                                                            throws NotFoundException,
                                                                                   OperationFailedException

Gets the OsidSession associated with the sequence rule enablers earch service for the given bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

a SequenceRuleEnablerSearchSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerSearch() and supportsVisibleFederation() are true.

getSequenceRuleEnablerAdminSession

SequenceRuleEnablerAdminSession getSequenceRuleEnablerAdminSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the sequence rule enabler administration service.

Parameters:

proxy - a proxy

Returns:

a SequenceRuleEnablerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerAdmin() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerAdmin() is true.

getSequenceRuleEnablerAdminSessionForBank

SequenceRuleEnablerAdminSession getSequenceRuleEnablerAdminSessionForBank(Id bankId,
                                                                        Proxy proxy)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

Gets the OsidSession associated with the sequence rule enabler administration service for the given bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

a SequenceRuleEnablerAdminSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerAdmin() and supportsVisibleFederation() are true.

getSequenceRuleEnablerNotificationSession

SequenceRuleEnablerNotificationSession getSequenceRuleEnablerNotificationSession(SequenceRuleEnablerReceiver sequenceRuleEnablerReceiver,
                                                                               Proxy proxy)
                                                                                 throws OperationFailedException

Gets the OsidSession associated with the sequence rule enabler notification service.

Parameters:

sequenceRuleEnablerReceiver - the notification callback

proxy - a proxy

Returns:

a SequenceRuleEnablerNotificationSession

Throws:

NullArgumentException - sequenceRuleEnablerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerNotification() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerNotification() is true.

getSequenceRuleEnablerNotificationSessionForBank

SequenceRuleEnablerNotificationSession getSequenceRuleEnablerNotificationSessionForBank(SequenceRuleEnablerReceiver sequenceRuleEnablerReceiver,
                                                                                      Id bankId,
                                                                                      Proxy proxy)
                                                                                        throws NotFoundException,
                                                                                               OperationFailedException

Gets the OsidSession associated with the sequence rule enabler notification service for the given bank.

Parameters:

sequenceRuleEnablerReceiver - the notification callback

bankId - the Id of the Bank

proxy - a proxy

Returns:

a SequenceRuleEnablerNotificationSession

Throws:

NotFoundException - no bank found by the given Id

NullArgumentException - sequenceRuleEnablerReceiver, bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerNotification() and supportsVisibleFederation() are true.

getSequenceRuleEnablerBankSession

SequenceRuleEnablerBankSession getSequenceRuleEnablerBankSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession to lookup sequence rule enabler/bank mappings for sequence rule enablers.

Parameters:

proxy - a proxy

Returns:

a SequenceRuleEnablerBankSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerBank() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerBank() is true.

getSequenceRuleEnablerBankAssignmentSession

SequenceRuleEnablerBankAssignmentSession getSequenceRuleEnablerBankAssignmentSession(Proxy proxy)
                                                                                     throws OperationFailedException

Gets the OsidSession associated with assigning sequence rule enablers to bank.

Parameters:

proxy - a proxy

Returns:

a SequenceRuleEnablerBankAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerBankAssignment() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerBankAssignment() is true.

getSequenceRuleEnablerSmartBankSession

SequenceRuleEnablerSmartBankSession getSequenceRuleEnablerSmartBankSession(Id bankId,
                                                                         Proxy proxy)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

Gets the OsidSession to manage sequence rule enabler smart bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

a SequenceRuleEnablerSmartBankSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerSmartBank() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerSmartBank() is true.

getSequenceRuleEnablerRuleLookupSession

SequenceRuleEnablerRuleLookupSession getSequenceRuleEnablerRuleLookupSession(Proxy proxy)
                                                                             throws OperationFailedException

Gets the OsidSession associated with the sequence rule enabler mapping lookup service .

Parameters:

proxy - a proxy

Returns:

a SequenceRuleEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerRuleLookup() is true.

getSequenceRuleEnablerRuleLookupSessionForBank

SequenceRuleEnablerRuleLookupSession getSequenceRuleEnablerRuleLookupSessionForBank(Id bankId,
                                                                                  Proxy proxy)
                                                                                    throws NotFoundException,
                                                                                           OperationFailedException

Gets the OsidSession associated with the sequence rule enabler mapping lookup service for the given bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

a SequenceRuleEnablerRuleLookupSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerRuleLookup() and supportsVisibleFederation() are true.

getSequenceRuleEnablerRuleApplicationSession

SequenceRuleEnablerRuleApplicationSession getSequenceRuleEnablerRuleApplicationSession(Proxy proxy)
                                                                                       throws OperationFailedException

Gets the OsidSession associated with the sequence rule enabler assignment service.

Parameters:

proxy - a proxy

Returns:

a SequenceRuleEnablerRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerRuleApplication() is true.

getSequenceRuleEnablerRuleApplicationSessionForBank

SequenceRuleEnablerRuleApplicationSession getSequenceRuleEnablerRuleApplicationSessionForBank(Id bankId,
                                                                                            Proxy proxy)
                                                                                              throws NotFoundException,
                                                                                                     OperationFailedException

Gets the OsidSession associated with the sequence rule enabler assignment service for the given bank.

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

a SequenceRuleEnablerRuleApplicationSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSequenceRuleEnablerRuleApplication() and supportsVisibleFederation() are true.