curam.piwrapper.outcomeplan.impl

Class OutcomePlanActivity.OutcomePlanActivityEvents

java.lang.Object

curam.piwrapper.outcomeplan.impl.OutcomePlanActivity.OutcomePlanActivityEvents

Enclosing interface:

OutcomePlanActivity

@AccessLevel(value=EXTERNAL)
 @Implementable
public abstract static class OutcomePlanActivity.OutcomePlanActivityEvents
extends java.lang.Object

Business events for the OutcomePlanActivity processing that allows customers to add additional processing at various points in the life cycle of an outcome plan activity.

Since:

6.0

Constructor Summary

Constructors

Constructor and Description
OutcomePlanActivityEvents()

Method Summary

Modifier and Type	Method and Description
void	addProgressSendNotificationToCollaborationMembersAndOwner(Progressable progressable) Event raised to allow listeners to send a notification to the activity owner and all external collaboration members that are configured for sharing with the activity when progress is added to it.
void	postAddNoteSendNotificationToCollaborationMembersAndOwner(OutcomePlanActivity outcomePlanActivity) Event raised to allow listeners to send a notification to the activity owner and all external collaboration members that are configured for sharing with the activity when a note is added to it.
void	postInsert(OutcomePlanActivity outcomePlanActivity) Invoked after OutcomePlanActivity#insert() .
void	postModify(OutcomePlanActivity outcomePlanActivity) Invoked after OutcomePlanActivity#modify(int).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutcomePlanActivityEvents

public OutcomePlanActivityEvents()

Method Detail

postInsert

public void postInsert(OutcomePlanActivity outcomePlanActivity)
                throws curam.util.exception.InformationalException

Invoked after OutcomePlanActivity#insert() .

Parameters:

outcomePlanActivity - The outcome plan expected outcome entity instance.

Throws:

curam.util.exception.InformationalException - Generic Application Exception

postModify

public void postModify(OutcomePlanActivity outcomePlanActivity)
                throws curam.util.exception.InformationalException

Invoked after OutcomePlanActivity#modify(int).

Parameters:

outcomePlanActivity - The outcome plan expected outcome entity instance.

Throws:

curam.util.exception.InformationalException - Generic Exception Signature

postAddNoteSendNotificationToCollaborationMembersAndOwner

public void postAddNoteSendNotificationToCollaborationMembersAndOwner(OutcomePlanActivity outcomePlanActivity)
                                                               throws curam.util.exception.AppException,
                                                                      curam.util.exception.InformationalException

Event raised to allow listeners to send a notification to the activity owner and all external collaboration members that are configured for sharing with the activity when a note is added to it.

The intention of this method is it to be used after a note has been added to a outcome plan activity that has collaboration members configured for sharing on it.

If the user who added the note is the one of the collaboration members configured for sharing on the passed in outcome plan activity they are not sent a notification. If the user who added the note is an internal user they are not sent a notification.

Parameters:

outcomePlanActivity - the outcome plan activity that this event is raised on.

Throws:

curam.util.exception.InformationalException - Generic Application Exception.

curam.util.exception.AppException - Generic Application Exception.

addProgressSendNotificationToCollaborationMembersAndOwner

public void addProgressSendNotificationToCollaborationMembersAndOwner(Progressable progressable)
                                                               throws curam.util.exception.AppException,
                                                                      curam.util.exception.InformationalException

Event raised to allow listeners to send a notification to the activity owner and all external collaboration members that are configured for sharing with the activity when progress is added to it.

The intention of this method is it to be used when progress is created for a outcome plan activity that has collaboration members configured for sharing on it.

If the user who added the progress is the one of the collaboration members configured for sharing on the passed in outcome plan activity they are not sent a notification. If the user who added the progress is an internal user they are not sent a notification.

Parameters:

progressable - The Progressable instance that this event is raised in relation to.

Throws:

curam.util.exception.InformationalException - Generic Application Exception.

curam.util.exception.AppException - Generic Application Exception.