curam.decisionassist.facade.admin.intf

Interface Questionnaire

All Known Implementing Classes:

Questionnaire, curam.decisionassist.facade.admin.impl.Questionnaire, QuestionnaireFactory

@AccessLevel(value=EXTERNAL)
public interface Questionnaire

Method Summary

Modifier and Type	Method and Description
curam.decisionassist.facade.admin.struct.ListQuestionnaires	listQuestionnaires() This method returns the list of questionnaire records on the system.
curam.decisionassist.facade.admin.struct.TypicalPictureList	listTPsAssociatedToQuestionnaire(curam.decisionassist.facade.admin.struct.QuestionnaireVersionKey key) This method lists all the typical picture records associated with a questionnaire record.
curam.ieg.facade.struct.IEGScriptKey	readIEGScriptKey(curam.decisionassist.facade.admin.struct.QuestionnaireVersionKey key) This method is used to return the IEGScript key information for editing the questions of the questionnaire.
curam.decisionassist.facade.admin.struct.ViewQuestionnaireDetails	readLatestQuestionnaireVersion(curam.decisionassist.facade.admin.struct.QuestionnaireKey key) This method returns the latest questionnaire record on the system irregardless of status.
curam.decisionassist.facade.admin.struct.ReadLatestVersionDescription	readLatestQuestionnaireVersionDescription(curam.decisionassist.facade.admin.struct.QuestionnaireVersionKey key) This method returns the latest questionnaire record on the system irregardless of status.
curam.decisionassist.facade.admin.struct.ReadQuestionnaireDetails	readQuestionnaire(curam.decisionassist.facade.admin.struct.QuestionnaireVersionKey key) This method returns the questionnaire header details only: questionnaire name, version number, and type.
curam.decisionassist.facade.admin.struct.ReadVersionDescription	readTypicalPictureHeaderDetails(curam.decisionassist.facade.admin.struct.QuestionnaireVersionKey key) This method returns a questionnaire record based on the version number provided.
curam.ieg.facade.struct.IEGScriptValidationDetailsList	validateQuestionScript(curam.decisionassist.facade.admin.struct.QuestionnaireVersionKey key) This method is used to validate the question script which is associated with the given questionnaire version.
curam.decisionassist.facade.admin.struct.ViewQuestionnaireDetails	viewQuestionnaireDetails(curam.decisionassist.facade.admin.struct.QuestionnaireVersionKey key) This method returns a questionnaire record with questionnaire details, questionnaire version information, and the list of questions in it.

Method Detail

listQuestionnaires

@AccessLevel(value=EXTERNAL)
curam.decisionassist.facade.admin.struct.ListQuestionnaires listQuestionnaires()
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

This method returns the list of questionnaire records on the system.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readLatestQuestionnaireVersion

@AccessLevel(value=EXTERNAL)
curam.decisionassist.facade.admin.struct.ViewQuestionnaireDetails readLatestQuestionnaireVersion(curam.decisionassist.facade.admin.struct.QuestionnaireKey key)
                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                              curam.util.exception.InformationalException

This method returns the latest questionnaire record on the system irregardless of status. One questionnaire can have multiple versions, and the latest questionnaire record and its latest version are returned.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listTPsAssociatedToQuestionnaire

@AccessLevel(value=EXTERNAL)
curam.decisionassist.facade.admin.struct.TypicalPictureList listTPsAssociatedToQuestionnaire(curam.decisionassist.facade.admin.struct.QuestionnaireVersionKey key)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

This method lists all the typical picture records associated with a questionnaire record.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewQuestionnaireDetails

@AccessLevel(value=EXTERNAL)
curam.decisionassist.facade.admin.struct.ViewQuestionnaireDetails viewQuestionnaireDetails(curam.decisionassist.facade.admin.struct.QuestionnaireVersionKey key)
                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                        curam.util.exception.InformationalException

This method returns a questionnaire record with questionnaire details, questionnaire version information, and the list of questions in it.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readQuestionnaire

@AccessLevel(value=EXTERNAL)
curam.decisionassist.facade.admin.struct.ReadQuestionnaireDetails readQuestionnaire(curam.decisionassist.facade.admin.struct.QuestionnaireVersionKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

This method returns the questionnaire header details only: questionnaire name, version number, and type.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readLatestQuestionnaireVersionDescription

@AccessLevel(value=EXTERNAL)
curam.decisionassist.facade.admin.struct.ReadLatestVersionDescription readLatestQuestionnaireVersionDescription(curam.decisionassist.facade.admin.struct.QuestionnaireVersionKey key)
                                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                                             curam.util.exception.InformationalException

This method returns the latest questionnaire record on the system irregardless of status.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readTypicalPictureHeaderDetails

@AccessLevel(value=EXTERNAL)
curam.decisionassist.facade.admin.struct.ReadVersionDescription readTypicalPictureHeaderDetails(curam.decisionassist.facade.admin.struct.QuestionnaireVersionKey key)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

This method returns a questionnaire record based on the version number provided.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

validateQuestionScript

@AccessLevel(value=EXTERNAL)
curam.ieg.facade.struct.IEGScriptValidationDetailsList validateQuestionScript(curam.decisionassist.facade.admin.struct.QuestionnaireVersionKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

This method is used to validate the question script which is associated with the given questionnaire version.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readIEGScriptKey

@AccessLevel(value=EXTERNAL)
curam.ieg.facade.struct.IEGScriptKey readIEGScriptKey(curam.decisionassist.facade.admin.struct.QuestionnaireVersionKey key)
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

This method is used to return the IEGScript key information for editing the questions of the questionnaire.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException