Interface AssessmentManager

All Superinterfaces:

AssessmentProfile, AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable

public interface AssessmentManager
extends OsidManager, AssessmentProfile

The assessment manager provides access to assessment sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• MyAssessmentTakenSession : a session to get taken or in progress assessments for the current agent
• AssessmentSession : a session to be assessed and examine assessments taken
• AssessmentResultsSession : a session to retrieve assessment results

• ItemLookupSession : a session to look up Items
• ItemQuerySession : a session to query Items
• ItemSearchSession: a session to search Items
• ItemAdminSession : a session to create, modify and delete Items
• ItemNotificationSession: a session to receive messages pertaining to Item changes
• ItemBankSession : a session for looking up item and bank mappings
• ItemBankAssignmentSession : a session for managing item and bank mappings
• ItemSmartBankSession : a session for managing dynamic banks

• AssessmentLookupSession : a session to look up Assessments
• AssessmentQuerySession : a session to query Assessments
• AssessmentSearchSession: a session to search Assessments
• AssessmentAdminSession : a session to create, modify and delete Assessments
• AssessmentNotificationSession: a session to receive messages pertaining to Assessment changes

• AssessmentBankSession : a session for looking up assessment and bank mappings
• AssessmentBankAssignmentSession : a session for managing assessment and bank mappings
• AssessmentSmartBankSession : a session for managing dynamic banks
• AssessmentBasicAuthoringSession : a session for making simple mappings of assessment items to assessments

• AssessmentOfferedLookupSession : a session to look up AssessmentsOffered
• AssessmentOfferedQuerySession: a session to query AssessmentsOffered
• AssessmentOfferedSearchSession : a session to search AssessmentsOffered
• AssessmentOfferedAdminSession : a session to create, modify and delete AssessmentsOffered
• AssessmentOfferedNotificationSession: a session to receive messages pertaining to AssessmentOffered changes
• AssessmentOfferedBankSession : a session for looking up assessments offered and bank mappings
• AssessmentOfferedBankAssignmentSession : a session for managing assessments offered and bank mappings
• AssessmentOfferedSmartBankSession : a session to manage dynamic banks of assessments offered

• AssessmentTakenLookupSession : a session to look up Assessments
• AssessmentTakenQuerySession: a session to query Assessments
• AssessmentTakenSearchSession : a session to search Assessments
• AssessmentTakenAdminSession : a session to create, modify and delete AssessmentsTaken
• AssessmentTakenNotificationSession: a session to receive messages pertaining to AssessmentTaken changes
• AssessmentTakenBankSession : a session for looking up assessments taken and bank mappings
• AssessmenttTakenBankAssignmentSession : a session for managing assessments taken and bank mappings
• AssessmentTakenSmartBankSession : a session to manage dynamic banks of assessments taken

• BankLookupSession : a session to lookup banks
• BankQuerySession : a session to query banks
• BankSearchSession : a session to search banks
• BankAdminSession : a session to create, modify and delete banks
• BankNotificationSession : a session to receive messages pertaining to Bank changes
• BankHierarchySession : a session to traverse the Bank hierarchy
• BankHierarchyDesignSession : a session to manage the Bank hierarchy

Method Summary

