@AccessLevel(value=EXTERNAL)
public interface AssessmentDefinition
extends curam.piwrapper.caseconfiguration.impl.CaseConfiguration, curam.util.persistence.OptimisticLockable, curam.util.type.DateRanged, curam.util.persistence.helper.Lifecycle<curam.codetable.impl.RECORDSTATUSEntry>, curam.assessmentplanning.administration.impl.FactorLinkable, curam.assessmentplanning.administration.impl.CategoryRelateable
Modifier and Type | Method and Description |
---|---|
boolean |
displayScore()
Returns true if scoring should be displayed for the given assessment, false
otherwise.
|
java.lang.String |
getApproveAndRejectRights()
Retrieves the security identifier associated with the right to approve an
assessment that is related to the assessment definition.
|
curam.codetable.impl.ASSESSMENTCATEGORYTYPEEntry |
getAssessmentCategory()
Returns the assessment category.
|
curam.codetable.impl.ASSESSMENTEXECUTIONFROMEntry |
getAssessmentExecutionLocation(curam.piwrapper.caseconfiguration.impl.CaseConfiguration caseConfiguration)
Retrieves the codetable entry,
ASSESSMENTEXECUTIONFROMEntry which
specifies the location of where the assessments can be executed from. |
curam.codetable.impl.ASSESSMENTGROUPINGEntry |
getAssessmentGrouping()
Returns the assessment grouping, e.g
ASSESSMENTGROUPINGEntry.SDM . |
int |
getAssessmentInterval()
Returns the assessment interval of this Assessment Definition.
|
java.lang.String |
getAssessmentName()
Retrieves the name of the assessment, i.e. the name of the CERT or CDA
assessment.
|
java.lang.String |
getAssessmentResultsPage()
Returns the page used to display assessment results when graphs are not
used.
|
curam.codetable.impl.ASSESSMENTDEFINITIONTYPEEntry |
getAssessmentType()
Retrieves the assessment type field.
|
java.lang.String |
getClassificationDisplayText()
Returns the classification display text for this Assessment Definition.
|
java.lang.String |
getCloseRights()
Retrieves the security identifier associated with the right to close an
assessment that is related to the assessment definition.
|
boolean |
getCountSameScoreAsOnePriorityInd()
Retrieves a boolean value indicating if the same factor score achieved by
more than one client during an assessment can be counted as a single
priority factor.
|
java.lang.String |
getCreatedBy()
Returns the name of the user who created this Assessment Definition.
|
java.lang.String |
getCreateRights()
Retrieves the security identifier associated with the right to create an
assessment that is related to the assessment definition.
|
curam.util.type.Date |
getCreationDate()
Returns the date on which this Assessment Definition was created.
|
java.lang.String |
getDescription()
Returns the description of this Assessment Definition.
|
boolean |
getDisplayGraphs()
Returns the displayGraphs indicator.
|
boolean |
getDisplayGuidance()
Returns the display guidance indicator.
|
curam.codetable.impl.ASSESSMENTDEFINITIONCASEDISPLAYEntry |
getDisplayOnCasePages(curam.piwrapper.caseconfiguration.impl.CaseConfiguration caseConfiguration)
Retrieves the codetable entry,
ASSESSMENTDEFINITIONCASEDISPLAYEntry
, that describes if the details of executed assessments related to this
assessment definition can be displayed on the case pages the linked
case configuration is in relation to. |
boolean |
getDisplayResultsByCategory()
Indicates if results for this assessment should be displayed in groups by
category.
|
boolean |
getDisplayScore()
Returns the display score indicator.
|
java.lang.String |
getFactorDisplayText()
Returns the factor display text for this Assessment Definition.
|
curam.codetable.impl.ASSESSMENTDEFINITIONGRAPHBYEntry |
getGraphBy()
Returns the graphBy field.
|
curam.codetable.impl.ASSESSMENTDEFINITIONGRAPHTYPEEntry |
getGraphType()
Returns the graphType field.
|
java.lang.String |
getGroupName()
Returns the group name field of the Assessment Definition.
|
curam.codetable.impl.GUIDANCERESULTCLUSTEREntry |
getGuidanceResultClusterConfiguration()
Returns the configuration for the guidance result cluster.
|
double |
getMaxRangeValueFromFactorClassifications()
Returns the maximum range of all classifications for all factors.
|
double |
getMinRangeValueFromFactorClassifications()
Returns the minimum range of all classifications for all factors.
|
java.lang.String |
getName()
Returns the name of this Assessment Definition.
|
int |
getReassessmentWarningDays()
Returns number of days before reassessment is due that a workflow event is
raised.
|
java.lang.String |
getReference()
Retrieves the reference field.
|
java.lang.String |
getViewAnswerRights()
Retrieves the security identifier associated with the rights to view an
assessments answers that is related to the assessment definition.
|
boolean |
isAssessmentRolesUpdateable()
Returns true if assessment role(s) can be be updated for reassessment,
false otherwise.
|
boolean |
isPrioritiesApplicable()
Returns true if priorities apply to factor results on the assessment,
otherwise returns false.
|
boolean |
isReassessmentAllowed()
Returns true if reassessment is allowed for the assessment, otherwise
false.
|
boolean |
isRoleBasedAssessment()
Returns true if the assessment is role based, false otherwise.
|
java.util.List<curam.piwrapper.caseconfiguration.impl.CaseConfiguration> |
listCaseConfigurations()
Retrieves an immutable lists of all case configuration records that are
currently related to the assessment definition.
|
java.lang.Boolean |
multipleCategoriesUsed()
Returns true if multiple categories exist for the assessment definition,
false otherwise.
|
boolean |
scoringUsed()
Returns true if scoring is used in the given assessment, false otherwise.
|
getCaseConfigurationName, getCaseType, getLinkText, getPageLink
addLink, getFactorRelatedType
java.lang.String getName()
java.lang.String getGroupName()
curam.codetable.impl.ASSESSMENTDEFINITIONTYPEEntry getAssessmentType()
int getAssessmentInterval()
int getReassessmentWarningDays()
java.lang.String getDescription()
java.lang.String getFactorDisplayText()
java.lang.String getClassificationDisplayText()
curam.util.type.Date getCreationDate()
java.lang.String getCreatedBy()
java.lang.String getCreateRights()
java.lang.String getApproveAndRejectRights()
java.lang.String getCloseRights()
java.lang.String getViewAnswerRights()
boolean isAssessmentRolesUpdateable()
boolean isRoleBasedAssessment()
boolean isReassessmentAllowed()
boolean isPrioritiesApplicable()
curam.codetable.impl.ASSESSMENTCATEGORYTYPEEntry getAssessmentCategory()
java.lang.String getAssessmentName()
boolean scoringUsed() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.InformationalException
- Generic Application Exceptioncuram.util.exception.AppException
- Generic Application Exceptionboolean displayScore() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.InformationalException
- Generic Application Exceptioncuram.util.exception.AppException
- Generic Application Exceptionjava.lang.String getReference()
double getMaxRangeValueFromFactorClassifications()
double getMinRangeValueFromFactorClassifications()
boolean getDisplayGraphs()
boolean getDisplayGuidance()
boolean getDisplayScore()
curam.codetable.impl.GUIDANCERESULTCLUSTEREntry getGuidanceResultClusterConfiguration()
curam.codetable.impl.ASSESSMENTDEFINITIONGRAPHBYEntry getGraphBy()
curam.codetable.impl.ASSESSMENTDEFINITIONGRAPHTYPEEntry getGraphType()
boolean getDisplayResultsByCategory()
boolean getCountSameScoreAsOnePriorityInd()
java.lang.Boolean multipleCategoriesUsed()
java.lang.String getAssessmentResultsPage()
curam.codetable.impl.ASSESSMENTGROUPINGEntry getAssessmentGrouping()
ASSESSMENTGROUPINGEntry.SDM
.
This is an optional field.java.util.List<curam.piwrapper.caseconfiguration.impl.CaseConfiguration> listCaseConfigurations() throws curam.util.exception.InformationalException, curam.util.exception.AppException
curam.util.exception.InformationalException
- Generic Informational Exception.curam.util.exception.AppException
- Generic Application Exception.curam.codetable.impl.ASSESSMENTDEFINITIONCASEDISPLAYEntry getDisplayOnCasePages(curam.piwrapper.caseconfiguration.impl.CaseConfiguration caseConfiguration)
ASSESSMENTDEFINITIONCASEDISPLAYEntry
, that describes if the details of executed assessments related to this
assessment definition can be displayed on the case pages the linked
case configuration
is in relation to.caseConfiguration
- the case configuration this assessment definition is linked to
that the display on case pages configuration is being set in
relation toASSESSMENTDEFINITIONCASEDISPLAYEntry.YES
if the details of
executed assessments related to this assessment definition can be displayed
on the case pages related to the passed in case configuration.ASSESSMENTDEFINITIONCASEDISPLAYEntry.NO
if the details of executed
assessments related to this assessment definition are not configured for
display on the case pages related to the give case configurationASSESSMENTDEFINITIONCASEDISPLAYEntry.NOT_SPECIFIED
if the value
is not set, or the case configuration is not linked to this assessment
definitionAssessmentDefinition#isConfiguredForCaseConfigurationDisplay(CaseConfiguration)}
for determining if this assessment definition is configured for
display on the case pages the given case configuration is in relation
to
curam.codetable.impl.ASSESSMENTEXECUTIONFROMEntry getAssessmentExecutionLocation(curam.piwrapper.caseconfiguration.impl.CaseConfiguration caseConfiguration)
ASSESSMENTEXECUTIONFROMEntry
which
specifies the location of where the assessments can be executed from.caseConfiguration
- the case configuration this assessment definition is linked to
that the display on case pages configuration is being set in
relation toAssessmentDefinition#isConfiguredForCaseConfigurationDisplay(CaseConfiguration)}
for determining if this assessment definition is configured for
display on the case pages the given case configuration is in relation
to