org.sakaiproject.tool.assessment.shared.api.qti

Interface QTIServiceAPI

public interface QTIServiceAPI

Method Summary

Modifier and Type	Method and Description
AssessmentIfc	createImportedAssessment(Document document, int qtiVersion) Import an assessment XML document in QTI format, extract & persist the data.
AssessmentIfc	createImportedAssessment(String documentPath, int qtiVersion, String siteId) Import an assessment XML document in QTI format, extract & persist the data.
ItemDataIfc	createImportedItem(Document document, int qtiVersion) Import an item XML document in QTI format, extract & persist the data.
Document	getExportedAssessment(String assessmentId, int qtiVersion) Get an assessment in Document form.
String	getExportedAssessmentAsString(String assessmentId, int qtiVersion) Get an assessment in String form.
Document	getExportedItem(String itemId, int qtiVersion) Get an item in Document form.
Document	getExportedItemBank(String[] itemIds, int qtiVersion) Get an item bank in Document form.

Method Detail

createImportedAssessment

AssessmentIfc createImportedAssessment(Document document,
                                       int qtiVersion)

Import an assessment XML document in QTI format, extract & persist the data.

Parameters:

document - the assessment XML document in QTI format

qtiVersion - either 1=QTI VERSION 1.2 or 2=QTI Version 2.0

Returns:

a persisted assessment

createImportedAssessment

AssessmentIfc createImportedAssessment(String documentPath,
                                       int qtiVersion,
                                       String siteId)

Import an assessment XML document in QTI format, extract & persist the data.

Parameters:

documentPath - the pathname to a file with the assessment XML document in QTI format

qtiVersion - either 1=QTI VERSION 1.2 or 2=QTI Version 2.0

siteId - the site the assessment will be associated with

Returns:

a persisted assessment

createImportedItem

ItemDataIfc createImportedItem(Document document,
                               int qtiVersion)

Import an item XML document in QTI format, extract & persist the data.

Parameters:

document - the item XML document in QTI format

qtiVersion - either 1=QTI VERSION 1.2 or 2=QTI Version 2.0

Returns:

a persisted item

getExportedAssessment

Document getExportedAssessment(String assessmentId,
                               int qtiVersion)

Get an assessment in Document form. Note: this service requires a Faces context.

Parameters:

assessmentId - the assessment's Id

qtiVersion - either 1=QTI VERSION 1.2 or 2=QTI Version 2.0

Returns:

the Document with the assessment data

getExportedAssessmentAsString

String getExportedAssessmentAsString(String assessmentId,
                                     int qtiVersion)

Get an assessment in String form. Note: this service requires a Faces context.

Parameters:

assessmentId - the assessment's Id

qtiVersion - either 1=QTI VERSION 1.2 or 2=QTI Version 2.0

Returns:

the Document with the assessment data

getExportedItem

Document getExportedItem(String itemId,
                         int qtiVersion)

Get an item in Document form. Note: this service requires a Faces context.

Parameters:

itemId - the item's Id

qtiVersion - either 1=QTI VERSION 1.2 or 2=QTI Version 2.0

Returns:

the Document with the assessment data

getExportedItemBank

Document getExportedItemBank(String[] itemIds,
                             int qtiVersion)

Get an item bank in Document form. Note: this service requires a Faces context.

Parameters:

itemIds - an array of item ids

qtiVersion - either 1=QTI VERSION 1.2 or 2=QTI Version 2.0

Returns:

the Document with the item bank