org.osid.assessment

Interface AssessmentManager

All Superinterfaces:

AssessmentProfile, java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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.
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.
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.
AssessmentNotificationSession	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 org.osid.OsidManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.assessment.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

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

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 supportsMyAssessmentTaken() is 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 supportsMyAssessmentTaken() is 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 supportsAssessment() is 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 supportsAssessment() is 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 supportsAssessmentResults() is 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 supportsAssessmentResults() is 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 supportsItemLookup() is 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 supportsItemLookup() and supportsVisibleFederation() are 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 supportsItemQuery() is 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 supportsItemQuery() and supportsVisibleFederation() are 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 supportsItemSearch() is 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 supportsItemSearch() and supportsVisibleFederation() are 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 supportsItemAdmin() is 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 supportsItemAdmin() and supportsVisibleFederation() are 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 supportsItemNotification() is true.

getItemNotificationSessionForBank

AssessmentNotificationSession 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 supportsItemNotification() and supportsVisibleFederation() are 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 supportsItemBank() is 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 supportsItemBankAssignment() is 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 supportsItemSmartBank() and supportsVisibeFederation() is 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 supportsAssessmentLookup() is 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 supportsAssessmentLookup() and supportsVisibleFederation() are 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 supportsAssessmentQuery() is 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 supportsAssessmentQuery() and supportsVisibleFederation() are 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 supportsAssessmentSearch() is 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 supportsAssessmentSearch() and supportsVisibleFederation() are 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 supportsAssessmentAdmin() is 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 supportsAssessmentAdmin() and supportsVisibleFederation() are 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 supportsAssessmentNotification() is 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 supportsAssessmentNotification() and supportsVisibleFederation() are 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 supportsAssessmentBank() is 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 supportsAssessmentBankAssignment() is 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 supportsAssessmentSmartBank() and supportsVisibeFederation() is 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 supportsAssessmentBasicAuthoring() is 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 supportsAssessmentBasicAuthoring() and supportsVisibeFederation() is 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 supportsAssessmentOfferedLookup() is 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 supportsAssessmentOfferedLookup() and supportsVisibleFederation() are 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 supportsAssessmentOfferedQuery() is 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 supportsAssessmentOfferedQuery() and supportsVisibleFederation() are 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 supportsAssessmentOfferedSearch() is 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 supportsAssessmentOfferedSearch() and supportsVisibleFederation() are 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 supportsAssessmentOfferedAdmin() is 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 supportsAssessmentOfferedAdmin() and supportsVisibleFederation() are 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 supportsAssessmentOfferedNotification() is 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 supportsAssessmentOfferedNotification() and supportsVisibleFederation() are 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 supportsAssessmentOfferedBank() is 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 supportsAssessmentOfferedBankAssignment() is 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 supportsAssessmentOfferedSmartBank() and supportsVisibeFederation() is 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 supportsAssessmentTakenLookup() is 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 supportsAssessmentTakenLookup() and supportsVisibleFederation() are 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 supportsAssessmentTakenQuery() is 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 supportsAssessmentTakenQuery() and supportsVisibleFederation() are 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 supportsAssessmentTakenSearch() is 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 supportsAssessmentTakenSearch() and supportsVisibleFederation() are 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 supportsAssessmentTakenNotification() is 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 supportsAssessmentTakenNotification() and supportsVisibleFederation() are 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 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 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 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 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 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 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 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 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 supportsAssessmentBatch() is true.