wt.change2.process
Class ProcessHelper

java.lang.Object
  wt.change2.process.ProcessHelper

All Implemented Interfaces:

Externalizable, Serializable

public class ProcessHelper
extends Object
implements Externalizable

This class contains static methods to support the Change Management objects' workflow processes. These methods are intended to be called by routing expressions and synchronization robot expressions.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

static String	CANCELLED Supported API: true
static String	COMPLETE Supported API: true
static String	CRITICAL Supported API: true
static String	NO_SUBORDINATES Supported API: true
static String	NON_CRITICAL Supported API: true
static String	NOT_ASSOCIATED Supported API: true
static String	NOT_FINISHED Supported API: true
static String	NOT_SUBMITTED Supported API: true

Method Summary

static String	checkAnalysisActivitiesFinished(ChangeAnalysis cAnalysis) Determine if the passed Change Analysis (Change Proposal or Change Investigation) has any pending Analysis Activities.
static String	checkAnalysisActivitiesFinished(ChangeInvestigation cInvestigation) Determine if the associated Change Investigation has any pending Analysis Activities.
static String	checkChangeActivitiesFinished(ChangeOrder2 cOrder) Determine if the passed Change Order has any pending Change Activities.
static String	checkInvestigationsFinished(ChangeRequest2 cRequest) Determine if the passed Change Request has any pending Change Investigations.
static Boolean	checkIssueFormalized(WTChangeIssue cIssue) Determine if the passed Change Issue has been formalized into a Change Request.
static String	checkOrdersFinished(ChangeRequest2 cRequest) Determine if the passed Change Request has any pending Change Orders.
static String	checkProposalsFinished(ChangeRequest2 cRequest) Determine if the passed Change Request has any pending Change Proposals.
static String	checkRequestFinished(WTChangeIssue cIssue) Determine if the parent Change Request is in state "Complete" or "Cancelled." Returns ProcessHelper.COMPLETE if the parent Change Request is in state "Complete." Returns ProcessHelper.CANCELLED if the parent Change Request is in state "Cancelled." Returns ProcessHelper.NOT_ASSOCIATED if the Change Issue has no parent Change Request.
static String	checkRequestSubmitted(ChangeItem cItem) Determine if the parent Change Request has been submitted and returns the complexity of the change.
static String	getComplexity(ChangeItem cItem) Determine the complexity of the change based on parent Change Request of the passed Change Item.
static String	getIssuePriority(WTChangeIssue cIssue) Determine if the passed Change Issue is critical or non-critical.
static boolean	hasEffManagedNewDataVersions(ChangeRequestIfc changeRequest) Determine if the passed Change Request has any Change Activities which have eff-managed new data versions.

Methods inherited from class java.lang.Object

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

Field Detail

CRITICAL

public static final String CRITICAL

Supported API: true

See Also:

Constant Field Values

NON_CRITICAL

public static final String NON_CRITICAL

Supported API: true

See Also:

Constant Field Values

COMPLETE

public static final String COMPLETE

Supported API: true

See Also:

Constant Field Values

CANCELLED

public static final String CANCELLED

Supported API: true

See Also:

Constant Field Values

NOT_ASSOCIATED

public static final String NOT_ASSOCIATED

Supported API: true

See Also:

Constant Field Values

NOT_FINISHED

public static final String NOT_FINISHED

Supported API: true

See Also:

Constant Field Values

NO_SUBORDINATES

public static final String NO_SUBORDINATES

Supported API: true

See Also:

Constant Field Values

NOT_SUBMITTED

public static final String NOT_SUBMITTED

Supported API: true

See Also:

Constant Field Values

Method Detail

getIssuePriority

public static String getIssuePriority(WTChangeIssue cIssue)

Determine if the passed Change Issue is critical or non-critical. Returns ProcessHelper.CRITICAL if the issue has IssuePriority "Emergency", and ProcessHelper.NON_CRITICAL otherwise.

Supported API: true

Parameters:

cIssue -

Returns:

String

checkIssueFormalized

public static Boolean checkIssueFormalized(WTChangeIssue cIssue)
                                    throws ChangeException2,
                                           WTException

Determine if the passed Change Issue has been formalized into a Change Request. Returns true if the passed Change Issue is related to a Change Request through a Formalized By association. Returns false otherwise.

Supported API: true

Parameters:

cIssue -

Returns:

Boolean

Throws:

ChangeException2

WTException

checkRequestFinished

public static String checkRequestFinished(WTChangeIssue cIssue)
                                   throws ChangeException2,
                                          WTException

Determine if the parent Change Request is in state "Complete" or "Cancelled." Returns ProcessHelper.COMPLETE if the parent Change Request is in state "Complete." Returns ProcessHelper.CANCELLED if the parent Change Request is in state "Cancelled." Returns ProcessHelper.NOT_ASSOCIATED if the Change Issue has no parent Change Request.

Supported API: true

Parameters:

cIssue -

Returns:

String

Throws:

ChangeException2

WTException

getComplexity

public static String getComplexity(ChangeItem cItem)
                            throws ChangeException2,
                                   WTException

Determine the complexity of the change based on parent Change Request of the passed Change Item. If the Change Request is a WTChangeRequest2, then it returns the String value of the Complexity Enumerated Type as stored on the Change Item's parent Change Request; otherwise returns the empty string "".

Supported API: true

Parameters:

