ManageGuidedChangeNextStep (core)

All Known Implementing Classes:

ManageGuidedChangeNextStep, curam.guidedchanges.facade.impl.ManageGuidedChangeNextStep, ManageGuidedChangeNextStepFactory
```
@AccessLevel(value=EXTERNAL)
public interface ManageGuidedChangeNextStep
```
This business interface provides operations that allow for the management of the Guided Change of Circumstance process.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`curam.guidedchanges.facade.struct.GuidedChangeInfoList`	`hasSubmittedGuidedChange(curam.core.struct.CaseKey caseKey)` Lists all of the submitted Guided Change of Circumstances for a case.
`curam.guidedchanges.struct.ChangeTypeDtlsList`	`listActiveChange(curam.guidedchanges.struct.GuidedChangeCOCKey key)` Lists all of the open change types for a specific Guided Change of Circumstance.
`curam.guidedchanges.struct.ChangeTypeDtlsList`	`listAddedChange(curam.guidedchanges.struct.GuidedChangeCOCKey key)` Lists all of the added change types for a specific Guided Change of Circumstance.
`curam.guidedchanges.struct.ChangeTypeDtlsList`	`listAllChange(curam.guidedchanges.struct.GuidedChangeCOCKey key)` Lists all of the change types for a specific Guided Change of Circumstance.
`curam.guidedchanges.struct.GuidedChangeCOCNextStepDtlsList`	`listCompletedGuidedChangeCOC(curam.core.struct.CaseKey caseKey)` Lists all of the completed Guided Change of Circumstances for a case.
`curam.guidedchanges.struct.GuidedChangeCOCNextStepDtlsList`	`listSubmittedGuidedChangeCOC(curam.core.struct.CaseKey caseKey)` Lists all of the submitted Guided Change of Circumstances for a case.
`void`	`markGuidedChangeCOCComplete(curam.guidedchanges.struct.GuidedChangeCOCKey key)` Marks a specific Guided Change of Circumstances as completed.

Method Detail

listSubmittedGuidedChangeCOC

@AccessLevel(value=EXTERNAL)
curam.guidedchanges.struct.GuidedChangeCOCNextStepDtlsList listSubmittedGuidedChangeCOC(curam.core.struct.CaseKey caseKey)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Lists all of the submitted Guided Change of Circumstances for a case.

Parameters:: key - The unique identifier of the case.
Returns:: The list of submitted Guided Change of Circumstances.
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listCompletedGuidedChangeCOC

@AccessLevel(value=EXTERNAL)
curam.guidedchanges.struct.GuidedChangeCOCNextStepDtlsList listCompletedGuidedChangeCOC(curam.core.struct.CaseKey caseKey)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Lists all of the completed Guided Change of Circumstances for a case.

Parameters:: key - The unique identifier of the case.
Returns:: The list of completed Guided Change of Circumstances.
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listActiveChange

@AccessLevel(value=EXTERNAL)
curam.guidedchanges.struct.ChangeTypeDtlsList listActiveChange(curam.guidedchanges.struct.GuidedChangeCOCKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Lists all of the open change types for a specific Guided Change of Circumstance. A change type is an action that a caseworker must perform as part of a Guided Change of Circumstance.

Parameters:: key - The unique identifier of the Guided Change of Circumstance.
Returns:: The list of open change types.
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAddedChange
```
@AccessLevel(value=EXTERNAL)
curam.guidedchanges.struct.ChangeTypeDtlsList listAddedChange(curam.guidedchanges.struct.GuidedChangeCOCKey key)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException
```
Lists all of the added change types for a specific Guided Change of Circumstance. An added change type is an action that a caseworker has already performed as part of a Guided Change of Circumstance.

Parameters:

key - The unique identifier of the Guided Change of Circumstance.

Returns:

The list of added change types.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

markGuidedChangeCOCComplete
```
@AccessLevel(value=EXTERNAL)
void markGuidedChangeCOCComplete(curam.guidedchanges.struct.GuidedChangeCOCKey key)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException
```
Marks a specific Guided Change of Circumstances as completed. This also tidies up any related Guided Change of Circumstance Actions.

Parameters:

key - The unique identifier of the Guided Change of Circumstances.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listAllChange

@AccessLevel(value=EXTERNAL)
curam.guidedchanges.struct.ChangeTypeDtlsList listAllChange(curam.guidedchanges.struct.GuidedChangeCOCKey key)
                                                                                  throws curam.util.exception.AppException,
                                                                                         curam.util.exception.InformationalException

Lists all of the change types for a specific Guided Change of Circumstance. A change type is an action that a caseworker must perform as part of a Guided Change of Circumstance.

Parameters:: key - The unique identifier of the Guided Change of Circumstance.
Returns:: The list of change types.
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

hasSubmittedGuidedChange

@AccessLevel(value=EXTERNAL)
curam.guidedchanges.facade.struct.GuidedChangeInfoList hasSubmittedGuidedChange(curam.core.struct.CaseKey caseKey)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException