Interface AssessmentAuthoringManager

All Superinterfaces:

AssessmentAuthoringProfile, AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable

public interface AssessmentAuthoringManager
extends OsidManager, AssessmentAuthoringProfile

The assessment authoring manager provides access to assessment authoring sessions and provides interoperability tests for various aspects of this service. 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 Type	Method	Description
AssessmentPartAdminSession	getAssessmentPartAdminSession()	Gets the OsidSession associated with the assessment part administration service.
AssessmentPartAdminSession	getAssessmentPartAdminSessionForBank(Id bankId)	Gets the OsidSession associated with the assessment part administration service for the given bank.
AssessmentPartBankAssignmentSession	getAssessmentPartBankAssignmentSession()	Gets the OsidSession associated with assigning assessment part to bank.
AssessmentPartBankSession	getAssessmentPartBankSession()	Gets the OsidSession to lookup assessment part/bank mappings for assessment parts.
AssessmentPartItemDesignSession	getAssessmentPartItemDesignSession()	Gets the OsidSession for designing assessment part and item mappings.
AssessmentPartItemSession	getAssessmentPartItemSession()	Gets the OsidSession for looking up assessment part and item mappings.
AssessmentPartLookupSession	getAssessmentPartLookupSession()	Gets the OsidSession associated with the assessment part lookup service.
AssessmentPartLookupSession	getAssessmentPartLookupSessionForBank(Id bankId)	Gets the OsidSession associated with the assessment part lookup service for the given bank.
AssessmentPartNotificationSession	getAssessmentPartNotificationSession(AssessmentPartReceiver assessmentPartReceiver)	Gets the OsidSession associated with the assessment part notification service.
AssessmentPartNotificationSession	getAssessmentPartNotificationSessionForBank(AssessmentPartReceiver assessmentPartReceiver, Id bankId)	Gets the OsidSession associated with the assessment part notification service for the given bank.
AssessmentPartQuerySession	getAssessmentPartQuerySession()	Gets the OsidSession associated with the assessment part query service.
AssessmentPartQuerySession	getAssessmentPartQuerySessionForBank(Id bankId)	Gets the OsidSession associated with the assessment part query service for the given bank.
AssessmentPartSearchSession	getAssessmentPartSearchSession()	Gets the OsidSession associated with the assessment part search service.
AssessmentPartSearchSession	getAssessmentPartSearchSessionForBank(Id bankId)	Gets the OsidSession associated with the assessment part earch service for the given bank.
AssessmentPartSmartBankSession	getAssessmentPartSmartBankSession(Id bankId)	Gets the OsidSession to manage assessment part smart bank.
SequenceRuleAdminSession	getSequenceRuleAdminSession()	Gets the OsidSession associated with the sequence rule administration service.
SequenceRuleAdminSession	getSequenceRuleAdminSessionForBank(Id bankId)	Gets the OsidSession associated with the sequence rule administration service for the given bank.
SequenceRuleBankAssignmentSession	getSequenceRuleBankAssignmentSession()	Gets the OsidSession associated with assigning sequence rule to bank.
SequenceRuleBankSession	getSequenceRuleBankSession()	Gets the OsidSession to lookup sequence rule/bank mappings for sequence rules.
SequenceRuleEnablerAdminSession	getSequenceRuleEnablerAdminSession()	Gets the OsidSession associated with the sequence rule enabler administration service.
SequenceRuleEnablerAdminSession	getSequenceRuleEnablerAdminSessionForBank(Id bankId)	Gets the OsidSession associated with the sequence rule enabler administration service for the given bank.
SequenceRuleEnablerBankAssignmentSession	getSequenceRuleEnablerBankAssignmentSession()	Gets the OsidSession associated with assigning sequence rule enablers to bank.
SequenceRuleEnablerBankSession	getSequenceRuleEnablerBankSession()	Gets the OsidSession to lookup sequence rule enabler/bank mappings for sequence rule enablers.
SequenceRuleEnablerLookupSession	getSequenceRuleEnablerLookupSession()	Gets the OsidSession associated with the sequence rule enabler lookup service.
SequenceRuleEnablerLookupSession	getSequenceRuleEnablerLookupSessionForBank(Id bankId)	Gets the OsidSession associated with the sequence rule enabler lookup service for the given bank.
SequenceRuleEnablerNotificationSession	getSequenceRuleEnablerNotificationSession(SequenceRuleEnablerReceiver sequenceRuleEnablerReceiver)	Gets the OsidSession associated with the sequence rule enabler notification service.
SequenceRuleEnablerNotificationSession	getSequenceRuleEnablerNotificationSessionForBank(SequenceRuleEnablerReceiver sequenceRuleEnablerReceiver, Id bankId)	Gets the OsidSession associated with the sequence rule enabler notification service for the given bank.
SequenceRuleEnablerQuerySession	getSequenceRuleEnablerQuerySession()	Gets the OsidSession associated with the sequence rule enabler query service.
SequenceRuleEnablerQuerySession	getSequenceRuleEnablerQuerySessionForBank(Id bankId)	Gets the OsidSession associated with the sequence rule enabler query service for the given bank.
SequenceRuleEnablerRuleApplicationSession	getSequenceRuleEnablerRuleApplicationSession()	Gets the OsidSession associated with the sequence rule enabler assignment service.
SequenceRuleEnablerRuleApplicationSession	getSequenceRuleEnablerRuleApplicationSessionForBank(Id bankId)	Gets the OsidSession associated with the sequence rule enabler assignment service for the given bank.
SequenceRuleEnablerRuleLookupSession	getSequenceRuleEnablerRuleLookupSession()	Gets the OsidSession associated with the sequence rule enabler mapping lookup service.
SequenceRuleEnablerRuleLookupSession	getSequenceRuleEnablerRuleLookupSessionForBank(Id bankId)	Gets the OsidSession associated with the sequence rule enabler mapping lookup service for the given bank.
SequenceRuleEnablerSearchSession	getSequenceRuleEnablerSearchSession()	Gets the OsidSession associated with the sequence rule enabler search service.
SequenceRuleEnablerSearchSession	getSequenceRuleEnablerSearchSessionForBank(Id bankId)	Gets the OsidSession associated with the sequence rule enablers earch service for the given bank.
SequenceRuleEnablerSmartBankSession	getSequenceRuleEnablerSmartBankSession(Id bankId)	Gets the OsidSession to manage sequence rule enabler smart bank.
SequenceRuleLookupSession	getSequenceRuleLookupSession()	Gets the OsidSession associated with the sequence rule lookup service.
SequenceRuleLookupSession	getSequenceRuleLookupSessionForBank(Id bankId)	Gets the OsidSession associated with the sequence rule lookup service for the given bank.
SequenceRuleNotificationSession	getSequenceRuleNotificationSession(SequenceRuleReceiver sequenceRuleReceiver)	Gets the OsidSession associated with the sequence rule notification service.
SequenceRuleNotificationSession	getSequenceRuleNotificationSessionForBank(SequenceRuleReceiver sequenceRuleReceiver, Id bankId)	Gets the OsidSession associated with the sequence rule notification service for the given bank.
SequenceRuleQuerySession	getSequenceRuleQuerySession()	Gets the OsidSession associated with the sequence rule query service.
SequenceRuleQuerySession	getSequenceRuleQuerySessionForBank(Id bankId)	Gets the OsidSession associated with the sequence rule query service for the given bank.
SequenceRuleSearchSession	getSequenceRuleSearchSession()	Gets the OsidSession associated with the sequence rule search service.
SequenceRuleSearchSession	getSequenceRuleSearchSessionForBank(Id bankId)	Gets the OsidSession associated with the sequence rule earch service for the given bank.
SequenceRuleSmartBankSession	getSequenceRuleSmartBankSession(Id bankId)	Gets the OsidSession to 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, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getAssessmentPartRecordTypes()	Gets the supported AssessmentPart record types.
TypeList	getAssessmentPartSearchRecordTypes()	Gets the supported AssessmentPart search record types.
TypeList	getSequenceRuleEnablerRecordTypes()	Gets the supported SequenceRuleEnabler record types.
TypeList	getSequenceRuleEnablerSearchRecordTypes()	Gets the supported SequenceRuleEnabler search record types.
TypeList	getSequenceRuleRecordTypes()	Gets the supported SequenceRule record types.
TypeList	getSequenceRuleSearchRecordTypes()	Gets the supported SequenceRule search record types.
boolean	supportsAssessmentPartAdmin()	Tests if an assessment part administrative service is supported.
boolean	supportsAssessmentPartBank()	Tests if an assessment part bank lookup service is supported.
boolean	supportsAssessmentPartBankAssignment()	Tests if an assessment part bank service is supported.
boolean	supportsAssessmentPartItem()	Tests if an assessment part item service is supported for looking up assessment part and item mappings.
boolean	supportsAssessmentPartItemDesign()	Tests if an assessment part item design session is supported.
boolean	supportsAssessmentPartLookup()	Tests if looking up assessment part is supported.
boolean	supportsAssessmentPartNotification()	Tests if an assessment part notification service is supported.
boolean	supportsAssessmentPartQuery()	Tests if querying assessment part is supported.
boolean	supportsAssessmentPartRecordType(Type assessmentPartRecordType)	Tests if the given AssessmentPart record type is supported.
boolean	supportsAssessmentPartSearch()	Tests if searching assessment part is supported.
boolean	supportsAssessmentPartSearchRecordType(Type assessmentPartSearchRecordType)	Tests if the given AssessmentPart search record type is supported.
boolean	supportsAssessmentPartSmartBank()	Tests if an assessment part bank lookup service is supported.
boolean	supportsSequenceRuleAdmin()	Tests if a sequence rule administrative service is supported.
boolean	supportsSequenceRuleBank()	Tests if a sequence rule bank lookup service is supported.
boolean	supportsSequenceRuleBankAssignment()	Tests if a sequence rule bank service is supported.
boolean	supportsSequenceRuleEnablerAdmin()	Tests if a sequence rule enabler administrative service is supported.
boolean	supportsSequenceRuleEnablerBank()	Tests if a sequence rule enabler bank lookup service is supported.
boolean	supportsSequenceRuleEnablerBankAssignment()	Tests if a sequence rule enabler bank service is supported.
boolean	supportsSequenceRuleEnablerLookup()	Tests if looking up sequence rule enablers is supported.
boolean	supportsSequenceRuleEnablerNotification()	Tests if a sequence rule enabler notification service is supported.
boolean	supportsSequenceRuleEnablerQuery()	Tests if querying sequence rule enablers is supported.
boolean	supportsSequenceRuleEnablerRecordType(Type sequenceRuleEnablerRecordType)	Tests if the given SequenceRuleEnabler record type is supported.
boolean	supportsSequenceRuleEnablerRuleApplication()	Tests if a sequence rule enabler rule application service is supported.
boolean	supportsSequenceRuleEnablerRuleLookup()	Tests if a sequence rule enabler rule lookup service is supported.
boolean	supportsSequenceRuleEnablerSearch()	Tests if searching sequence rule enablers is supported.
boolean	supportsSequenceRuleEnablerSearchRecordType(Type sequenceRuleEnablerSearchRecordType)	Tests if the given SequenceRuleEnabler search record type is supported.
boolean	supportsSequenceRuleEnablerSmartBank()	Tests if a sequence rule enabler bank lookup service is supported.
boolean	supportsSequenceRuleLookup()	Tests if looking up sequence rule is supported.
boolean	supportsSequenceRuleNotification()	Tests if a sequence rule notification service is supported.
boolean	supportsSequenceRuleQuery()	Tests if querying sequence rule is supported.
boolean	supportsSequenceRuleRecordType(Type sequenceRuleRecordType)	Tests if the given SequenceRule record type is supported.
boolean	supportsSequenceRuleSearch()	Tests if searching sequence rule is supported.
boolean	supportsSequenceRuleSearchRecordType(Type sequenceRuleSearchRecordType)	Tests if the given SequenceRule search record type is supported.
boolean	supportsSequenceRuleSmartBank()	Tests if a sequence rule bank lookup service is supported.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getAssessmentPartLookupSession

