Package com.ptc.windchill.enterprise.maturity

Class PromotionNoticeWorkflowHelper

java.lang.Object

com.ptc.windchill.enterprise.maturity.PromotionNoticeWorkflowHelper

All Implemented Interfaces:

Serializable, RemoteAccess

public class PromotionNoticeWorkflowHelper
extends Object
implements RemoteAccess, Serializable

Helper class for the Promotion Notice Workflow expression robot. This will update maturity baseline, promotion target and promotions seed objects. This method will be called from a workflow expression robot. After the execution of this method, the promotion notice would be updated with the latest iterations of the promotion targets, the baselineables for the associated baseline and the promotion seeds.

    Usage : PromotionNoticeWorkflowHelper helper =
                                       new PromotionNoticeWorkflowHelper((PromotionNotice)notice, false);
            helper.updateWithLatestIterations();

 

Supported API: true

Extendable: false

See Also:

• Serialized Form

Field Summary

Fields inherited from interface wt.method.RemoteAccess

versionID

Constructor Summary

Constructors

Constructor	Description
PromotionNoticeWorkflowHelper(PromotionNotice notice)	Will take in just the PromotionNotice object.
PromotionNoticeWorkflowHelper(PromotionNotice notice, boolean promotionTargetsOnly)	Deprecated. Use PromotionNoticeWorkflowHelper(wt.maturity.PromotionNotice)

Method Summary

Modifier and Type	Method	Description
static String	buildInstructions(ObjectReference self, WTObject pbo, String vote)	This method build the special_instructions if they vote Rework.
String	checkIterationsInReferenceBaseline(PromotionNotice pn)	This method will check if the iterations in the promotion request matches the iterations in the reference baseline.
static String	refresh(PromotionNotice pn)	This method will update maturity baseline, promotion target and promotions seed objects.
static UIValidationResultSet	revisePromotables(PromotionNotice notice, WTPrincipalReference principalRef, Locale locale)	This method revises the promotion candidates in the given promotion notice.
static PromotionNotice	setPromotionDate(PromotionNotice notice)	Sets the promotion date to the current time.
static String	truncateInstructions(String instructions)	This method truncates the instructions to INSTRUCTION_SIZE-3 and add ELLIPSES Supported API: true
String	updateWithLatestIterations(PromotionNotice pn)	This method will update maturity baseline, promotion target and promotions seed objects.

Methods inherited from class java.lang.Object

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

Constructor Details

PromotionNoticeWorkflowHelper

@Deprecated
public PromotionNoticeWorkflowHelper(PromotionNotice notice,
 boolean promotionTargetsOnly)
                              throws WTException,
WTPropertyVetoException

Deprecated.

Use PromotionNoticeWorkflowHelper(wt.maturity.PromotionNotice)

Constructor


Supported API: true

Parameters:

notice - PromotionNotice, the primary business object passed in from the workflow expression

promotionTargetsOnly - If promotionTargetsOnly is true, update only the promotion targets and then update the occuring promotion targets in baseline and seeds. If promotionTargetsOnly is false, then update all the objects included in baseline, promotion targets and seeds

Throws:

WTException

VersionControlException

WTPropertyVetoException

PromotionNoticeWorkflowHelper

public PromotionNoticeWorkflowHelper(PromotionNotice notice)
                              throws WTException,
WTPropertyVetoException

Will take in just the PromotionNotice object. Calculation for the auto refresh will be done using preference value for each promotable.

Supported API: true

Parameters:

notice - PromotionNotice, the primary business object passed in from the workflow expression

Throws:

WTException

WTPropertyVetoException

Method Details

refresh

public static String refresh(PromotionNotice pn)
                      throws WTException,
WTPropertyVetoException,
RemoteException,
InvocationTargetException

This method will update maturity baseline, promotion target and promotions seed objects. This method will be called from a workflow expression robot. After the execution of this method, the promotion notice would be updated with the latest iterations of the promotion targets, the baselineables for the maturity baseline and the collected baseline and the promotion seeds.


Supported API: true

Throws:

WTException

VersionControlException

WTPropertyVetoException

RemoteException

InvocationTargetException

buildInstructions

public static String buildInstructions(ObjectReference self,
 WTObject pbo,
 String vote)
                                throws WTException

This method build the special_instructions if they vote Rework.


Supported API: true

Parameters:

self - . The ObjectReference of the Workflow Process.

pbo - . The Primary Business Object of the workflow process,.

Returns:

String. The concatenated string of rework votes

Throws:

WTException

WTPropertyVetoException

truncateInstructions

public static String truncateInstructions(String instructions)
                                   throws WTException

This method truncates the instructions to INSTRUCTION_SIZE-3 and add ELLIPSES

Supported API: true

Parameters:

instructions - The string to check and truncate.

Returns:

The checked and truncated string

Throws:

WTException

updateWithLatestIterations

public String updateWithLatestIterations(PromotionNotice pn)
                                  throws WTException,
WTPropertyVetoException,
RemoteException,
InvocationTargetException

This method will update maturity baseline, promotion target and promotions seed objects. This method will be called from a workflow expression robot. After the execution of this method, the promotion notice would be updated with the latest iterations of the promotion targets, the baselineables for the associated baseline and the promotion seeds.


Supported API: true

Throws:

WTException

WTPropertyVetoException

RemoteException

InvocationTargetException

checkIterationsInReferenceBaseline

public String checkIterationsInReferenceBaseline(PromotionNotice pn)
                                          throws WTException,
RemoteException,
InvocationTargetException

This method will check if the iterations in the promotion request matches the iterations in the reference baseline.


Supported API: true

Throws:

WTException

RemoteException

InvocationTargetException

revisePromotables

public static UIValidationResultSet revisePromotables(PromotionNotice notice,
 WTPrincipalReference principalRef,
 Locale locale)
                                               throws WTException

This method revises the promotion candidates in the given promotion notice.

Supported API: true

Parameters:

notice - - promotion notice

locale - The locale used to generate the feedback messages in the validation result set.

user - - creator of the revision

Returns:

A validation result set of with the status of revising the promotion candidates. If a feedback message is provided in the validation result for each promotion candidate if the object was not valid for revising. If the Promotion candidates were revised the validation status for the object result is PERMITTED or ENABLED.

Throws:

WTException

setPromotionDate

public static PromotionNotice setPromotionDate(PromotionNotice notice)

Sets the promotion date to the current time.

Supported API: true

Parameters:

notice -

Returns:

updated promotion notice