Modifier and Type	Method	Description
AssessmentAdminSession	getAssessmentAdminSession()	Gets the OsidSession associated with the assessment administration service.
AssessmentAdminSession	getAssessmentAdminSessionForBank(Id bankId)	Gets the OsidSession associated with the assessment admin service for the given bank.
AssessmentAuthoringManager	getAssessmentAuthoringManager()	Gets an AssessmentAuthoringManager .
AssessmentBankAssignmentSession	getAssessmentBankAssignmentSession()	Gets the OsidSession associated with the assessment bank assignment service.
AssessmentBankSession	getAssessmentBankSession()	Gets the OsidSession associated with the assessment banking service.
AssessmentBasicAuthoringSession	getAssessmentBasicAuthoringSession()	Gets the OsidSession associated with the assessment authoring service.
AssessmentBasicAuthoringSession	getAssessmentBasicAuthoringSessionForBank(Id bankId)	Gets the OsidSession associated with the assessment authoring service for the given bank.
AssessmentBatchManager	getAssessmentBatchManager()	Gets an AssessmentBatchManager .
AssessmentLookupSession	getAssessmentLookupSession()	Gets the OsidSession associated with the assessment lookup service.
AssessmentLookupSession	getAssessmentLookupSessionForBank(Id bankId)	Gets the OsidSession associated with the assessment lookup service for the given bank.
AssessmentNotificationSession	getAssessmentNotificationSession(AssessmentReceiver assessmentReceiver)	Gets the notification session for notifications pertaining to assessment changes.
AssessmentNotificationSession	getAssessmentNotificationSessionForBank(AssessmentReceiver assessmentReceiver, Id bankId)	Gets the OsidSession associated with the assessment notification service for the given bank.
AssessmentOfferedAdminSession	getAssessmentOfferedAdminSession()	Gets the OsidSession associated with the assessment offered administration service.
AssessmentOfferedAdminSession	getAssessmentOfferedAdminSessionForBank(Id bankId)	Gets the OsidSession associated with the assessment offered admin service for the given bank.
AssessmentOfferedBankAssignmentSession	getAssessmentOfferedBankAssignmentSession()	Gets the session for assigning offered assessments to bank mappings.
AssessmentOfferedBankSession	getAssessmentOfferedBankSession()	Gets the session for retrieving offered assessments to bank mappings.
AssessmentOfferedLookupSession	getAssessmentOfferedLookupSession()	Gets the OsidSession associated with the assessment offered lookup service.
AssessmentOfferedLookupSession	getAssessmentOfferedLookupSessionForBank(Id bankId)	Gets the OsidSession associated with the assessment offered lookup service for the given bank.
AssessmentOfferedNotificationSession	getAssessmentOfferedNotificationSession(AssessmentOfferedReceiver assessmentOfferedReceiver)	Gets the notification session for notifications pertaining to offered assessment changes.
AssessmentOfferedNotificationSession	getAssessmentOfferedNotificationSessionForBank(AssessmentOfferedReceiver assessmentOfferedReceiver, Id bankId)	Gets the OsidSession associated with the offered assessment notification service for the given bank.
AssessmentOfferedQuerySession	getAssessmentOfferedQuerySession()	Gets the OsidSession associated with the assessment offered query service.
AssessmentOfferedQuerySession	getAssessmentOfferedQuerySessionForBank(Id bankId)	Gets the OsidSession associated with the assessment offered query service for the given bank.
AssessmentOfferedSearchSession	getAssessmentOfferedSearchSession()	Gets the OsidSession associated with the assessment offered search service.
AssessmentOfferedSearchSession	getAssessmentOfferedSearchSessionForBank(Id bankId)	Gets the OsidSession associated with the assessment offered search service for the given bank.
AssessmentOfferedSmartBankSession	getAssessmentOfferedSmartBankSession(Id bankId)	Gets the OsidSession associated with the assessment offered smart banking service for the given bank.
AssessmentQuerySession	getAssessmentQuerySession()	Gets the OsidSession associated with the assessment query service.
AssessmentQuerySession	getAssessmentQuerySessionForBank(Id bankId)	Gets the OsidSession associated with the assessment query service for the given bank.
AssessmentResultsSession	getAssessmentResultsSession()	Gets an AssessmentResultsSession to retrieve assessment results.
AssessmentResultsSession	getAssessmentResultsSessionForBank(Id bankId)	Gets an AssessmentResultsSession to retrieve assessment results for the given bank.
AssessmentSearchSession	getAssessmentSearchSession()	Gets the OsidSession associated with the assessment search service.
AssessmentSearchSession	getAssessmentSearchSessionForBank(Id bankId)	Gets the OsidSession associated with the assessment search service for the given bank.
AssessmentSession	getAssessmentSession()	Gets an AssessmentSession which is responsible for taking assessments and examining responses from assessments taken.
AssessmentSession	getAssessmentSessionForBank(Id bankId)	Gets an AssessmentSession which is responsible for performing assessments for the given bank Id .
AssessmentSmartBankSession	getAssessmentSmartBankSession(Id bankId)	Gets the OsidSession associated with the assessment smart banking service for the given bank.
AssessmentTakenAdminSession	getAssessmentTakenAdminSession()	Gets the OsidSession associated with the assessment taken administration service.
AssessmentTakenAdminSession	getAssessmentTakenAdminSessionForBank(Id bankId)	Gets the OsidSession associated with the assessment taken admin service for the given bank.
AssessmentTakenBankAssignmentSession	getAssessmentTakenBankAssignmentSession()	Gets the session for assigning taken assessments to bank mappings.
AssessmentTakenBankSession	getAssessmentTakenBankSession()	Gets the session for retrieving taken assessments to bank mappings.
AssessmentTakenLookupSession	getAssessmentTakenLookupSession()	Gets the OsidSession associated with the assessment taken lookup service.
AssessmentTakenLookupSession	getAssessmentTakenLookupSessionForBank(Id bankId)	Gets the OsidSession associated with the assessment taken lookup service for the given bank.
AssessmentTakenNotificationSession	getAssessmentTakenNotificationSession(AssessmentTakenReceiver assessmentTakenReceiver)	Gets the notification session for notifications pertaining to taken assessment changes.
AssessmentTakenNotificationSession	getAssessmentTakenNotificationSessionForBank(AssessmentTakenReceiver assessmentTakenReceiver, Id bankId)	Gets the OsidSession associated with the taken assessment notification service for the given bank.
AssessmentTakenQuerySession	getAssessmentTakenQuerySession()	Gets the OsidSession associated with the assessment taken query service.
AssessmentTakenQuerySession	getAssessmentTakenQuerySessionForBank(Id bankId)	Gets the OsidSession associated with the assessment taken query service for the given bank.
AssessmentTakenSearchSession	getAssessmentTakenSearchSession()	Gets the OsidSession associated with the assessment taken search service.
AssessmentTakenSearchSession	getAssessmentTakenSearchSessionForBank(Id bankId)	Gets the OsidSession associated with the assessment taken search service for the given bank.
AssessmentTakenSmartBankSession	getAssessmentTakenSmartBankSession(Id bankId)	Gets the OsidSession associated with the assessment taken smart banking service for the given bank.
BankAdminSession	getBankAdminSession()	Gets the OsidSession associated with the bank administration service.
BankHierarchyDesignSession	getBankHierarchyDesignSession()	Gets the session designing bank hierarchies.
BankHierarchySession	getBankHierarchySession()	Gets the session traversing bank hierarchies.
BankLookupSession	getBankLookupSession()	Gets the OsidSession associated with the bank lookup service.
BankNotificationSession	getBankNotificationSession(BankReceiver bankReceiver)	Gets the notification session for notifications pertaining to bank service changes.
BankQuerySession	getBankQuerySession()	Gets the OsidSession associated with the bank query service.
BankSearchSession	getBankSearchSession()	Gets the OsidSession associated with the bank search service.
ItemAdminSession	getItemAdminSession()	Gets the OsidSession associated with the item administration service.
ItemAdminSession	getItemAdminSessionForBank(Id bankId)	Gets the OsidSession associated with the item admin service for the given bank.
ItemBankAssignmentSession	getItemBankAssignmentSession()	Gets the OsidSession associated with the item bank assignment service.
ItemBankSession	getItemBankSession()	Gets the OsidSession associated with the item banking service.
ItemLookupSession	getItemLookupSession()	Gets the OsidSession associated with the item lookup service.
ItemLookupSession	getItemLookupSessionForBank(Id bankId)	Gets the OsidSession associated with the item lookup service for the given bank.
ItemNotificationSession	getItemNotificationSession(ItemReceiver itemReceiver)	Gets the notification session for notifications pertaining to item changes.
ItemNotificationSession	getItemNotificationSessionForBank(ItemReceiver itemReceiver, Id bankId)	Gets the OsidSession associated with the item notification service for the given bank.
ItemQuerySession	getItemQuerySession()	Gets the OsidSession associated with the item query service.
ItemQuerySession	getItemQuerySessionForBank(Id bankId)	Gets the OsidSession associated with the item query service for the given bank.
ItemSearchSession	getItemSearchSession()	Gets the OsidSession associated with the item search service.
ItemSearchSession	getItemSearchSessionForBank(Id bankId)	Gets the OsidSession associated with the item search service for the given bank.
ItemSmartBankSession	getItemSmartBankSession(Id bankId)	Gets the OsidSession associated with the item smart banking service for the given bank.
MyAssessmentTakenSession	getMyAssessmentTakenSession()	Gets a MyAssessmentTakenSession to retrieve assessments taken for the current agent.
MyAssessmentTakenSession	getMyAssessmentTakenSessionForBank(Id bankId)	Gets a MyAssessmentTakenSession to retrieve assessments taken for the current agent for the given bank Id .

