Interface AssessmentAuthoringProxyManager
- All Superinterfaces:
AssessmentAuthoringProfile, AutoCloseable, Closeable, OsidProfile, OsidProxyManager, 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
Modifier and TypeMethodDescriptionGets theOsidSessionassociated with the assessment part administration service.getAssessmentPartAdminSessionForBank(Id bankId, Proxy proxy) Gets theOsidSessionassociated with the assessment part administration service for the given bank.Gets theOsidSessionassociated with assigning assessment part to bank.Gets theOsidSessionto lookup assessment part/bank mappings for assessment parts.Gets theOsidSessionfor designing assessment part and item mappings.Gets theOsidSessionfor looking up assessment part and item mappings.Gets theOsidSessionassociated with the assessment part lookup service.getAssessmentPartLookupSessionForBank(Id bankId, Proxy proxy) Gets theOsidSessionassociated with the assessment part lookup service for the given bank.getAssessmentPartNotificationSession(AssessmentPartReceiver assessmentPartReceiver, Proxy proxy) Gets theOsidSessionassociated with the assessment part notification service.getAssessmentPartNotificationSessionForBank(AssessmentPartReceiver assessmentPartReceiver, Id bankId, Proxy proxy) Gets theOsidSessionassociated with the assessment part notification service for the given bank.Gets theOsidSessionassociated with the assessment part query service.getAssessmentPartQuerySessionForBank(Id bankId, Proxy proxy) Gets theOsidSessionassociated with the assessment part query service for the given bank.Gets theOsidSessionassociated with the assessment part search service.getAssessmentPartSearchSessionForBank(Id bankId, Proxy proxy) Gets theOsidSessionassociated with the assessment part earch service for the given bank.getAssessmentPartSmartBankSession(Id bankId, Proxy proxy) Gets theOsidSessionto manage assessment part smart bank.getSequenceRuleAdminSession(Proxy proxy) Gets theOsidSessionassociated with the sequence rule administration service.getSequenceRuleAdminSessionForBank(Id bankId, Proxy proxy) Gets theOsidSessionassociated with the sequence rule administration service for the given bank.Gets theOsidSessionassociated with assigning sequence rule to bank.getSequenceRuleBankSession(Proxy proxy) Gets theOsidSessionto lookup sequence rule/bank mappings for sequence rules.Gets theOsidSessionassociated with the sequence rule enabler administration service.getSequenceRuleEnablerAdminSessionForBank(Id bankId, Proxy proxy) Gets theOsidSessionassociated with the sequence rule enabler administration service for the given bank.Gets theOsidSessionassociated with assigning sequence rule enablers to bank.Gets theOsidSessionto lookup sequence rule enabler/bank mappings for sequence rule enablers.Gets theOsidSessionassociated with the sequence rule enabler lookup service.getSequenceRuleEnablerLookupSessionForBank(Id bankId, Proxy proxy) Gets theOsidSessionassociated with the sequence rule enabler lookup service for the given bank.getSequenceRuleEnablerNotificationSession(SequenceRuleEnablerReceiver sequenceRuleEnablerReceiver, Proxy proxy) Gets theOsidSessionassociated with the sequence rule enabler notification service.getSequenceRuleEnablerNotificationSessionForBank(SequenceRuleEnablerReceiver sequenceRuleEnablerReceiver, Id bankId, Proxy proxy) Gets theOsidSessionassociated with the sequence rule enabler notification service for the given bank.Gets theOsidSessionassociated with the sequence rule enabler query service.getSequenceRuleEnablerQuerySessionForBank(Id bankId, Proxy proxy) Gets theOsidSessionassociated with the sequence rule enabler query service for the given bank.Gets theOsidSessionassociated with the sequence rule enabler assignment service.getSequenceRuleEnablerRuleApplicationSessionForBank(Id bankId, Proxy proxy) Gets theOsidSessionassociated with the sequence rule enabler assignment service for the given bank.Gets theOsidSessionassociated with the sequence rule enabler mapping lookup service .getSequenceRuleEnablerRuleLookupSessionForBank(Id bankId, Proxy proxy) Gets theOsidSessionassociated with the sequence rule enabler mapping lookup service for the given bank.Gets theOsidSessionassociated with the sequence rule enabler search service.getSequenceRuleEnablerSearchSessionForBank(Id bankId, Proxy proxy) Gets theOsidSessionassociated with the sequence rule enablers earch service for the given bank.getSequenceRuleEnablerSmartBankSession(Id bankId, Proxy proxy) Gets theOsidSessionto manage sequence rule enabler smart bank.Gets theOsidSessionassociated with the sequence rule lookup service.getSequenceRuleLookupSessionForBank(Id bankId, Proxy proxy) Gets theOsidSessionassociated with the sequence rule lookup service for the given bank.getSequenceRuleNotificationSession(SequenceRuleReceiver sequenceRuleReceiver, Proxy proxy) Gets theOsidSessionassociated with the sequence rule notification service.getSequenceRuleNotificationSessionForBank(SequenceRuleReceiver sequenceRuleReceiver, Id bankId, Proxy proxy) Gets theOsidSessionassociated with the sequence rule notification service for the given bank.getSequenceRuleQuerySession(Proxy proxy) Gets theOsidSessionassociated with the sequence rule query service.getSequenceRuleQuerySessionForBank(Id bankId, Proxy proxy) Gets theOsidSessionassociated with the sequence rule query service for the given bank.Gets theOsidSessionassociated with the sequence rule search service.getSequenceRuleSearchSessionForBank(Id bankId, Proxy proxy) Gets theOsidSessionassociated with the sequence rule earch service for the given bank.getSequenceRuleSmartBankSession(Id bankId, Proxy proxy) Gets theOsidSessionto manage sequence rule smart bank.Methods inherited from interface 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, supportsVisibleFederationModifier and TypeMethodDescriptionGets the supportedAssessmentPartrecord types.Gets the supportedAssessmentPartsearch record types.Gets the supportedSequenceRuleEnablerrecord types.Gets the supportedSequenceRuleEnablersearch record types.Gets the supportedSequenceRulerecord types.Gets the supportedSequenceRulesearch record types.booleanTests if an assessment part administrative service is supported.booleanTests if an assessment part bank lookup service is supported.booleanTests if an assessment part bank service is supported.booleanTests if an assessment part item service is supported for looking up assessment part and item mappings.booleanTests if an assessment part item design session is supported.booleanTests if looking up assessment part is supported.booleanTests if an assessment part notification service is supported.booleanTests if querying assessment part is supported.booleansupportsAssessmentPartRecordType(Type assessmentPartRecordType) Tests if the givenAssessmentPartrecord type is supported.booleanTests if searching assessment part is supported.booleansupportsAssessmentPartSearchRecordType(Type assessmentPartSearchRecordType) Tests if the givenAssessmentPartsearch record type is supported.booleanTests if an assessment part bank lookup service is supported.booleanTests if a sequence rule administrative service is supported.booleanTests if a sequence rule bank lookup service is supported.booleanTests if a sequence rule bank service is supported.booleanTests if a sequence rule enabler administrative service is supported.booleanTests if a sequence rule enabler bank lookup service is supported.booleanTests if a sequence rule enabler bank service is supported.booleanTests if looking up sequence rule enablers is supported.booleanTests if a sequence rule enabler notification service is supported.booleanTests if querying sequence rule enablers is supported.booleansupportsSequenceRuleEnablerRecordType(Type sequenceRuleEnablerRecordType) Tests if the givenSequenceRuleEnablerrecord type is supported.booleanTests if a sequence rule enabler rule application service is supported.booleanTests if a sequence rule enabler rule lookup service is supported.booleanTests if searching sequence rule enablers is supported.booleansupportsSequenceRuleEnablerSearchRecordType(Type sequenceRuleEnablerSearchRecordType) Tests if the givenSequenceRuleEnablersearch record type is supported.booleanTests if a sequence rule enabler bank lookup service is supported.booleanTests if looking up sequence rule is supported.booleanTests if a sequence rule notification service is supported.booleanTests if querying sequence rule is supported.booleansupportsSequenceRuleRecordType(Type sequenceRuleRecordType) Tests if the givenSequenceRulerecord type is supported.booleanTests if searching sequence rule is supported.booleansupportsSequenceRuleSearchRecordType(Type sequenceRuleSearchRecordType) Tests if the givenSequenceRulesearch record type is supported.booleanTests if a sequence rule bank lookup service is supported.booleanTests if federation is visible.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface OsidProxyManager
closeMethods inherited from interface OsidProxyManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId, Proxy proxy) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime, Proxy proxy) Rolls back this service to a point in time.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getAssessmentPartLookupSession
AssessmentPartLookupSession getAssessmentPartLookupSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the assessment part lookup service.- Parameters:
proxy- a proxy- Returns:
- an
AssessmentPartLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAssessmentPartLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAssessmentPartLookup()} is {@code true} .
-
getAssessmentPartLookupSessionForBank
AssessmentPartLookupSession getAssessmentPartLookupSessionForBank(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the assessment part lookup service for the given bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- an
AssessmentPartLookupSession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsAssessmentPartLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAssessmentPartLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getAssessmentPartQuerySession
AssessmentPartQuerySession getAssessmentPartQuerySession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the assessment part query service.- Parameters:
proxy- a proxy- Returns:
- an
AssessmentPartQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAssessmentPartQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAssessmentPartQuery()} is {@code true} .
-
getAssessmentPartQuerySessionForBank
AssessmentPartQuerySession getAssessmentPartQuerySessionForBank(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the assessment part query service for the given bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- an
AssessmentPartQuerySession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsAssessmentPartQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAssessmentPartQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getAssessmentPartSearchSession
AssessmentPartSearchSession getAssessmentPartSearchSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the assessment part search service.- Parameters:
proxy- a proxy- Returns:
- an
AssessmentPartSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAssessmentPartSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAssessmentPartSearch()} is {@code true} .
-
getAssessmentPartSearchSessionForBank
AssessmentPartSearchSession getAssessmentPartSearchSessionForBank(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the assessment part earch service for the given bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- an
AssessmentPartSearchSession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsAssessmentPartSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAssessmentPartSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getAssessmentPartAdminSession
AssessmentPartAdminSession getAssessmentPartAdminSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the assessment part administration service.- Parameters:
proxy- a proxy- Returns:
- an
AssessmentPartAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAssessmentPartAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAssessmentPartAdmin()} is {@code true} .
-
getAssessmentPartAdminSessionForBank
AssessmentPartAdminSession getAssessmentPartAdminSessionForBank(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the assessment part administration service for the given bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- an
AssessmentPartAdminSession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsAssessmentPartAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAssessmentPartAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
-
getAssessmentPartNotificationSession
AssessmentPartNotificationSession getAssessmentPartNotificationSession(AssessmentPartReceiver assessmentPartReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the assessment part notification service.- Parameters:
assessmentPartReceiver- the notification callbackproxy- a proxy- Returns:
- an
AssessmentPartNotificationSession - Throws:
NullArgumentException-assessmentPartReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAssessmentPartNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAssessmentPartNotification()} is {@code true} .
-
getAssessmentPartNotificationSessionForBank
AssessmentPartNotificationSession getAssessmentPartNotificationSessionForBank(AssessmentPartReceiver assessmentPartReceiver, Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the assessment part notification service for the given bank.- Parameters:
assessmentPartReceiver- the notification callbackbankId- theIdof theBankproxy- a proxy- Returns:
- an
AssessmentPartNotificationSession - Throws:
NotFoundException- no bank found by the givenIdNullArgumentException-assessmentPartReceiver, bankIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAssessmentPartNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAssessmentPartNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getAssessmentPartBankSession
Gets theOsidSessionto lookup assessment part/bank mappings for assessment parts.- Parameters:
proxy- a proxy- Returns:
- an
AssessmentPartBankSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAssessmentPartBank()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAssessmentPartBank()} is {@code true} .
-
getAssessmentPartBankAssignmentSession
AssessmentPartBankAssignmentSession getAssessmentPartBankAssignmentSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with assigning assessment part to bank.- Parameters:
proxy- a proxy- Returns:
- an
AssessmentPartBankAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAssessmentPartBankAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAssessmentPartBankAssignment()} is {@code true} .
-
getAssessmentPartSmartBankSession
AssessmentPartSmartBankSession getAssessmentPartSmartBankSession(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage assessment part smart bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- an
AssessmentPartSmartBankSession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAssessmentPartSmartBank()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAssessmentPartSmartBank()} is {@code true} .
-
getSequenceRuleLookupSession
Gets theOsidSessionassociated with the sequence rule lookup service.- Parameters:
proxy- a proxy- Returns:
- a
SequenceRuleLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleLookup()} is {@code true} .
-
getSequenceRuleLookupSessionForBank
SequenceRuleLookupSession getSequenceRuleLookupSessionForBank(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the sequence rule lookup service for the given bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- a
SequenceRuleLookupSession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getAssessmentPartItemSession
Gets theOsidSessionfor looking up assessment part and item mappings.- Parameters:
proxy- a proxy- Returns:
- an
AssessmentPartItemSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAssessmentPartItem()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAssessmentPartItem()} is {@code true} .
-
getAssessmentPartItemDesignSession
AssessmentPartItemDesignSession getAssessmentPartItemDesignSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionfor designing assessment part and item mappings.- Parameters:
proxy- a proxy- Returns:
- an
AssessmentPartItemDesignSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAssessmentPartItemDesign()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAssessmentPartItemDesign()} is {@code true} .
-
getSequenceRuleQuerySession
Gets theOsidSessionassociated with the sequence rule query service.- Parameters:
proxy- a proxy- Returns:
- a
SequenceRuleQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleQuery()} is {@code true} .
-
getSequenceRuleQuerySessionForBank
SequenceRuleQuerySession getSequenceRuleQuerySessionForBank(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the sequence rule query service for the given bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- a
SequenceRuleQuerySession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getSequenceRuleSearchSession
Gets theOsidSessionassociated with the sequence rule search service.- Parameters:
proxy- a proxy- Returns:
- a
SequenceRuleSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleSearch()} is {@code true} .
-
getSequenceRuleSearchSessionForBank
SequenceRuleSearchSession getSequenceRuleSearchSessionForBank(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the sequence rule earch service for the given bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- a
SequenceRuleSearchSession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getSequenceRuleAdminSession
Gets theOsidSessionassociated with the sequence rule administration service.- Parameters:
proxy- a proxy- Returns:
- a
SequenceRuleAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleAdmin()} is {@code true} .
-
getSequenceRuleAdminSessionForBank
SequenceRuleAdminSession getSequenceRuleAdminSessionForBank(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the sequence rule administration service for the given bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- a
SequenceRuleAdminSession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
-
getSequenceRuleNotificationSession
SequenceRuleNotificationSession getSequenceRuleNotificationSession(SequenceRuleReceiver sequenceRuleReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the sequence rule notification service.- Parameters:
sequenceRuleReceiver- the notification callbackproxy- a proxy- Returns:
- a
SequenceRuleNotificationSession - Throws:
NullArgumentException-sequenceRuleReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleNotification()} is {@code true} .
-
getSequenceRuleNotificationSessionForBank
SequenceRuleNotificationSession getSequenceRuleNotificationSessionForBank(SequenceRuleReceiver sequenceRuleReceiver, Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the sequence rule notification service for the given bank.- Parameters:
sequenceRuleReceiver- the notification callbackbankId- theIdof theBankproxy- a proxy- Returns:
- a
SequenceRuleNotificationSession - Throws:
NotFoundException- no bank found by the givenIdNullArgumentException-sequenceRuleReceiver, bankIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getSequenceRuleBankSession
Gets theOsidSessionto lookup sequence rule/bank mappings for sequence rules.- Parameters:
proxy- a proxy- Returns:
- a
SequenceRuleBankSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleBank()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleBank()} is {@code true} .
-
getSequenceRuleBankAssignmentSession
SequenceRuleBankAssignmentSession getSequenceRuleBankAssignmentSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with assigning sequence rule to bank.- Parameters:
proxy- a proxy- Returns:
- a
SequenceRuleBankAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleBankAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleBankAssignment()} is {@code true} .
-
getSequenceRuleSmartBankSession
SequenceRuleSmartBankSession getSequenceRuleSmartBankSession(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage sequence rule smart bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- a
SequenceRuleSmartBankSession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleSmartBank()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleSmartBank()} is {@code true} .
-
getSequenceRuleEnablerLookupSession
SequenceRuleEnablerLookupSession getSequenceRuleEnablerLookupSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the sequence rule enabler lookup service.- Parameters:
proxy- a proxy- Returns:
- a
SequenceRuleEnablerLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerLookup()} is {@code true} .
-
getSequenceRuleEnablerLookupSessionForBank
SequenceRuleEnablerLookupSession getSequenceRuleEnablerLookupSessionForBank(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the sequence rule enabler lookup service for the given bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- a
SequenceRuleEnablerLookupSession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getSequenceRuleEnablerQuerySession
SequenceRuleEnablerQuerySession getSequenceRuleEnablerQuerySession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the sequence rule enabler query service.- Parameters:
proxy- a proxy- Returns:
- a
SequenceRuleEnablerQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerQuery()} is {@code true} .
-
getSequenceRuleEnablerQuerySessionForBank
SequenceRuleEnablerQuerySession getSequenceRuleEnablerQuerySessionForBank(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the sequence rule enabler query service for the given bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- a
SequenceRuleEnablerQuerySession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getSequenceRuleEnablerSearchSession
SequenceRuleEnablerSearchSession getSequenceRuleEnablerSearchSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the sequence rule enabler search service.- Parameters:
proxy- a proxy- Returns:
- a
SequenceRuleEnablerSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerSearch()} is {@code true} .
-
getSequenceRuleEnablerSearchSessionForBank
SequenceRuleEnablerSearchSession getSequenceRuleEnablerSearchSessionForBank(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the sequence rule enablers earch service for the given bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- a
SequenceRuleEnablerSearchSession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getSequenceRuleEnablerAdminSession
SequenceRuleEnablerAdminSession getSequenceRuleEnablerAdminSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the sequence rule enabler administration service.- Parameters:
proxy- a proxy- Returns:
- a
SequenceRuleEnablerAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerAdmin()} is {@code true} .
-
getSequenceRuleEnablerAdminSessionForBank
SequenceRuleEnablerAdminSession getSequenceRuleEnablerAdminSessionForBank(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the sequence rule enabler administration service for the given bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- a
SequenceRuleEnablerAdminSession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
-
getSequenceRuleEnablerNotificationSession
SequenceRuleEnablerNotificationSession getSequenceRuleEnablerNotificationSession(SequenceRuleEnablerReceiver sequenceRuleEnablerReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the sequence rule enabler notification service.- Parameters:
sequenceRuleEnablerReceiver- the notification callbackproxy- a proxy- Returns:
- a
SequenceRuleEnablerNotificationSession - Throws:
NullArgumentException-sequenceRuleEnablerReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerNotification()} is {@code true} .
-
getSequenceRuleEnablerNotificationSessionForBank
SequenceRuleEnablerNotificationSession getSequenceRuleEnablerNotificationSessionForBank(SequenceRuleEnablerReceiver sequenceRuleEnablerReceiver, Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the sequence rule enabler notification service for the given bank.- Parameters:
sequenceRuleEnablerReceiver- the notification callbackbankId- theIdof theBankproxy- a proxy- Returns:
- a
SequenceRuleEnablerNotificationSession - Throws:
NotFoundException- no bank found by the givenIdNullArgumentException-sequenceRuleEnablerReceiver, bankIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getSequenceRuleEnablerBankSession
SequenceRuleEnablerBankSession getSequenceRuleEnablerBankSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionto lookup sequence rule enabler/bank mappings for sequence rule enablers.- Parameters:
proxy- a proxy- Returns:
- a
SequenceRuleEnablerBankSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerBank()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerBank()} is {@code true} .
-
getSequenceRuleEnablerBankAssignmentSession
SequenceRuleEnablerBankAssignmentSession getSequenceRuleEnablerBankAssignmentSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with assigning sequence rule enablers to bank.- Parameters:
proxy- a proxy- Returns:
- a
SequenceRuleEnablerBankAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerBankAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerBankAssignment()} is {@code true} .
-
getSequenceRuleEnablerSmartBankSession
SequenceRuleEnablerSmartBankSession getSequenceRuleEnablerSmartBankSession(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage sequence rule enabler smart bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- a
SequenceRuleEnablerSmartBankSession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerSmartBank()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerSmartBank()} is {@code true} .
-
getSequenceRuleEnablerRuleLookupSession
SequenceRuleEnablerRuleLookupSession getSequenceRuleEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the sequence rule enabler mapping lookup service .- Parameters:
proxy- a proxy- Returns:
- a
SequenceRuleEnablerRuleLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerRuleLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerRuleLookup()} is {@code true} .
-
getSequenceRuleEnablerRuleLookupSessionForBank
SequenceRuleEnablerRuleLookupSession getSequenceRuleEnablerRuleLookupSessionForBank(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the sequence rule enabler mapping lookup service for the given bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- a
SequenceRuleEnablerRuleLookupSession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerRuleLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getSequenceRuleEnablerRuleApplicationSession
SequenceRuleEnablerRuleApplicationSession getSequenceRuleEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the sequence rule enabler assignment service.- Parameters:
proxy- a proxy- Returns:
- a
SequenceRuleEnablerRuleApplicationSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerRuleApplication()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerRuleApplication()} is {@code true} .
-
getSequenceRuleEnablerRuleApplicationSessionForBank
SequenceRuleEnablerRuleApplicationSession getSequenceRuleEnablerRuleApplicationSessionForBank(Id bankId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the sequence rule enabler assignment service for the given bank.- Parameters:
bankId- theIdof theBankproxy- a proxy- Returns:
- a
SequenceRuleEnablerRuleApplicationSession - Throws:
NotFoundException- noBankfound by the givenIdNullArgumentException-bankIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequenceRuleEnablerRuleApplication()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequenceRuleEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
-