curam.legalaction.facade.intf

Interface LegalAction

All Known Implementing Classes:

LegalAction, curam.legalaction.facade.impl.LegalAction, LegalActionFactory

@AccessLevel(value=EXTERNAL)
public interface LegalAction

This is the business interface for maintaining legal action functionality associated with a parent case (i.e. integrated case, screening case or product delivery case). A legal action is a type of case that defines legal processes associated with a case participant involved with the organization that may include judicial involvement.

Method Summary

Modifier and Type	Method and Description
curam.core.struct.InformationalMsgDtlsList	addStatement(curam.legalaction.facade.struct.LegalActionStatementDetails details) Adds a statement to a legal action case.
void	associateLegalAction(curam.legalaction.facade.struct.AssociatedCaseDetails dtls) Creates an association between multiple legal actions.
void	cancelLegalAction(curam.legalaction.facade.struct.LegalActionKey key) Cancels the legal action created for a case participant and removes the relationship with any associated legal actions.
void	closeCase(curam.core.facade.struct.ICClosureDetails details) Closes the legal action case and updates case status.
curam.legalaction.facade.struct.ParentAndLegalCaseKey	createLegalAction(curam.legalaction.facade.struct.LegalActionDetails dtls) Creates a new legal action for case participants of the associated parent case.
void	disassociateLegalAction(curam.core.struct.CaseIDRelatedCaseID key) Disassociates a legal action case from another legal action case.
curam.legalaction.admin.facade.struct.AdminLegalActionDetails	getLegalActionHomePageDetails(curam.legalaction.facade.struct.CaseIDAndConfigLegalID caseIDAndConfigLegalID) Retrieves the legal action home page details.
curam.legalaction.facade.struct.ExternalPartyMemberList	listExternalPartyMembers() Returns list of external party office members.
curam.legalaction.facade.struct.ViewLegalActionParticipantList	listLegalActionCaseParticipantsDetails(curam.core.struct.CaseID key) Returns a list of legal participants associated with a legal action.
curam.legalaction.facade.struct.LegalActionsByCaseDtlsList	listLegalActionsByCaseID(curam.core.struct.CaseID key) Returns a list of legal actions associated to a parent case.
curam.legalaction.facade.struct.LegalActionsByCaseDtlsList	listLegalActionsForAssociation(curam.legalaction.facade.struct.CaseIDAndConfigLegalID key) Returns list of legal actions that are not already associated with another legal action.
curam.legalaction.facade.struct.LegalActionCaseParticipantList	listLegalActionsForCaseParticipant(curam.core.sl.struct.CaseParticipantRoleKey key) Returns list of all the legal actions for a case participant.
curam.legalaction.facade.struct.LegalActionsByCaseDtlsList	listLegalActionsForPopup(curam.core.struct.CaseID key) Returns a list of legal actions and legal participants associated with a parent case.
curam.legalaction.facade.struct.ParticipantAndLegalCategoryDetails	listParticipantsAndLegalCategory(curam.core.struct.CaseID key) Returns a list of case participants and all legal categories configured in the system.
curam.legalaction.facade.struct.ParticipantAndLegalCategoryDetails	listParticipantsLegalActionCategory(curam.legalaction.facade.struct.CaseIDAndConfigLegalID key) Returns a list of case participants of the associated parent case and all legal categories configured in the system.
void	modifyLegalAction(curam.legalaction.facade.struct.LegalActionDetails dtls) Modifies the legal action details.
void	modifyParticipantDetails(curam.legalaction.facade.struct.ParticipantMultiselectDetails dtls) Modifies the participant associated with legal action case.
void	modifyParticipantLegalStatus(curam.legalaction.facade.struct.ParticipantStatusDetails dtls) Modifies the legal status of a legal action participant.
curam.legalaction.facade.struct.LegalActionViewDetails	readByLegalActionCaseID(curam.core.struct.CaseID key) Reads the legal action details.
curam.core.struct.CaseID	readCaseIDByLegalActionCaseID(curam.core.struct.CaseID caseID) Retrieves the parent case ID from the legal action case ID.
curam.legalaction.facade.struct.HomePageName	readHomePageByCaseID(curam.core.struct.CaseID key) Returns home page name of a legal action.
curam.legalaction.facade.struct.ParticipantMultiselectViewDetails	readParticipantDetails(curam.core.struct.CaseID key) Returns a list of case participants of the associated parent case of a legal action.
curam.legalaction.facade.struct.ParticipantStatusViewDetails	readParticipantStatus(curam.legalaction.facade.struct.LegalActionIDAndCaseParticipantRoleKey key) Reads the legal status of a legal action participant.
curam.legalaction.facade.struct.ParticipantDetailsAndStatusList	readParticipantToModifyStatus(curam.legalaction.facade.struct.LegalActionIDAndCaseParticipantRoleKey key) Reads details of legal action participant to modify their status.
curam.legalaction.facade.struct.ExternalOfficeLocationSearchResult	searchExternalOfficeLocation(curam.core.facade.struct.ExternalPartyOfficeSearchKey key) Returns the list of external party offices.

