oracle.apps.fnd.wf.engine
Interface Notification

public interface Notification

This interface should be implemented by entities which will be used for managing notification with Oracle Workflow.

See Also:

NotificationImpl

Field Summary

static java.lang.String	RCS_ID
static boolean	RCS_ID_RECORDED

Method Summary

boolean	cancel(java.lang.String comment) Cancel an existing notification with comments.
boolean	close(java.lang.String role) Close an existing notification by a given role.
boolean	forward(java.lang.String role, java.lang.String comment) Delegate an existing notification to a given role with comments.
java.lang.String	getNotificationId() Obtain the notificaction id from the existing notification.
boolean	respond(java.lang.String role, java.lang.String comment) Responding to an existing notification by a given role with comments.
boolean	transfer(java.lang.String role, java.lang.String comment) Transfer an existing notification to a given role with comments.

Field Detail

RCS_ID

public static final java.lang.String RCS_ID

RCS_ID_RECORDED

public static final boolean RCS_ID_RECORDED

Method Detail

forward

public boolean forward(java.lang.String role,
                       java.lang.String comment)
                throws WorkflowException

Delegate an existing notification to a given role with comments.

Parameters:

role - to which the notificaiton is forwarded.

comments - valid for this forward.

Returns:

True for succeed.

Throws:

WorkflowException - when fails on abnormal condition.

transfer

public boolean transfer(java.lang.String role,
                        java.lang.String comment)
                 throws WorkflowException

Transfer an existing notification to a given role with comments.

Parameters:

role - to which the notificaiton is transfered.

comments - valid for this forward.

Returns:

True for succeed.

Throws:

WorkflowException - when fails on abnormal condition

cancel

public boolean cancel(java.lang.String comment)
               throws WorkflowException

Cancel an existing notification with comments.

Parameters:

comments - valid for this cancelation.

Returns:

True for succeed.

Throws:

WorkflowException - when fails on abnormal condition

respond

public boolean respond(java.lang.String role,
                       java.lang.String comment)
                throws WorkflowException

Responding to an existing notification by a given role with comments.

Parameters:

role - who is responding to this notificaiton.

comments - valid for this responding.

Returns:

True for succeed.

Throws:

WorkflowException - when fails on abnormal condition

close

public boolean close(java.lang.String role)
              throws WorkflowException

Close an existing notification by a given role.

Parameters:

role - who is closing this notificaiton.

Returns:

True for succeed.

Throws:

WorkflowException - when fails on abnormal condition.

getNotificationId

public java.lang.String getNotificationId()
                                   throws WorkflowException

Obtain the notificaction id from the existing notification.

Returns:

notification id

Throws:

WorkflowException - when fails on abnormal condition.