AssessmentCase (AssessmentPlanning)

All Known Implementing Classes:

AssessmentCase, curam.assessmentplanning.delivery.facade.impl.AssessmentCase, AssessmentCaseFactory
```
public interface AssessmentCase
```
Facade layer class used for the management of an assessment case. An assessment case is created when an assessment is initially run and has an associated case header record of type Assessment Case.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`approve(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)` Approves the assessment case.
`void`	`close(curam.assessmentplanning.delivery.facade.struct.AssessmentCaseClosureDetails closureDetails, curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey assessmentCaseKey)` Closes the overall assessment case, setting the status on the case header record to 'Closed' and setting the status of the corresponding initial assessment instance to 'Closed', and setting the status of any reassessments, if they exist, to 'Closed'.
`curam.assessmentplanning.delivery.facade.struct.CreateAssessmentResult`	`createAssessment(curam.assessmentplanning.delivery.facade.struct.CreateAssessmentDetails key)` Creates an assessment based on the passed in details.
`curam.assessmentplanning.delivery.facade.struct.CreateRolesResult`	`createRoles(curam.assessmentplanning.delivery.facade.struct.CreateRolesDetails dtls)` Creates an Assessment Case and roles for the selected clients and Assessment Definition.
`void`	`deleteAssessment(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)` Deletes the latest assessment instance, where the latest assessment instance is a reassessment, setting its status to 'Cancelled' and setting the assessment case status to 'complete'.
`curam.assessmentplanning.delivery.facade.struct.AssessmentCaseListDetailsList`	`listAssessmentDeliveries(curam.core.struct.CaseID key)` Returns a list of Assessment Deliveries for the given case.
`curam.assessmentplanning.delivery.facade.struct.AssessmentCaseListDetailsList`	`listAssessmentForCase(curam.core.struct.CaseHeaderKey key)` Returns a list of Assessment for the given case.
`curam.assessmentplanning.delivery.facade.struct.AssessmentCaseListDetailsList`	`listAssessmentForParticipant(curam.core.struct.ConcernRoleKey key)` Returns a list of all active Assessments that exist for the given participant.
`curam.assessmentplanning.delivery.facade.struct.AssessmentInstanceAndClientDetails`	`listAssessmentInstancesAndCaseClients(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)` Lists all assessment instances that exist for an assessment case and the clients residing on the assessment case.
`curam.assessmentplanning.delivery.facade.struct.AssessmentDefinitionListResult`	`listPotentialAssessmentDefinitionsForCase(curam.core.struct.CaseKey key)` Lists all Assessment Definitions that are linked to a specified case type.
`curam.assessmentplanning.delivery.facade.struct.AssessmentDefinitionListResult`	`listPotentialAssessmentDefinitionsForOutcomePlan(curam.core.struct.CaseKey key)` Lists all Assessment Definitions that are linked to the outcome plan.
`curam.assessmentplanning.delivery.facade.struct.AssessmentDefinitionListResult`	`listPotentialAssessmentDefinitionsForPlanReview(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key)` Lists all Assessment Definitions that are linked to the plan review.
`curam.assessmentplanning.delivery.facade.struct.AssessmentSummaryDetailsResult`	`readAssessmentSummaryDetails(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)` Reads details required for displaying a summary of the given Assessment Case identifier.
`curam.assessmentplanning.delivery.facade.struct.ClientAndRolesData`	`readClientAndRoleData(curam.assessmentplanning.delivery.facade.struct.ClientAndRolesDataKey key)` Reads the potential client and role details for the given case and Assessment Definition.
`curam.assessmentplanning.delivery.facade.struct.AssessmentCaseContextDetails`	`readContextDescription(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)` Retrieves the context description for the assessment case.
`curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanContextPanelDetails`	`readContextPanelDetails(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)` Reads the context panel details for the given `AssessmentCase`.
`curam.assessmentplanning.delivery.facade.struct.DeliveryHomeXmlResult`	`readFactorDetailsForGraph(curam.assessmentplanning.delivery.facade.struct.ReadFactorDetailsForGraphKey key)` Searches for all factor results related to the given assessmentCase and factor.
`curam.assessmentplanning.delivery.facade.struct.AssessmentGuidanceDetailsList`	`readGuidanceDetailsForLatestAssessmentInstance(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)` Returns guidance details for the latest assessment instance of the specified assessment case.
`curam.assessmentplanning.delivery.facade.struct.AssessmentCaseHomePageDetails`	`readHomePageDetails(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)` Reads the home page details for the given Assessment Case.
`curam.assessmentplanning.delivery.facade.struct.DeliveryHomeXmlResult`	`readOverviewAndPriorityXmlDetailsForAssessmentCase(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)` Reads overview and priority data for the graph.
`curam.assessmentplanning.delivery.facade.struct.DeliveryHomeXmlResult`	`readOverviewAndPriorityXmlDetailsForAssessmentInstance(curam.assessmentplanning.delivery.facade.struct.AssessmentInstanceKey key)` Reads overview and priority data for the graph.
`curam.assessmentplanning.delivery.facade.struct.AssessmentCaseOverviewPageDetails`	`readOverviewDetails(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)` Reads details required for displaying an overview for the given Assessment Case identifier.
`curam.assessmentplanning.delivery.facade.struct.AssessmentCaseSummaryDetails`	`readSummaryDetails(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey assessmentCaseKey)` Reads the summary details of the assessment case for display in the details panel on the assessment case tab.
`void`	`reject(curam.core.sl.struct.RejectionDetails rejectionDetails)` Rejects the assessment case.
`curam.assessmentplanning.delivery.facade.struct.ResolveRolesAndClientsResult`	`resolveRolesAndClients(curam.assessmentplanning.delivery.facade.struct.ResolveRolesAndClientsKey key)` Determines if the user is required to select roles.
`curam.assessmentplanning.delivery.facade.struct.AssessmentReportData`	`viewAssessmentReport(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)` Retrieves an report for the latest assessment of this assessment case.