AssessmentPartLookupSession getAssessmentPartLookupSession()
                                                    throws OperationFailedException

Gets the OsidSession associated with the assessment part lookup service.

Returns:

an AssessmentPartLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsAssessmentPartLookup()} is {@code true} .

getAssessmentPartLookupSessionForBank

AssessmentPartLookupSession getAssessmentPartLookupSessionForBank(Id bankId)
                                                           throws NotFoundException,
OperationFailedException

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

Parameters:

bankId - the Id of the Bank

Returns:

an AssessmentPartLookupSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartLookup() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentPartQuerySession

AssessmentPartQuerySession getAssessmentPartQuerySession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the assessment part query service.

Returns:

an AssessmentPartQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAssessmentPartQuery()} is {@code true} .

getAssessmentPartQuerySessionForBank

AssessmentPartQuerySession getAssessmentPartQuerySessionForBank(Id bankId)
                                                         throws NotFoundException,
OperationFailedException

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

Parameters:

bankId - the Id of the Bank

Returns:

an AssessmentPartQuerySession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartQuery() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentPartSearchSession

AssessmentPartSearchSession getAssessmentPartSearchSession()
                                                    throws OperationFailedException

Gets the OsidSession associated with the assessment part search service.

Returns:

an AssessmentPartSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsAssessmentPartSearch()} is {@code true} .

getAssessmentPartSearchSessionForBank

AssessmentPartSearchSession getAssessmentPartSearchSessionForBank(Id bankId)
                                                           throws NotFoundException,
OperationFailedException

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

Parameters:

bankId - the Id of the Bank

Returns:

an AssessmentPartSearchSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartSearch() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentPartAdminSession

AssessmentPartAdminSession getAssessmentPartAdminSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the assessment part administration service.

Returns:

an AssessmentPartAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsAssessmentPartAdmin()} is {@code true} .

getAssessmentPartAdminSessionForBank

AssessmentPartAdminSession getAssessmentPartAdminSessionForBank(Id bankId)
                                                         throws NotFoundException,
OperationFailedException

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

Parameters:

bankId - the Id of the Bank

Returns:

an AssessmentPartAdminSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentPartNotificationSession

AssessmentPartNotificationSession getAssessmentPartNotificationSession(AssessmentPartReceiver assessmentPartReceiver)
                                                                throws OperationFailedException

Gets the OsidSession associated with the assessment part notification service.

Parameters:

assessmentPartReceiver - the notification callback

Returns:

an AssessmentPartNotificationSession

Throws:

NullArgumentException - assessmentPartReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsAssessmentPartNotification()} is {@code true} .

getAssessmentPartNotificationSessionForBank

