com.altair.hwm.beans.utils.events
Class HWMWorkflowEvent

java.lang.Object
  java.util.EventObject
      com.altair.hwm.beans.utils.events.HWMWorkflowEvent

All Implemented Interfaces:

java.io.Serializable

public class HWMWorkflowEvent
extends java.util.EventObject

Title: HWMWorkflowEvent

Description: The workflow event object

Company: Altair Engineering, Inc.

See Also:

Serialized Form

Field Summary

static int	WORKFLOW_TASK_CHANGED The type of workflow event
static int	WORKFLOW_TASKPLAYOPTION_CHANGED
static int	WORKFLOW_TASKSTATE_CHANGED

Constructor Summary

HWMWorkflowEvent(IHWMWorkflow iWorkflow, java.lang.Object objSrc, int nEvent, java.lang.String strTaskName, int nTaskState, int nPlayOption)
Constructor

Method Summary

int	GetEventType() Return the event type
java.lang.String	GetTaskName() Return the task name The current task name if event = WORKFLOW_TASK_CHANGED or the name of the task whose state/play option has been changed if event = WORKFLOW_TASKSTATE_CHANGED or WORKFLOW_TASKPLAYOPTION_CHANGED
int	GetTaskPlayOption() Return the task's play option
int	GetTaskState() Return the task state
IHWMWorkflow	GetWorkflowModel() Get the workflow interface

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

WORKFLOW_TASK_CHANGED

public static int WORKFLOW_TASK_CHANGED

The type of workflow event

WORKFLOW_TASKSTATE_CHANGED

public static int WORKFLOW_TASKSTATE_CHANGED

WORKFLOW_TASKPLAYOPTION_CHANGED

public static int WORKFLOW_TASKPLAYOPTION_CHANGED

Constructor Detail

HWMWorkflowEvent

public HWMWorkflowEvent(IHWMWorkflow iWorkflow,
                        java.lang.Object objSrc,
                        int nEvent,
                        java.lang.String strTaskName,
                        int nTaskState,
                        int nPlayOption)

Constructor

Parameters:

iWorkflow - The workflow interface

objSrc - The source of the event

nEvent - One of the WORKFLOW_TASKXXX_CHANGED event

strTaskName - The task name

nTaskState - The task state

nPlayOption - The task's play option

Method Detail

GetEventType

public int GetEventType()

Return the event type

Returns:

int The type of event

GetTaskName

public java.lang.String GetTaskName()

Return the task name The current task name if event = WORKFLOW_TASK_CHANGED or the name of the task whose state/play option has been changed if event = WORKFLOW_TASKSTATE_CHANGED or WORKFLOW_TASKPLAYOPTION_CHANGED

Returns:

String The name of the task

GetTaskState

public int GetTaskState()

Return the task state

Returns:

int The task state

GetTaskPlayOption

public int GetTaskPlayOption()

Return the task's play option

Returns:

int The task's play otpion

GetWorkflowModel

public IHWMWorkflow GetWorkflowModel()

Get the workflow interface

Returns:

IHWMWorkflow The workflow interface