Methods inherited from interface AssessmentProfile

getAssessmentOfferedRecordTypes, getAssessmentOfferedSearchRecordTypes, getAssessmentRecordTypes, getAssessmentSearchRecordTypes, getAssessmentSectionRecordTypes, getAssessmentTakenRecordTypes, getAssessmentTakenSearchRecordTypes, getBankRecordTypes, getBankSearchRecordTypes, getItemRecordTypes, getItemSearchRecordTypes, supportsAssessment, supportsAssessmentAdmin, supportsAssessmentAuthoring, supportsAssessmentBank, supportsAssessmentBankAssignment, supportsAssessmentBasicAuthoring, supportsAssessmentBatch, supportsAssessmentLookup, supportsAssessmentNotification, supportsAssessmentOfferedAdmin, supportsAssessmentOfferedBank, supportsAssessmentOfferedBankAssignment, supportsAssessmentOfferedLookup, supportsAssessmentOfferedNotification, supportsAssessmentOfferedQuery, supportsAssessmentOfferedRecordType, supportsAssessmentOfferedSearch, supportsAssessmentOfferedSearchRecordType, supportsAssessmentOfferedSmartBank, supportsAssessmentQuery, supportsAssessmentRecordType, supportsAssessmentResults, supportsAssessmentSearch, supportsAssessmentSearchRecordType, supportsAssessmentSectionRecordType, supportsAssessmentSmartBank, supportsAssessmentTakenAdmin, supportsAssessmentTakenBank, supportsAssessmentTakenBankAssignment, supportsAssessmentTakenLookup, supportsAssessmentTakenNotification, supportsAssessmentTakenQuery, supportsAssessmentTakenRecordType, supportsAssessmentTakenSearch, supportsAssessmentTakenSearchRecordType, supportsAssessmentTakenSmartBank, supportsBankAdmin, supportsBankHierarchy, supportsBankHierarchyDesign, supportsBankLookup, supportsBankNotification, supportsBankQuery, supportsBankRecordType, supportsBankSearch, supportsBankSearchRecordType, supportsItemAdmin, supportsItemBank, supportsItemBankAssignment, supportsItemLookup, supportsItemNotification, supportsItemQuery, supportsItemRecordType, supportsItemSearch, supportsItemSearchRecordType, supportsItemSmartBank, supportsMyAssessmentTaken, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getAssessmentOfferedRecordTypes()	Gets the supported AssessmentOffered record types.
TypeList	getAssessmentOfferedSearchRecordTypes()	Gets the supported AssessmentOffered search record types.
TypeList	getAssessmentRecordTypes()	Gets the supported Assessment record types.
TypeList	getAssessmentSearchRecordTypes()	Gets the supported Assessment search record types.
TypeList	getAssessmentSectionRecordTypes()	Gets the supported AssessmentSection record types.
TypeList	getAssessmentTakenRecordTypes()	Gets the supported AssessmentTaken record types.
TypeList	getAssessmentTakenSearchRecordTypes()	Gets the supported AssessmentTaken search record types.
TypeList	getBankRecordTypes()	Gets the supported Bank record types.
TypeList	getBankSearchRecordTypes()	Gets the supported bank search record types.
TypeList	getItemRecordTypes()	Gets the supported Item record types.
TypeList	getItemSearchRecordTypes()	Gets the supported Item search record types.
boolean	supportsAssessment()	Tests for the availability of an assessment service which is the service for taking and examining assessments taken.
boolean	supportsAssessmentAdmin()	Tests if an assessment administrative service is supported.
boolean	supportsAssessmentAuthoring()	Tests if an assessment authoring service is supported.
boolean	supportsAssessmentBank()	Tests if an assessment to bank lookup session is available.
boolean	supportsAssessmentBankAssignment()	Tests if an assessment to bank assignment session is available.
boolean	supportsAssessmentBasicAuthoring()	Tests if an assessment basic authoring session is available.
boolean	supportsAssessmentBatch()	Tests if an assessment batch service is supported.
boolean	supportsAssessmentLookup()	Tests if an assessment lookup service is supported.
boolean	supportsAssessmentNotification()	Tests if assessment notification is supported.
boolean	supportsAssessmentOfferedAdmin()	Tests if an assessment offered administrative service is supported.
boolean	supportsAssessmentOfferedBank()	Tests if an assessment offered to bank lookup session is available.
boolean	supportsAssessmentOfferedBankAssignment()	Tests if an assessment offered to bank assignment session is available.
boolean	supportsAssessmentOfferedLookup()	Tests if an assessment offered lookup service is supported.
boolean	supportsAssessmentOfferedNotification()	Tests if assessment offered notification is supported.
boolean	supportsAssessmentOfferedQuery()	Tests if an assessment offered query service is supported.
boolean	supportsAssessmentOfferedRecordType(Type assessmentOfferedRecordType)	Tests if the given AssessmentOffered record type is supported.
boolean	supportsAssessmentOfferedSearch()	Tests if an assessment offered search service is supported.
boolean	supportsAssessmentOfferedSearchRecordType(Type assessmentOfferedSearchRecordType)	Tests if the given AssessmentOffered search record type is supported.
boolean	supportsAssessmentOfferedSmartBank()	Tests if an assessment offered smart bank session is available.
boolean	supportsAssessmentQuery()	Tests if an assessment query service is supported.
boolean	supportsAssessmentRecordType(Type assessmentRecordType)	Tests if the given Assessment record type is supported.
boolean	supportsAssessmentResults()	Tests for the availability of an assessment rsults service.
boolean	supportsAssessmentSearch()	Tests if an assessment search service is supported.
boolean	supportsAssessmentSearchRecordType(Type assessmentSearchRecordType)	Tests if the given assessment search record type is supported.
boolean	supportsAssessmentSectionRecordType(Type assessmentSectionRecordType)	Tests if the given AssessmentSection record type is supported.
boolean	supportsAssessmentSmartBank()	Tests if an assessment smart bank session is available.
boolean	supportsAssessmentTakenAdmin()	Tests if an assessment taken administrative service is supported which is used to instantiate an assessment offered.
boolean	supportsAssessmentTakenBank()	Tests if an assessment taken to bank lookup session is available.
boolean	supportsAssessmentTakenBankAssignment()	Tests if an assessment taken to bank assignment session is available.
boolean	supportsAssessmentTakenLookup()	Tests if an assessment taken lookup service is supported.
boolean	supportsAssessmentTakenNotification()	Tests if assessment taken notification is supported.
boolean	supportsAssessmentTakenQuery()	Tests if an assessment taken query service is supported.
boolean	supportsAssessmentTakenRecordType(Type assessmentTakenRecordType)	Tests if the given AssessmentTaken record type is supported.
boolean	supportsAssessmentTakenSearch()	Tests if an assessment taken search service is supported.
boolean	supportsAssessmentTakenSearchRecordType(Type assessmentTakenSearchRecordType)	Tests if the given AssessmentTaken search record type is supported.
boolean	supportsAssessmentTakenSmartBank()	Tests if an assessment taken smart bank session is available.
boolean	supportsBankAdmin()	Tests if a banlk administrative service is supported.
boolean	supportsBankHierarchy()	Tests if a bank hierarchy traversal is supported.
boolean	supportsBankHierarchyDesign()	Tests if bank hierarchy design is supported.
boolean	supportsBankLookup()	Tests if a bank lookup service is supported.
boolean	supportsBankNotification()	Tests if bank notification is supported.
boolean	supportsBankQuery()	Tests if a bank query service is supported.
boolean	supportsBankRecordType(Type bankRecordType)	Tests if the given Bank record type is supported.
boolean	supportsBankSearch()	Tests if a bank search service is supported.
boolean	supportsBankSearchRecordType(Type bankSearchRecordType)	Tests if the given bank search record type is supported.
boolean	supportsItemAdmin()	Tests if an item administrative service is supported.
boolean	supportsItemBank()	Tests if an item to bank lookup session is available.
boolean	supportsItemBankAssignment()	Tests if an item to bank assignment session is available.
boolean	supportsItemLookup()	Tests if an item lookup service is supported.
boolean	supportsItemNotification()	Tests if item notification is supported.
boolean	supportsItemQuery()	Tests if an item query service is supported.
boolean	supportsItemRecordType(Type itemRecordType)	Tests if the given Item record type is supported.
boolean	supportsItemSearch()	Tests if an item search service is supported.
boolean	supportsItemSearchRecordType(Type itemSearchRecordType)	Tests if the given Item search record type is supported.
boolean	supportsItemSmartBank()	Tests if an item smart bank session is available.
boolean	supportsMyAssessmentTaken()	Tests if a session is available to lookup taken assessments for the authenticated agent.
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

getMyAssessmentTakenSession

MyAssessmentTakenSession getMyAssessmentTakenSession()
                                              throws OperationFailedException

Gets a MyAssessmentTakenSession to retrieve assessments taken for the current agent.

Returns:

a MyAssessmentTakenSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMyAssessmentTaken() is false

Compliance:

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

getMyAssessmentTakenSessionForBank

MyAssessmentTakenSession getMyAssessmentTakenSessionForBank(Id bankId)
                                                     throws NotFoundException,
OperationFailedException

Gets a MyAssessmentTakenSession to retrieve assessments taken for the current agent for the given bank Id .

Parameters:

bankId - the Id of a bank

Returns:

a MyAssessmentTakenSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyAssessmentTaken() is false

Compliance:

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

getAssessmentSession

AssessmentSession getAssessmentSession()
                                throws OperationFailedException

Gets an AssessmentSession which is responsible for taking assessments and examining responses from assessments taken.

Returns:

an assessment session for this service

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessment() is false

Compliance:

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

getAssessmentSessionForBank

AssessmentSession getAssessmentSessionForBank(Id bankId)
                                       throws NotFoundException,
OperationFailedException

Gets an AssessmentSession which is responsible for performing assessments for the given bank Id .

Parameters:

bankId - the Id of a bank