Method Detail

createRoles

curam.assessmentplanning.delivery.facade.struct.CreateRolesResult createRoles(curam.assessmentplanning.delivery.facade.struct.CreateRolesDetails dtls)
                                                                       throws curam.util.exception.AppException,
                                                                              curam.util.exception.InformationalException

Creates an Assessment Case and roles for the selected clients and Assessment Definition.

Parameters:: dtls - The details of the Assessment Case and roles to create.
Returns:: The ID of the Assessment Case and Assessment Instance created
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createAssessment
```
curam.assessmentplanning.delivery.facade.struct.CreateAssessmentResult createAssessment(curam.assessmentplanning.delivery.facade.struct.CreateAssessmentDetails key)
                                                                                 throws curam.util.exception.AppException,
                                                                                        curam.util.exception.InformationalException
```
Creates an assessment based on the passed in details. Depending on the selected assessment either an assessment case or assessment delivery is created. If a assessment delivery is selected the client and start date must be entered. If a assessment case is selected client and start date details must not be entered.

Parameters:

key - The details for creating the Assessment.

Returns:

The caseID and type of the new Assessment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listAssessmentDeliveries

curam.assessmentplanning.delivery.facade.struct.AssessmentCaseListDetailsList listAssessmentDeliveries(curam.core.struct.CaseID key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Returns a list of Assessment Deliveries for the given case.

Parameters:: key - The ID of the case to search by
Returns:: A list of Assessment Deliveries for the given case
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readHomePageDetails

curam.assessmentplanning.delivery.facade.struct.AssessmentCaseHomePageDetails readHomePageDetails(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Reads the home page details for the given Assessment Case.

Parameters:: key - The ID of the Assessment Case to read
Returns:: The home page details for the given Assessment Case
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readClientAndRoleData

curam.assessmentplanning.delivery.facade.struct.ClientAndRolesData readClientAndRoleData(curam.assessmentplanning.delivery.facade.struct.ClientAndRolesDataKey key)
                                                                                  throws curam.util.exception.AppException,
                                                                                         curam.util.exception.InformationalException

Reads the potential client and role details for the given case and Assessment Definition.

Parameters:: key - The ID of the case and Assessment Definition to read by
Returns:: The potential clients and roles for the given case and Assessment Definition
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

resolveRolesAndClients

curam.assessmentplanning.delivery.facade.struct.ResolveRolesAndClientsResult resolveRolesAndClients(curam.assessmentplanning.delivery.facade.struct.ResolveRolesAndClientsKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Determines if the user is required to select roles. If not the select roles screen is not displayed. .

Parameters:: key - The assessmentCaseID
Returns:: An indicator indicating if role selection is required and the instanceID
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readFactorDetailsForGraph

curam.assessmentplanning.delivery.facade.struct.DeliveryHomeXmlResult readFactorDetailsForGraph(curam.assessmentplanning.delivery.facade.struct.ReadFactorDetailsForGraphKey key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Searches for all factor results related to the given assessmentCase and factor. Returns this data in xml format for use in the graph.

Parameters:: key - the assessmentCaseID, and the factorID to search on.
Returns:: the xml data containing relevant factor results related to the given assessmentCase and factor
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPotentialAssessmentDefinitionsForCase

curam.assessmentplanning.delivery.facade.struct.AssessmentDefinitionListResult listPotentialAssessmentDefinitionsForCase(curam.core.struct.CaseKey key)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Lists all Assessment Definitions that are linked to a specified case type. This method is intended to be used by users responsible for the management of Assessments.

Parameters:: key - The ID of a case, who's case type we wish to search by
Returns:: A list of all Assessment Definitions linked to the case
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

close
```
void close(curam.assessmentplanning.delivery.facade.struct.AssessmentCaseClosureDetails closureDetails,
           curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey assessmentCaseKey)
    throws curam.util.exception.AppException,
           curam.util.exception.InformationalException
```
Closes the overall assessment case, setting the status on the case header record to 'Closed' and setting the status of the corresponding initial assessment instance to 'Closed', and setting the status of any reassessments, if they exist, to 'Closed'.

Parameters:

closureDetails - The details regarding the closure of the assessment case.

assessmentCaseKey - The unique identifier of the assessment case to be closed. The closure date and closed by user fields are set as default and are not required to be set by the caller.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

deleteAssessment
```
void deleteAssessment(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)
               throws curam.util.exception.AppException,
                      curam.util.exception.InformationalException
```
Deletes the latest assessment instance, where the latest assessment instance is a reassessment, setting its status to 'Cancelled' and setting the assessment case status to 'complete'.

Parameters:

key - the unique identifier of the assessment case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readOverviewAndPriorityXmlDetailsForAssessmentInstance

curam.assessmentplanning.delivery.facade.struct.DeliveryHomeXmlResult readOverviewAndPriorityXmlDetailsForAssessmentInstance(curam.assessmentplanning.delivery.facade.struct.AssessmentInstanceKey key)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

Reads overview and priority data for the graph. This data consists of xml, and will include all factor results for all instances prior to, and including the given assessmentInstance, based on assessedDate.

Parameters:: key - the assessmentInstanceID.
Returns:: the xml data containing relevant factor results related to the given assessmentInstance and all prior assessmentInstances
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

approve

void approve(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)
      throws curam.util.exception.AppException,
             curam.util.exception.InformationalException

Approves the assessment case.

Parameters:: key - the unique identifier of the assessment case.
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readOverviewAndPriorityXmlDetailsForAssessmentCase

curam.assessmentplanning.delivery.facade.struct.DeliveryHomeXmlResult readOverviewAndPriorityXmlDetailsForAssessmentCase(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Reads overview and priority data for the graph. This data consists of xml, and will include all factor results for all instances related to the AssessmentCase.

Parameters:: key - the assessmentCaseID.
Returns:: the xml data containing relevant factor results related to all assessmentInstances related to the given AssessmentCase.
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

reject
```
void reject(curam.core.sl.struct.RejectionDetails rejectionDetails)
     throws curam.util.exception.AppException,
            curam.util.exception.InformationalException
```
Rejects the assessment case.

Parameters:

rejectionDetails - the details for the rejection, including a reason, comments and the unique case identifier for the assessment case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readContextDescription

curam.assessmentplanning.delivery.facade.struct.AssessmentCaseContextDetails readContextDescription(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Retrieves the context description for the assessment case.

Parameters:: key - the unique identifier of the assessment case
Returns:: the context description
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAssessmentInstancesAndCaseClients

curam.assessmentplanning.delivery.facade.struct.AssessmentInstanceAndClientDetails listAssessmentInstancesAndCaseClients(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Lists all assessment instances that exist for an assessment case and the clients residing on the assessment case.

Parameters:: key - the unique identifier of the assessment case
Returns:: list of all assessment instances that exist for the assessment case and the clients residing on the assessment.
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readSummaryDetails

curam.assessmentplanning.delivery.facade.struct.AssessmentCaseSummaryDetails readSummaryDetails(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey assessmentCaseKey)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Reads the summary details of the assessment case for display in the details panel on the assessment case tab.

Parameters:: assessmentCaseKey - The unique identifier of the assessment case to be read.
Returns:: The summary details for the assessment case
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewAssessmentReport
```
curam.assessmentplanning.delivery.facade.struct.AssessmentReportData viewAssessmentReport(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)
                                                                                   throws curam.util.exception.AppException,
                                                                                          curam.util.exception.InformationalException
```
Retrieves an report for the latest assessment of this assessment case. The report will include by details of the assessment, highlighting any priorities if applicable. The report will also include, if present, details relating to the guidance, notes, the answers provided for the assessment, and the progress of the individuals over multiple assessments. This method is intended to be used by users responsible for the management of Assessments.

Parameters:

key - The unique identifier of the assessment case the retrieved report for

Returns:

The report for the latest assessment of this assessment case

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listAssessmentForCase

curam.assessmentplanning.delivery.facade.struct.AssessmentCaseListDetailsList listAssessmentForCase(curam.core.struct.CaseHeaderKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Returns a list of Assessment for the given case.

Parameters:: key - The ID of the case to search by
Returns:: A list of Assessment for the given case
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readOverviewDetails

curam.assessmentplanning.delivery.facade.struct.AssessmentCaseOverviewPageDetails readOverviewDetails(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Reads details required for displaying an overview for the given Assessment Case identifier.

Parameters:: key - The ID of the Assessment Case to read the overview details of
Returns:: The overview details for the given Assessment Case
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readGuidanceDetailsForLatestAssessmentInstance

curam.assessmentplanning.delivery.facade.struct.AssessmentGuidanceDetailsList readGuidanceDetailsForLatestAssessmentInstance(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

Returns guidance details for the latest assessment instance of the specified assessment case.

Parameters:: key - the assessmentCaseID.
Returns:: the guidance details from the latest assessment instance.
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAssessmentForParticipant

curam.assessmentplanning.delivery.facade.struct.AssessmentCaseListDetailsList listAssessmentForParticipant(curam.core.struct.ConcernRoleKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Returns a list of all active Assessments that exist for the given participant.

Parameters:: key - The unique identifier of the participant on the system
Returns:: The list of Assessment for the given participant
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readContextPanelDetails

curam.outcomeplanning.outcomeplan.facade.struct.OutcomePlanContextPanelDetails readContextPanelDetails(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Reads the context panel details for the given AssessmentCase. This method is intended to be used by users responsible for the management of assessments.

Parameters:: key - The unique identifier of the assessment case
Returns:: The context panel details for the assessment
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readAssessmentSummaryDetails

curam.assessmentplanning.delivery.facade.struct.AssessmentSummaryDetailsResult readAssessmentSummaryDetails(curam.assessmentplanning.delivery.entity.struct.AssessmentCaseKey key)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Reads details required for displaying a summary of the given Assessment Case identifier.

Parameters:: key - The ID of the Assessment Case to read the overview details of
Returns:: The summary details for the given Assessment Case
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPotentialAssessmentDefinitionsForPlanReview

curam.assessmentplanning.delivery.facade.struct.AssessmentDefinitionListResult listPotentialAssessmentDefinitionsForPlanReview(curam.outcomeplanning.outcomeplan.entity.struct.PlanReviewKey key)
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

Lists all Assessment Definitions that are linked to the plan review. This method is intended to be used by users responsible for the management of Assessments.

Parameters:: key - The ID of the plan review
Returns:: A list of all Assessment Definitions linked to the case.
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException
Since:: 6.0 SP2

listPotentialAssessmentDefinitionsForOutcomePlan

curam.assessmentplanning.delivery.facade.struct.AssessmentDefinitionListResult listPotentialAssessmentDefinitionsForOutcomePlan(curam.core.struct.CaseKey key)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

Lists all Assessment Definitions that are linked to the outcome plan. This method is intended to be used by users responsible for the management of Assessments.

Parameters:: key - The ID of a case, who's case type we wish to search by
Returns:: A list of all Assessment Definitions linked to the case
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException
Since:: 6.0 SP2

Interface AssessmentCase