Method Detail

createLegalAction

@AccessLevel(value=EXTERNAL)
curam.legalaction.facade.struct.ParentAndLegalCaseKey createLegalAction(curam.legalaction.facade.struct.LegalActionDetails dtls)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Creates a new legal action for case participants of the associated parent case.

Parameters:

dtls - Details of the legal action.

Returns:

Legal action case id and its parent.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

LegalAction

listLegalActionsByCaseID

@AccessLevel(value=EXTERNAL)
curam.legalaction.facade.struct.LegalActionsByCaseDtlsList listLegalActionsByCaseID(curam.core.struct.CaseID key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Returns a list of legal actions associated to a parent case.

Parameters:

key - Identifies case.

Returns:

List of legal actions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

LegalAction

listParticipantsAndLegalCategory

@AccessLevel(value=EXTERNAL)
curam.legalaction.facade.struct.ParticipantAndLegalCategoryDetails listParticipantsAndLegalCategory(curam.core.struct.CaseID key)
                                                                                                                          throws curam.util.exception.AppException,
                                                                                                                                 curam.util.exception.InformationalException

Returns a list of case participants and all legal categories configured in the system.

Parameters:

key - Identifies case.

Returns:

List of case participants and all legal categories configured in the system.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipantRole, LegalAction

listParticipantsLegalActionCategory

@AccessLevel(value=EXTERNAL)
curam.legalaction.facade.struct.ParticipantAndLegalCategoryDetails listParticipantsLegalActionCategory(curam.legalaction.facade.struct.CaseIDAndConfigLegalID key)
                                                                                                                             throws curam.util.exception.AppException,
                                                                                                                                    curam.util.exception.InformationalException

Returns a list of case participants of the associated parent case and all legal categories configured in the system.

Parameters:

key - Identifies case.

Returns:

List of case participants and all legal categories.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

LegalAction, CaseParticipantRole

readByLegalActionCaseID

@AccessLevel(value=EXTERNAL)
curam.legalaction.facade.struct.LegalActionViewDetails readByLegalActionCaseID(curam.core.struct.CaseID key)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Reads the legal action details.

Parameters:

key - Identifies a legal action.

Returns:

Details of the legal action.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

LegalAction

modifyLegalAction

@AccessLevel(value=EXTERNAL)
void modifyLegalAction(curam.legalaction.facade.struct.LegalActionDetails dtls)
                                             throws curam.util.exception.AppException,
                                                    curam.util.exception.InformationalException

Modifies the legal action details.

Parameters:

dtls - Details of the legal action.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

LegalAction

cancelLegalAction

@AccessLevel(value=EXTERNAL)
void cancelLegalAction(curam.legalaction.facade.struct.LegalActionKey key)
                                             throws curam.util.exception.AppException,
                                                    curam.util.exception.InformationalException

Cancels the legal action created for a case participant and removes the relationship with any associated legal actions.

Parameters:

key - Identifies a legal action.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

LegalAction

readParticipantToModifyStatus

@AccessLevel(value=EXTERNAL)
curam.legalaction.facade.struct.ParticipantDetailsAndStatusList readParticipantToModifyStatus(curam.legalaction.facade.struct.LegalActionIDAndCaseParticipantRoleKey key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Reads details of legal action participant to modify their status.

Parameters:

key - Identifies a legal action and a legal participant.

Returns:

Details of the legal participant.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipantRole

modifyParticipantLegalStatus

@AccessLevel(value=EXTERNAL)
void modifyParticipantLegalStatus(curam.legalaction.facade.struct.ParticipantStatusDetails dtls)
                                                        throws curam.util.exception.AppException,
                                                               curam.util.exception.InformationalException

Modifies the legal status of a legal action participant.

Parameters:

dtls - Details of the legal status.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readParticipantStatus

@AccessLevel(value=EXTERNAL)
curam.legalaction.facade.struct.ParticipantStatusViewDetails readParticipantStatus(curam.legalaction.facade.struct.LegalActionIDAndCaseParticipantRoleKey key)
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

Reads the legal status of a legal action participant.

Parameters:

key - Identifies a legal participant.

Returns:

Details of the legal status.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

LegalStatus

addStatement

@AccessLevel(value=EXTERNAL)
curam.core.struct.InformationalMsgDtlsList addStatement(curam.legalaction.facade.struct.LegalActionStatementDetails details)
                                                                              throws curam.util.exception.AppException,
                                                                                     curam.util.exception.InformationalException

Adds a statement to a legal action case.

Parameters:

dtls - Details of the legal action statement.

Returns:

Informational messages (If any).

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Attachment

readParticipantDetails

@AccessLevel(value=EXTERNAL)
curam.legalaction.facade.struct.ParticipantMultiselectViewDetails readParticipantDetails(curam.core.struct.CaseID key)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Returns a list of case participants of the associated parent case of a legal action.

Parameters:

key - Identifies legal action case.

Returns:

details of legal participants.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipantRole

modifyParticipantDetails

@AccessLevel(value=EXTERNAL)
void modifyParticipantDetails(curam.legalaction.facade.struct.ParticipantMultiselectDetails dtls)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

Modifies the participant associated with legal action case.

Parameters:

dtls - Details of the legal participants selected.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

LegalAction

listLegalActionsForPopup

@AccessLevel(value=EXTERNAL)
curam.legalaction.facade.struct.LegalActionsByCaseDtlsList listLegalActionsForPopup(curam.core.struct.CaseID key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Returns a list of legal actions and legal participants associated with a parent case.

Parameters:

key - Identifies case.

Returns:

List of legal actions and legal participants.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

LegalAction

listLegalActionCaseParticipantsDetails

@AccessLevel(value=EXTERNAL)
curam.legalaction.facade.struct.ViewLegalActionParticipantList listLegalActionCaseParticipantsDetails(curam.core.struct.CaseID key)
                                                                                                                            throws curam.util.exception.AppException,
                                                                                                                                   curam.util.exception.InformationalException

Returns a list of legal participants associated with a legal action.

Parameters:

key - Identifies legal action case.

Returns:

List of legal participants.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

LegalAction

readHomePageByCaseID

@AccessLevel(value=EXTERNAL)
curam.legalaction.facade.struct.HomePageName readHomePageByCaseID(curam.core.struct.CaseID key)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Returns home page name of a legal action.

Parameters:

key - Identifies legal action case.

Returns:

Home page name of legal action.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

LegalAction

listLegalActionsForAssociation

@AccessLevel(value=EXTERNAL)
curam.legalaction.facade.struct.LegalActionsByCaseDtlsList listLegalActionsForAssociation(curam.legalaction.facade.struct.CaseIDAndConfigLegalID key)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Returns list of legal actions that are not already associated with another legal action.

Parameters:

key - contains legal action case id and config legal action id.

Returns:

List of legal actions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

LegalAction

associateLegalAction

@AccessLevel(value=EXTERNAL)
void associateLegalAction(curam.legalaction.facade.struct.AssociatedCaseDetails dtls)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException

Creates an association between multiple legal actions.

Parameters:

dtls - contains case ids of legal action cases.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CaseRelationship

listLegalActionsForCaseParticipant

@AccessLevel(value=EXTERNAL)
curam.legalaction.facade.struct.LegalActionCaseParticipantList listLegalActionsForCaseParticipant(curam.core.sl.struct.CaseParticipantRoleKey key)
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

Returns list of all the legal actions for a case participant.

Parameters:

key - CaseParticipantRoleKey of the case member.

Returns:

List of legal actions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

LegalAction

searchExternalOfficeLocation

@AccessLevel(value=EXTERNAL)
curam.legalaction.facade.struct.ExternalOfficeLocationSearchResult searchExternalOfficeLocation(curam.core.facade.struct.ExternalPartyOfficeSearchKey key)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

Returns the list of external party offices.

Parameters:

key - The external party office information.

Returns:

List of external office location summary details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ExternalPartyOffice

closeCase

@AccessLevel(value=EXTERNAL)
void closeCase(curam.core.facade.struct.ICClosureDetails details)
                                     throws curam.util.exception.AppException,
                                            curam.util.exception.InformationalException

Closes the legal action case and updates case status.

Parameters:

details - The details of the legal action

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

LegalAction

listExternalPartyMembers

@AccessLevel(value=EXTERNAL)
curam.legalaction.facade.struct.ExternalPartyMemberList listExternalPartyMembers()
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Returns list of external party office members.

Returns:

list of external party office members.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

disassociateLegalAction

@AccessLevel(value=EXTERNAL)
void disassociateLegalAction(curam.core.struct.CaseIDRelatedCaseID key)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Disassociates a legal action case from another legal action case.

Parameters:

dtls - Contains case ID and associated case ID of a legal action case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CaseRelationship

readCaseIDByLegalActionCaseID

@AccessLevel(value=EXTERNAL)
curam.core.struct.CaseID readCaseIDByLegalActionCaseID(curam.core.struct.CaseID caseID)
                                                                             throws curam.util.exception.AppException,
                                                                                    curam.util.exception.InformationalException

Retrieves the parent case ID from the legal action case ID.

Parameters:

caseID - Contains the legal action case ID.

Returns:

parent case ID for the legal action case ID.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseRelationship

getLegalActionHomePageDetails

@AccessLevel(value=EXTERNAL)
curam.legalaction.admin.facade.struct.AdminLegalActionDetails getLegalActionHomePageDetails(curam.legalaction.facade.struct.CaseIDAndConfigLegalID caseIDAndConfigLegalID)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Retrieves the legal action home page details.

Parameters:

caseIDAndConfigLegalID - Contains the legal action details

Returns:

The legal action details

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

LegalAction