Returns:

an assessment session for this service

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessment() is false

Compliance:

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

getAssessmentResultsSession

AssessmentResultsSession getAssessmentResultsSession()
                                              throws OperationFailedException

Gets an AssessmentResultsSession to retrieve assessment results.

Returns:

an assessment results session for this service

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentResults() is false

Compliance:

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

getAssessmentResultsSessionForBank

AssessmentResultsSession getAssessmentResultsSessionForBank(Id bankId)
                                                     throws NotFoundException,
OperationFailedException

Gets an AssessmentResultsSession to retrieve assessment results for the given bank.

Parameters:

bankId - the Id of the assessment taken

Returns:

an assessment results session for this service

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentResults() is false

Compliance:

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

getItemLookupSession

ItemLookupSession getItemLookupSession()
                                throws OperationFailedException

Gets the OsidSession associated with the item lookup service.

Returns:

an ItemLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemLookup() is false

Compliance:

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

getItemLookupSessionForBank

ItemLookupSession getItemLookupSessionForBank(Id bankId)
                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the item lookup service for the given bank.

Parameters:

bankId - the Id of the bank

Returns:

an ItemLookupSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemLookup() or supportsVisibleFederation() is false

Compliance:

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

getItemQuerySession

ItemQuerySession getItemQuerySession()
                              throws OperationFailedException

Gets the OsidSession associated with the item query service.

Returns:

an ItemQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemQuery() is false

Compliance:

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

getItemQuerySessionForBank

ItemQuerySession getItemQuerySessionForBank(Id bankId)
                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the item query service for the given bank.

Parameters:

bankId - the Id of the bank

Returns:

an ItemQuerySession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemQuery() or supportsVisibleFederation() is false

Compliance:

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

getItemSearchSession

ItemSearchSession getItemSearchSession()
                                throws OperationFailedException

Gets the OsidSession associated with the item search service.

Returns:

an ItemSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemSearch() is false

Compliance:

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

getItemSearchSessionForBank

ItemSearchSession getItemSearchSessionForBank(Id bankId)
                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the item search service for the given bank.

Parameters:

bankId - the Id of the bank

Returns:

an ItemSearchSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemSearch() or supportsVisibleFederation() is false

Compliance:

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

getItemAdminSession

ItemAdminSession getItemAdminSession()
                              throws OperationFailedException

Gets the OsidSession associated with the item administration service.

Returns:

an ItemAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemAdmin() is false

Compliance:

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

getItemAdminSessionForBank

ItemAdminSession getItemAdminSessionForBank(Id bankId)
                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the item admin service for the given bank.

Parameters:

bankId - the Id of the bank

Returns:

an ItemAdminSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemAdmin() or supportsVisibleFederation() is false

Compliance:

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

getItemNotificationSession

ItemNotificationSession getItemNotificationSession(ItemReceiver itemReceiver)
                                            throws OperationFailedException

Gets the notification session for notifications pertaining to item changes.

Parameters:

itemReceiver - the item receiver interface

Returns:

an ItemNotificationSession

Throws:

NullArgumentException - itemReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemNotification() is false

Compliance:

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

getItemNotificationSessionForBank

ItemNotificationSession getItemNotificationSessionForBank(ItemReceiver itemReceiver,
 Id bankId)
                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the item notification service for the given bank.

Parameters:

itemReceiver - the item receiver interface

bankId - the Id of the bank

Returns:

an ItemNotificationSession

Throws:

NotFoundException - bankId not found

NullArgumentException - itemReceiver or bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemNotification() or supportsVisibleFederation() is false

Compliance:

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

getItemBankSession

ItemBankSession getItemBankSession()
                            throws OperationFailedException

Gets the OsidSession associated with the item banking service.

Returns:

an ItemBankSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBank() is false

Compliance:

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

getItemBankAssignmentSession

ItemBankAssignmentSession getItemBankAssignmentSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the item bank assignment service.

Returns:

an ItemBankAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBankAssignment() is false

Compliance:

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

getItemSmartBankSession

ItemSmartBankSession getItemSmartBankSession(Id bankId)
                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the item smart banking service for the given bank.

Parameters:

bankId - the Id of the bank

Returns:

an ItemSmartBankSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemSmartBank() is false

Compliance:

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

getAssessmentLookupSession

AssessmentLookupSession getAssessmentLookupSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the assessment lookup service.

Returns:

an AssessmentLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentLookup() is false

Compliance:

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

getAssessmentLookupSessionForBank

AssessmentLookupSession getAssessmentLookupSessionForBank(Id bankId)
                                                   throws NotFoundException,
OperationFailedException

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

Parameters:

bankId - the Id of the bank

Returns:

an AssessmentLookupSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentLookup() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentQuerySession

AssessmentQuerySession getAssessmentQuerySession()
                                          throws OperationFailedException

Gets the OsidSession associated with the assessment query service.

Returns:

an AssessmentQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentQuery() is false

Compliance:

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

getAssessmentQuerySessionForBank

AssessmentQuerySession getAssessmentQuerySessionForBank(Id bankId)
                                                 throws NotFoundException,
OperationFailedException

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

Parameters:

bankId - the Id of the bank

Returns:

an AssessmentQuerySession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentQuery() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentSearchSession

AssessmentSearchSession getAssessmentSearchSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the assessment search service.

Returns:

an AssessmentSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentSearch() is false

Compliance:

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

getAssessmentSearchSessionForBank

AssessmentSearchSession getAssessmentSearchSessionForBank(Id bankId)
                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the assessment search service for the given bank.

Parameters:

bankId - the Id of the bank

Returns:

an AssessmentSearchSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentSearch() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentAdminSession

AssessmentAdminSession getAssessmentAdminSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the assessment administration service.

Returns:

an AssessmentAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentAdmin() is false

Compliance:

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

getAssessmentAdminSessionForBank

AssessmentAdminSession getAssessmentAdminSessionForBank(Id bankId)
                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the assessment admin service for the given bank.

Parameters:

bankId - the Id of the bank

Returns:

an AssessmentAdminSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentNotificationSession

AssessmentNotificationSession getAssessmentNotificationSession(AssessmentReceiver assessmentReceiver)
                                                        throws OperationFailedException

Gets the notification session for notifications pertaining to assessment changes.

Parameters:

assessmentReceiver - the assessment receiver interface

Returns:

an AssessmentNotificationSession

Throws:

NullArgumentException - assessmentReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentNotification() is false

Compliance:

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

getAssessmentNotificationSessionForBank

AssessmentNotificationSession getAssessmentNotificationSessionForBank(AssessmentReceiver assessmentReceiver,
 Id bankId)
                                                               throws NotFoundException,
OperationFailedException

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

Parameters:

assessmentReceiver - the assessment receiver interface

bankId - the Id of the bank

Returns:

an AssessmentNotificationSession

Throws:

NotFoundException - bankId not found

NullArgumentException - assessmentReceiver or bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentNotification() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentBankSession

AssessmentBankSession getAssessmentBankSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the assessment banking service.

Returns:

an AssessmentBankSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentBank() is false

Compliance:

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

getAssessmentBankAssignmentSession

AssessmentBankAssignmentSession getAssessmentBankAssignmentSession()
                                                            throws OperationFailedException

Gets the OsidSession associated with the assessment bank assignment service.

Returns:

an AssessmentBankAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentBankAssignment() is false

Compliance:

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

getAssessmentSmartBankSession

AssessmentSmartBankSession getAssessmentSmartBankSession(Id bankId)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the assessment smart banking service for the given bank.

Parameters:

bankId - the Id of the bank

Returns:

an AssessmentSmartBankSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentSmartBank() is false

Compliance:

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

getAssessmentBasicAuthoringSession

AssessmentBasicAuthoringSession getAssessmentBasicAuthoringSession()
                                                            throws OperationFailedException

Gets the OsidSession associated with the assessment authoring service.

Returns:

an AssessmentBasicAuthoringSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentBasicAuthoring() is false

Compliance:

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

getAssessmentBasicAuthoringSessionForBank

AssessmentBasicAuthoringSession getAssessmentBasicAuthoringSessionForBank(Id bankId)
                                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the assessment authoring service for the given bank.

Parameters:

bankId - the Id of a bank

Returns:

an AssessmentBasicAuthoringSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentBasicAuthoring() or supportsVisibeFederation() is false

Compliance:

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

getAssessmentOfferedLookupSession

AssessmentOfferedLookupSession getAssessmentOfferedLookupSession()
                                                          throws OperationFailedException

Gets the OsidSession associated with the assessment offered lookup service.

Returns:

an AssessmentOfferedLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedLookup() is false

Compliance:

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

getAssessmentOfferedLookupSessionForBank

AssessmentOfferedLookupSession getAssessmentOfferedLookupSessionForBank(Id bankId)
                                                                 throws NotFoundException,
OperationFailedException

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

Parameters:

bankId - the Id of the bank

Returns:

an AssessmentOfferedLookupSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedLookup() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentOfferedQuerySession

AssessmentOfferedQuerySession getAssessmentOfferedQuerySession()
                                                        throws OperationFailedException

Gets the OsidSession associated with the assessment offered query service.

Returns:

an AssessmentOfferedQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedQuery() is false

Compliance:

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

getAssessmentOfferedQuerySessionForBank

AssessmentOfferedQuerySession getAssessmentOfferedQuerySessionForBank(Id bankId)
                                                               throws NotFoundException,
OperationFailedException

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

Parameters:

bankId - the Id of the bank

Returns:

an AssessmentOfferedQuerySession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedQuery() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentOfferedSearchSession

AssessmentOfferedSearchSession getAssessmentOfferedSearchSession()
                                                          throws OperationFailedException

Gets the OsidSession associated with the assessment offered search service.

Returns:

an AssessmentOfferedSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedSearch() is false

Compliance:

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

getAssessmentOfferedSearchSessionForBank

AssessmentOfferedSearchSession getAssessmentOfferedSearchSessionForBank(Id bankId)
                                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the assessment offered search service for the given bank.

Parameters:

bankId - the Id of the bank

Returns:

an AssessmentOfferedSearchSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedSearch() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentOfferedAdminSession

AssessmentOfferedAdminSession getAssessmentOfferedAdminSession()
                                                        throws OperationFailedException

Gets the OsidSession associated with the assessment offered administration service.

Returns:

an AssessmentOfferedAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedAdmin() is false

Compliance:

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

getAssessmentOfferedAdminSessionForBank

AssessmentOfferedAdminSession getAssessmentOfferedAdminSessionForBank(Id bankId)
                                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the assessment offered admin service for the given bank.

Parameters:

bankId - the Id of the bank

Returns:

an AssessmentOfferedAdminSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentOfferedNotificationSession

AssessmentOfferedNotificationSession getAssessmentOfferedNotificationSession(AssessmentOfferedReceiver assessmentOfferedReceiver)
                                                                      throws OperationFailedException

Gets the notification session for notifications pertaining to offered assessment changes.

Parameters:

assessmentOfferedReceiver - the assessment offered receiver interface

Returns:

an AssessmentOfferedNotificationSession

Throws:

NullArgumentException - assessmentOfferedReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedNotification() is false

Compliance:

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

getAssessmentOfferedNotificationSessionForBank

AssessmentOfferedNotificationSession getAssessmentOfferedNotificationSessionForBank(AssessmentOfferedReceiver assessmentOfferedReceiver,
 Id bankId)
                                                                             throws NotFoundException,
OperationFailedException

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

Parameters:

assessmentOfferedReceiver - the assessment offered receiver interface

bankId - the Id of the bank

Returns:

a AssessmentOfferedNotificationSession

Throws:

NotFoundException - bankId not found

NullArgumentException - assessmentOfferedReceiver or bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedNotification() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentOfferedBankSession

AssessmentOfferedBankSession getAssessmentOfferedBankSession()
                                                      throws OperationFailedException

Gets the session for retrieving offered assessments to bank mappings.

Returns:

an AssessmentOfferedBankSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedBank() is false

Compliance:

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

getAssessmentOfferedBankAssignmentSession

AssessmentOfferedBankAssignmentSession getAssessmentOfferedBankAssignmentSession()
                                                                          throws OperationFailedException

Gets the session for assigning offered assessments to bank mappings.

Returns:

an AssessmentOfferedBankAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedBankAssignment() is false

Compliance:

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

getAssessmentOfferedSmartBankSession

AssessmentOfferedSmartBankSession getAssessmentOfferedSmartBankSession(Id bankId)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the assessment offered smart banking service for the given bank.

Parameters:

bankId - the Id of the bank

Returns:

an AssessmentOfferedSmartBankSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedSmartBank() is false

Compliance:

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

getAssessmentTakenLookupSession

AssessmentTakenLookupSession getAssessmentTakenLookupSession()
                                                      throws OperationFailedException

Gets the OsidSession associated with the assessment taken lookup service.

Returns:

an AssessmentTakenLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenLookup() is false

Compliance:

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

getAssessmentTakenLookupSessionForBank

AssessmentTakenLookupSession getAssessmentTakenLookupSessionForBank(Id bankId)
                                                             throws NotFoundException,
OperationFailedException

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

Parameters:

bankId - the Id of the bank

Returns:

an AssessmentTakenLookupSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenLookup() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentTakenQuerySession

AssessmentTakenQuerySession getAssessmentTakenQuerySession()
                                                    throws OperationFailedException

Gets the OsidSession associated with the assessment taken query service.

Returns:

an AssessmentTakenQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenQuery() is false

Compliance:

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

getAssessmentTakenQuerySessionForBank

AssessmentTakenQuerySession getAssessmentTakenQuerySessionForBank(Id bankId)
                                                           throws NotFoundException,
OperationFailedException

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

Parameters:

bankId - the Id of the bank

Returns:

an AssessmentTakenQuerySession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenQuery() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentTakenSearchSession

AssessmentTakenSearchSession getAssessmentTakenSearchSession()
                                                      throws OperationFailedException

Gets the OsidSession associated with the assessment taken search service.

Returns:

an AssessmentTakenSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenSearch() is false

Compliance:

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

getAssessmentTakenSearchSessionForBank

AssessmentTakenSearchSession getAssessmentTakenSearchSessionForBank(Id bankId)
                                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the assessment taken search service for the given bank.

Parameters:

bankId - the Id of the bank

Returns:

an AssessmentTakenSearchSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenSearch() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentTakenAdminSession

AssessmentTakenAdminSession getAssessmentTakenAdminSession()
                                                    throws OperationFailedException

Gets the OsidSession associated with the assessment taken administration service.

Returns:

an AssessmentTakenAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenAdmin() is false

Compliance:

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

getAssessmentTakenAdminSessionForBank

AssessmentTakenAdminSession getAssessmentTakenAdminSessionForBank(Id bankId)
                                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the assessment taken admin service for the given bank.

Parameters:

bankId - the Id of the bank

Returns:

an AssessmentTakenSearchSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentTakenNotificationSession

AssessmentTakenNotificationSession getAssessmentTakenNotificationSession(AssessmentTakenReceiver assessmentTakenReceiver)
                                                                  throws OperationFailedException

Gets the notification session for notifications pertaining to taken assessment changes.

Parameters:

assessmentTakenReceiver - the assessment taken receiver interface

Returns:

an AssessmentTakenNotificationSession

Throws:

NullArgumentException - assessmentTakenReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenNotification() is false

Compliance:

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

getAssessmentTakenNotificationSessionForBank

AssessmentTakenNotificationSession getAssessmentTakenNotificationSessionForBank(AssessmentTakenReceiver assessmentTakenReceiver,
 Id bankId)
                                                                         throws NotFoundException,
OperationFailedException

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

Parameters:

assessmentTakenReceiver - the assessment taken receiver interface

bankId - the Id of the bank

Returns:

an AssessmentTakenNotificationSession

Throws:

NotFoundException - bankId not found

NullArgumentException - assessmentTakenReceiver or bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenNotification() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentTakenBankSession

AssessmentTakenBankSession getAssessmentTakenBankSession()
                                                  throws OperationFailedException

Gets the session for retrieving taken assessments to bank mappings.

Returns:

an AssessmentTakenBankSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenBank() is false

Compliance:

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

getAssessmentTakenBankAssignmentSession

AssessmentTakenBankAssignmentSession getAssessmentTakenBankAssignmentSession()
                                                                      throws OperationFailedException

Gets the session for assigning taken assessments to bank mappings.

Returns:

an AssessmentTakenBankAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenBankAssignment() is false

Compliance:

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

getAssessmentTakenSmartBankSession

AssessmentTakenSmartBankSession getAssessmentTakenSmartBankSession(Id bankId)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the assessment taken smart banking service for the given bank.

Parameters:

bankId - the Id of the bank

Returns:

an AssessmentTakenSmartBankSession

Throws:

NotFoundException - bankId not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenSmartBank() is false

Compliance:

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

getBankLookupSession

BankLookupSession getBankLookupSession()
                                throws OperationFailedException

Gets the OsidSession associated with the bank lookup service.

Returns:

a BankLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBankLookup() is false

Compliance:

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

getBankQuerySession

BankQuerySession getBankQuerySession()
                              throws OperationFailedException

Gets the OsidSession associated with the bank query service.

Returns:

a BankQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBankQuery() is false

Compliance:

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

getBankSearchSession

BankSearchSession getBankSearchSession()
                                throws OperationFailedException

Gets the OsidSession associated with the bank search service.

Returns:

a BankSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBankSearch() is false

Compliance:

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

getBankAdminSession

BankAdminSession getBankAdminSession()
                              throws OperationFailedException

Gets the OsidSession associated with the bank administration service.

Returns:

a BankAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBankAdmin() is false

Compliance:

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

getBankNotificationSession

BankNotificationSession getBankNotificationSession(BankReceiver bankReceiver)
                                            throws OperationFailedException

Gets the notification session for notifications pertaining to bank service changes.

Parameters:

bankReceiver - the bank receiver interface

Returns:

a BankNotificationSession

Throws:

NullArgumentException - bankReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBankNotification() is false

Compliance:

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

getBankHierarchySession

BankHierarchySession getBankHierarchySession()
                                      throws OperationFailedException

Gets the session traversing bank hierarchies.

Returns:

a BankHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBankHierarchy() is false

Compliance:

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

getBankHierarchyDesignSession

BankHierarchyDesignSession getBankHierarchyDesignSession()
                                                  throws OperationFailedException

Gets the session designing bank hierarchies.

Returns:

a BankHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBankHierarchyDesign() is false

Compliance:

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

getAssessmentAuthoringManager

AssessmentAuthoringManager getAssessmentAuthoringManager()
                                                  throws OperationFailedException

Gets an AssessmentAuthoringManager .

Returns:

an AssessmentAuthoringManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentAuthoring() is false

Compliance:

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

getAssessmentBatchManager

AssessmentBatchManager getAssessmentBatchManager()
                                          throws OperationFailedException

Gets an AssessmentBatchManager .

Returns:

an AssessmentBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentBatch() is false

Compliance:

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