flux.bpm
Interface BusinessProcessElement

All Superinterfaces:

java.io.Serializable

public interface BusinessProcessElement

extends java.io.Serializable

Contains information on a found business process.

Author:

Copyright 2000-2008 Flux Corporation. All rights reserved.

Method Summary

java.lang.String	getBusinessProcessTriggerName() Returns the name of the business process trigger that was found.
java.lang.String	getClaimer() Returns the claimer, if any, on the business process trigger that was found.
java.util.Date	getDeadline() Returns the deadline for this business process.
java.lang.String	getFlowChartName() Returns the name of the business process that was found.
java.util.SortedSet	getOwners() Returns the business process owners, if any, of the business process that was found.
java.lang.String	getTemplateName() Returns the template name, if any, of the business process that was found.
boolean	isDeadlineExceeded() Returns whether the business process, or flow chart run, exceeded its deadline.
boolean	isPossibleWork() Indicates whether the currently logged in user is allowed to work the business process trigger that was found.
boolean	isRequiredWork() Indicates whether the currently logged in user is required to work the business process trigger that was found.
boolean	isWithinDeadlineWindow() Returns whether the business process is within its deadline window.

Method Detail

getBusinessProcessTriggerName

public java.lang.String getBusinessProcessTriggerName()

Returns the name of the business process trigger that was found.

Returns:

The name of the business process trigger that was found.

getClaimer

public java.lang.String getClaimer()

Returns the claimer, if any, on the business process trigger that was found.

Returns:

The claimer, if any, on the business process trigger that was found.

getDeadline

public java.util.Date getDeadline()

Returns the deadline for this business process.

The deadline specifies when this business process should finish execution. A DeadlineExceededEvent is published to the audit trail if this business process does not complete execution by the deadline.

The display of business processes in the Flux BPM Dashboard indicates the deadline status of business processes by highlighting business process in relavent colors.

Returns:

The deadline for this business process or null if a deadline is not set.

See Also:

FlowChart.setDeadline(java.util.Date)

getFlowChartName

public java.lang.String getFlowChartName()

Returns the name of the business process that was found.

Returns:

The name of the business process that was found.

getOwners

public java.util.SortedSet getOwners()

Returns the business process owners, if any, of the business process that was found. A business process owner is a person with primary responsibility for ensuring the smooth execution of a business process.

Returns:

SortedSet of String. The business process owners, if any, of the business process that was found. Each business process owner is a security user or role.

getTemplateName

public java.lang.String getTemplateName()

Returns the template name, if any, of the business process that was found.

Returns:

The template name, if any, of the business process that was found.

isDeadlineExceeded

public boolean isDeadlineExceeded()

Returns whether the business process, or flow chart run, exceeded its deadline.

Returns:

Whether the business process, or flow chart run, exceeded its deadline.

See Also:

getDeadline()

isPossibleWork

public boolean isPossibleWork()

Indicates whether the currently logged in user is allowed to work the business process trigger that was found. A business process owner search may yield business processes that are visible but which the currently logged in user is not allowed to work.

Returns:

Whether the currently logged in user is allowed to work the business process trigger that was found.

isRequiredWork

public boolean isRequiredWork()

Indicates whether the currently logged in user is required to work the business process trigger that was found.

Returns:

Whether the currently logged in user is required to work the business process trigger that was found.

isWithinDeadlineWindow

public boolean isWithinDeadlineWindow()

Returns whether the business process is within its deadline window.

The display of business processes in the Flux BPM Dashboard indicates the deadline status of business processes by highlighting business processes in relavent colors. Business processes approaching deadlines are displayed in yellow, business processes which have exceeded the deadline are displayed in orange.

Returns:

Whether the business process is within its deadline window.

See Also:

FlowChart.setDeadline(java.util.Date)