curam.cpm.facade.intf

Interface MaintainIncidentRestraint

All Known Implementing Classes:

MaintainIncidentRestraint, curam.cpm.facade.impl.MaintainIncidentRestraint, MaintainIncidentRestraintFactory

@AccessLevel(value=EXTERNAL)
public interface MaintainIncidentRestraint

This business interface is used for managing restraint functionality for a provider incident. A restraint can be imposed on incident participants as a measure to control the incident. It is imposed by a provider member for a defined time period, and could be physical, mechanical or chemical in nature.

Method Summary

Modifier and Type	Method and Description
curam.cpm.facade.struct.IncidentRestraintKey	createIncidentRestraint(curam.cpm.facade.struct.IncidentRestraintDetails details) Creates a restraint for an incident.
void	deleteIncidentRestraint(curam.cpm.facade.struct.IncidentRestraintKeyVersionDetails keyVersionDetails) Cancels an incident restraint.
curam.cpm.facade.struct.ByWhomParticipantDetailsList	listByWhomParticipants(curam.cpm.facade.struct.IncidentRestraintKey key) Returns the list of the active participants and provider members for an incident.
curam.cpm.facade.struct.IncidentRestraintDetailsList	listIncidentRestraint(curam.cpm.facade.struct.IncidentRestraintKey key) Returns the list of restraints for a specified incident.
void	maintainIncidentRestraint(curam.cpm.facade.struct.IncidentRestraintDetails details) Modifies an incident restraint.
void	modifyIncidentRestraint(curam.cpm.facade.struct.IncidentRestraintDetails details) Modifies an incident restraint.
curam.cpm.facade.struct.IncidentRestraintDetails	viewIncidentRestraint(curam.cpm.facade.struct.IncidentRestraintKey key) Retrieves the incident restraint details, On Whom participant name and By Whom participant name.

Method Detail

createIncidentRestraint

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.IncidentRestraintKey createIncidentRestraint(curam.cpm.facade.struct.IncidentRestraintDetails details)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Creates a restraint for an incident.

Parameters:

details - The details of the incident restraint.

Returns:

The key of the newly created incident restraint.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

IncidentRestraint

deleteIncidentRestraint

@AccessLevel(value=EXTERNAL)
void deleteIncidentRestraint(curam.cpm.facade.struct.IncidentRestraintKeyVersionDetails keyVersionDetails)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Cancels an incident restraint.

Parameters:

keyVersionDetails - The key of incident restraint and the version number.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

IncidentRestraint

listIncidentRestraint

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.IncidentRestraintDetailsList listIncidentRestraint(curam.cpm.facade.struct.IncidentRestraintKey key)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Returns the list of restraints for a specified incident.

Parameters:

Key - The key of the incident.

Returns:

The list of incident restraints.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

IncidentRestraint, IncidentParticipant

modifyIncidentRestraint

@AccessLevel(value=EXTERNAL)
void modifyIncidentRestraint(curam.cpm.facade.struct.IncidentRestraintDetails details)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Modifies an incident restraint.

Parameters:

details - The details of the incident restraint.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

IncidentRestraint

viewIncidentRestraint

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.IncidentRestraintDetails viewIncidentRestraint(curam.cpm.facade.struct.IncidentRestraintKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Retrieves the incident restraint details, On Whom participant name and By Whom participant name. A By Whom participant can be a provider member associated with the provider or an incident participant. An On Whom participant is an incident participant.

Parameters:

key - The key of the incident restraint.

Returns:

The details of the incident restraint.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

IncidentRestraint, IncidentParticipant

maintainIncidentRestraint

@AccessLevel(value=EXTERNAL)
void maintainIncidentRestraint(curam.cpm.facade.struct.IncidentRestraintDetails details)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Modifies an incident restraint. This method is used when the On whom and By whom fields are not specified.

Parameters:

details - The details of the incident restraint.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

IncidentRestraint

listByWhomParticipants

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ByWhomParticipantDetailsList listByWhomParticipants(curam.cpm.facade.struct.IncidentRestraintKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Returns the list of the active participants and provider members for an incident. 'By Whom' participants can be provider members associated with the provider or incident participants. If a provider member is already an incident participant, then he/she will be listed in their role as a 'Participant' and not in their role as a 'Provider member'.

Parameters:

Key - The key of the provider whose members are to be read for a particular incident.

Returns:

The list of By Whom participants.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Incident, ProviderMember