cItem -

Returns:

String

Throws:

ChangeException2

WTException

checkAnalysisActivitiesFinished

public static String checkAnalysisActivitiesFinished(ChangeInvestigation cInvestigation)
                                              throws ChangeException2,
                                                     WTException

Determine if the associated Change Investigation has any pending Analysis Activities. Returns ProcessHelper.COMPLETE if at least one Change Activity is in state "Complete" and the rest are in state "Complete" or "Cancel." Returns ProcessHelper.CANCELLED if all Analysis Activities are in state "Cancelled." Returns ProcessHelper.NOT_FINISHED if at least one Analysis Activity is pending (i.e. has not reached either state "Complete" or "Cancelled").

Supported API: true

Parameters:

cInvestigation -

Returns:

String

Throws:

ChangeException2

WTException

checkAnalysisActivitiesFinished

public static String checkAnalysisActivitiesFinished(ChangeAnalysis cAnalysis)
                                              throws ChangeException2,
                                                     WTException

Determine if the passed Change Analysis (Change Proposal or Change Investigation) has any pending Analysis Activities. Returns ProcessHelper.COMPLETE if at least one Change Activity is in state "Complete" and the rest are in state "Complete" or "Cancel." Returns ProcessHelper.CANCELLED if all Analysis Activities are in state "Cancelled." Returns ProcessHelper.NOT_FINISHED if at least one Analysis Activity is pending (i.e. has not reached either state "Complete" or "Cancelled").

Supported API: true

Parameters:

cAnalysis -

Returns:

String

Throws:

ChangeException2

WTException

checkProposalsFinished

public static String checkProposalsFinished(ChangeRequest2 cRequest)
                                     throws ChangeException2,
                                            WTException

Determine if the passed Change Request has any pending Change Proposals. Returns ProcessHelper.COMPLETE if at least one Change Proposal is in state "Complete" and the rest are in state "Complete" or "Cancel." Returns ProcessHelper.CANCELLED if all Change Proposals are in state "Cancelled." Returns ProcessHelper.NOT_FINISHED if at least one Change Proposal is pending (i.e. has not reached either state "Complete" or "Cancelled").

Supported API: true

Parameters:

cRequest -

Returns:

String

Throws:

ChangeException2

WTException

checkOrdersFinished

public static String checkOrdersFinished(ChangeRequest2 cRequest)
                                  throws ChangeException2,
                                         WTException

Determine if the passed Change Request has any pending Change Orders. Returns ProcessHelper.COMPLETE if at least one Change Order is in state "Complete" and the rest are in state "Complete" or "Cancel." Returns ProcessHelper.CANCELLED if all Change Orders are in state "Cancelled." Returns ProcessHelper.NOT_FINISHED if at least one Change Order is pending (i.e. has not reached either state "Complete" or "Cancelled").

Supported API: true

Parameters:

cRequest -

Returns:

String

Throws:

ChangeException2

WTException

checkRequestSubmitted

public static String checkRequestSubmitted(ChangeItem cItem)
                                    throws ChangeException2,
                                           WTException

Determine if the parent Change Request has been submitted and returns the complexity of the change. Returns ProcessHelper.NOT_SUBMITTED if the Change Request has not been submitted. Otherwise, if the Change Request is a WTChangeRequest2, then it returns the Complexity Enumerated Type String value as stored on the Change Item's parent Change Request. If the Change Request is not a WTChangeRequest2, then it returns the empty string "".

Supported API: true

Parameters:

cItem -

Returns:

String

Throws:

ChangeException2

WTException

checkChangeActivitiesFinished

public static String checkChangeActivitiesFinished(ChangeOrder2 cOrder)
                                            throws ChangeException2,
                                                   WTException

Determine if the passed Change Order has any pending Change Activities. Returns ProcessHelper.COMPLETE if at least one Change Activity is in state "Complete" and the rest are in state "Complete" or "Cancel." Returns ProcessHelper.CANCELLED if all Change Activities are in state "Cancelled." Returns ProcessHelper.NOT_FINISHED if at least one Change Activity is pending (i.e. has not reached either state "Complete" or "Cancelled").

Supported API: true

Parameters:

cOrder -

Returns:

String

Throws:

ChangeException2

WTException

checkInvestigationsFinished

public static String checkInvestigationsFinished(ChangeRequest2 cRequest)
                                          throws ChangeException2,
                                                 WTException

Determine if the passed Change Request has any pending Change Investigations. Returns ProcessHelper.COMPLETE if at least one Change Investigation is in state "Complete" and the rest are in state "Complete" or "Cancel." Returns ProcessHelper.CANCELLED if all Change Investigations are in state "Cancelled." Returns ProcessHelper.NOT_FINISHED if at least one Change Investigation is pending (i.e. has not reached either state "Complete" or "Cancelled").

Supported API: true

Parameters:

cRequest -

Returns:

String

Throws:

ChangeException2

WTException

hasEffManagedNewDataVersions

public static boolean hasEffManagedNewDataVersions(ChangeRequestIfc changeRequest)
                                            throws WTException

Determine if the passed Change Request has any Change Activities which have eff-managed new data versions. Returns true if at least one Change Activity contains a new data version which is effectivity managable (aka can have effectivity assigned to it).

Supported API: true

Parameters:

changeRequest - Change Request primary object in the workflow process

Returns:

boolean

Throws:

WTException