AssessmentPartNotificationSession getAssessmentPartNotificationSessionForBank(AssessmentPartReceiver assessmentPartReceiver,
 Id bankId)
                                                                       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

Returns:

an AssessmentPartNotificationSession

Throws:

NotFoundException - no bank found by the given Id

NullArgumentException - assessmentPartReceiver or bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartNotification() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentPartBankSession

AssessmentPartBankSession getAssessmentPartBankSession()
                                                throws OperationFailedException

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

Returns:

an AssessmentPartBankSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartBank() is false

Compliance:

optional - This method must be implemented if {@code supportsAssessmentPartBank()} is {@code true} .

getAssessmentPartBankAssignmentSession

AssessmentPartBankAssignmentSession getAssessmentPartBankAssignmentSession()
                                                                    throws OperationFailedException

Gets the OsidSession associated with assigning assessment part to bank.

Returns:

an AssessmentPartBankAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartBankAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsAssessmentPartBankAssignment()} is {@code true} .

getAssessmentPartSmartBankSession

AssessmentPartSmartBankSession getAssessmentPartSmartBankSession(Id bankId)
                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage assessment part smart bank.

Parameters:

bankId - the Id of the Bank

Returns:

an AssessmentPartSmartBankSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartSmartBank() is false

Compliance:

optional - This method must be implemented if {@code supportsAssessmentPartSmartBank()} is {@code true} .

getAssessmentPartItemSession

AssessmentPartItemSession getAssessmentPartItemSession()
                                                throws OperationFailedException

Gets the OsidSession for looking up assessment part and item mappings.

Returns:

an AssessmentPartItemSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartItem() is false

Compliance:

optional - This method must be implemented if {@code supportsAssessmentPartItem()} is {@code true} .

getAssessmentPartItemDesignSession

AssessmentPartItemDesignSession getAssessmentPartItemDesignSession()
                                                            throws OperationFailedException

Gets the OsidSession for designing assessment part and item mappings.

Returns:

an AssessmentPartItemDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentPartItemDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsAssessmentPartItemDesign()} is {@code true} .

getSequenceRuleLookupSession

SequenceRuleLookupSession getSequenceRuleLookupSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the sequence rule lookup service.

Returns:

a SequenceRuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleLookup()} is {@code true} .

getSequenceRuleLookupSessionForBank

SequenceRuleLookupSession getSequenceRuleLookupSessionForBank(Id bankId)
                                                       throws NotFoundException,
OperationFailedException

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

Parameters:

bankId - the Id of the Bank

Returns:

a SequenceRuleLookupSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleLookup() or supportsVisibleFederation() is false

Compliance:

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

getSequenceRuleQuerySession

SequenceRuleQuerySession getSequenceRuleQuerySession()
                                              throws OperationFailedException

Gets the OsidSession associated with the sequence rule query service.

Returns:

a SequenceRuleQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleQuery()} is {@code true} .

getSequenceRuleQuerySessionForBank

SequenceRuleQuerySession getSequenceRuleQuerySessionForBank(Id bankId)
                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

bankId - the Id of the Bank

Returns:

a SequenceRuleQuerySession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleQuery() or supportsVisibleFederation() is false

Compliance:

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

getSequenceRuleSearchSession

SequenceRuleSearchSession getSequenceRuleSearchSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the sequence rule search service.

Returns:

a SequenceRuleSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleSearch()} is {@code true} .

getSequenceRuleSearchSessionForBank

SequenceRuleSearchSession getSequenceRuleSearchSessionForBank(Id bankId)
                                                       throws NotFoundException,
OperationFailedException

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

Parameters:

bankId - the Id of the Bank

Returns:

a SequenceRuleSearchSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleSearch() or supportsVisibleFederation() is false

Compliance:

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

getSequenceRuleAdminSession

SequenceRuleAdminSession getSequenceRuleAdminSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the sequence rule administration service.

Returns:

a SequenceRuleAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleAdmin()} is {@code true} .

getSequenceRuleAdminSessionForBank

SequenceRuleAdminSession getSequenceRuleAdminSessionForBank(Id bankId)
                                                     throws NotFoundException,
OperationFailedException

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

Parameters:

bankId - the Id of the Bank

Returns:

a SequenceRuleAdminSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleAdmin() or supportsVisibleFederation() is false

Compliance:

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

getSequenceRuleNotificationSession

SequenceRuleNotificationSession getSequenceRuleNotificationSession(SequenceRuleReceiver sequenceRuleReceiver)
                                                            throws OperationFailedException

Gets the OsidSession associated with the sequence rule notification service.

Parameters:

sequenceRuleReceiver - the notification callback

Returns:

a SequenceRuleNotificationSession

Throws:

NullArgumentException - sequenceRuleReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleNotification()} is {@code true} .

getSequenceRuleNotificationSessionForBank

SequenceRuleNotificationSession getSequenceRuleNotificationSessionForBank(SequenceRuleReceiver sequenceRuleReceiver,
 Id bankId)
                                                                   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

Returns:

a SequenceRuleNotificationSession

Throws:

NotFoundException - no bank found by the given Id

NullArgumentException - sequenceRuleReceiver or bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleNotification() or supportsVisibleFederation() is false

Compliance:

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

getSequenceRuleBankSession

SequenceRuleBankSession getSequenceRuleBankSession()
                                            throws OperationFailedException

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

Returns:

a SequenceRuleBankSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleBank() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleBank()} is {@code true} .

getSequenceRuleBankAssignmentSession

SequenceRuleBankAssignmentSession getSequenceRuleBankAssignmentSession()
                                                                throws OperationFailedException

Gets the OsidSession associated with assigning sequence rule to bank.

Returns:

a SequenceRuleBankAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleBankAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleBankAssignment()} is {@code true} .

getSequenceRuleSmartBankSession

SequenceRuleSmartBankSession getSequenceRuleSmartBankSession(Id bankId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage sequence rule smart bank.

Parameters:

bankId - the Id of the Bank

Returns:

a SequenceRuleSmartBankSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleSmartBank() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleSmartBank()} is {@code true} .

getSequenceRuleEnablerLookupSession

SequenceRuleEnablerLookupSession getSequenceRuleEnablerLookupSession()
                                                              throws OperationFailedException

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

Returns:

a SequenceRuleEnablerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleEnablerLookup()} is {@code true} .

getSequenceRuleEnablerLookupSessionForBank

SequenceRuleEnablerLookupSession getSequenceRuleEnablerLookupSessionForBank(Id bankId)
                                                                     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

Returns:

a SequenceRuleEnablerLookupSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerLookup() or supportsVisibleFederation() is false

Compliance:

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

getSequenceRuleEnablerQuerySession

SequenceRuleEnablerQuerySession getSequenceRuleEnablerQuerySession()
                                                            throws OperationFailedException

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

Returns:

a SequenceRuleEnablerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleEnablerQuery()} is {@code true} .

getSequenceRuleEnablerQuerySessionForBank

SequenceRuleEnablerQuerySession getSequenceRuleEnablerQuerySessionForBank(Id bankId)
                                                                   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

Returns:

a SequenceRuleEnablerQuerySession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerQuery() or supportsVisibleFederation() is false

Compliance:

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

getSequenceRuleEnablerSearchSession

SequenceRuleEnablerSearchSession getSequenceRuleEnablerSearchSession()
                                                              throws OperationFailedException

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

Returns:

a SequenceRuleEnablerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleEnablerSearch()} is {@code true} .

getSequenceRuleEnablerSearchSessionForBank

SequenceRuleEnablerSearchSession getSequenceRuleEnablerSearchSessionForBank(Id bankId)
                                                                     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

Returns:

a SequenceRuleEnablerSearchSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerSearch() or supportsVisibleFederation() is false

Compliance:

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

getSequenceRuleEnablerAdminSession

SequenceRuleEnablerAdminSession getSequenceRuleEnablerAdminSession()
                                                            throws OperationFailedException

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

Returns:

a SequenceRuleEnablerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleEnablerAdmin()} is {@code true} .

getSequenceRuleEnablerAdminSessionForBank

SequenceRuleEnablerAdminSession getSequenceRuleEnablerAdminSessionForBank(Id bankId)
                                                                   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

Returns:

a SequenceRuleEnablerAdminSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

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

getSequenceRuleEnablerNotificationSession

SequenceRuleEnablerNotificationSession getSequenceRuleEnablerNotificationSession(SequenceRuleEnablerReceiver sequenceRuleEnablerReceiver)
                                                                          throws OperationFailedException

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

Parameters:

sequenceRuleEnablerReceiver - the notification callback

Returns:

a SequenceRuleEnablerNotificationSession

Throws:

NullArgumentException - sequenceRuleEnablerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleEnablerNotification()} is {@code true} .

getSequenceRuleEnablerNotificationSessionForBank

SequenceRuleEnablerNotificationSession getSequenceRuleEnablerNotificationSessionForBank(SequenceRuleEnablerReceiver sequenceRuleEnablerReceiver,
 Id bankId)
                                                                                 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

Returns:

a SequenceRuleEnablerNotificationSession

Throws:

NotFoundException - no bank found by the given Id

NullArgumentException - sequenceRuleEnablerReceiver or bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerNotification() or supportsVisibleFederation() is false

Compliance:

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

getSequenceRuleEnablerBankSession

SequenceRuleEnablerBankSession getSequenceRuleEnablerBankSession()
                                                          throws OperationFailedException

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

Returns:

a SequenceRuleEnablerBankSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerBank() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleEnablerBank()} is {@code true} .

getSequenceRuleEnablerBankAssignmentSession

SequenceRuleEnablerBankAssignmentSession getSequenceRuleEnablerBankAssignmentSession()
                                                                              throws OperationFailedException

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

Returns:

a SequenceRuleEnablerBankAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerBankAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleEnablerBankAssignment()} is {@code true} .

getSequenceRuleEnablerSmartBankSession

SequenceRuleEnablerSmartBankSession getSequenceRuleEnablerSmartBankSession(Id bankId)
                                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage sequence rule enabler smart bank.

Parameters:

bankId - the Id of the Bank

Returns:

a SequenceRuleEnablerSmartBankSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerSmartBank() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleEnablerSmartBank()} is {@code true} .

getSequenceRuleEnablerRuleLookupSession

SequenceRuleEnablerRuleLookupSession getSequenceRuleEnablerRuleLookupSession()
                                                                      throws OperationFailedException

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

Returns:

a SequenceRuleEnablerRuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleEnablerRuleLookup()} is {@code true} .

getSequenceRuleEnablerRuleLookupSessionForBank

SequenceRuleEnablerRuleLookupSession getSequenceRuleEnablerRuleLookupSessionForBank(Id bankId)
                                                                             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

Returns:

a SequenceRuleEnablerRuleLookupSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

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

getSequenceRuleEnablerRuleApplicationSession

SequenceRuleEnablerRuleApplicationSession getSequenceRuleEnablerRuleApplicationSession()
                                                                                throws OperationFailedException

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

Returns:

a SequenceRuleEnablerRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if {@code supportsSequenceRuleEnablerRuleApplication()} is {@code true} .

getSequenceRuleEnablerRuleApplicationSessionForBank

SequenceRuleEnablerRuleApplicationSession getSequenceRuleEnablerRuleApplicationSessionForBank(Id bankId)
                                                                                       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

Returns:

a SequenceRuleEnablerRuleApplicationSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSequenceRuleEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

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