Package com.ptc.windchill.esi.mpml.processplan.operation

Class ESIOperationPBORenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.mpml.processplan.operation.ESIOperationPBORenderer

All Implemented Interfaces:

ESIRenderer

public class ESIOperationPBORenderer
extends BasicESIRenderer

Ability to publish the Operation by changing the LCS of it. This class renders the output of Operation which includes resources, document, Standard control characteristics, operation usage links, operation to part links, operated on part links, standard procedure links, work center links, option set, etc.

Supported API: true

Extendable: true

Field Summary

Fields inherited from class com.ptc.windchill.esi.rnd.BasicESIRenderer

adapterName, authentication, currentTarget, DELIMITER, objectTypeDefs, OPTIONSVARIANTS_HELPER_CLASS_STRING, SEPARATOR, taskHelper, XML_META_NAME

Method Summary

Modifier and Type	Method	Description
void	buildGroups()	Populates the associated VdbBuilder instance with the response data for a operation by invoking associated process plan.
com.infoengine.object.IeCollection	getOperation(String objectID, ESITransaction txn, Collection<ESITarget> tgts, String auth, String wcAdapter, boolean useECNDTAttrs, Map<Persistable,Set<Persistable>> processPlansAssociatedtoOperation)	Creates a VdbBuilder instance for the input transaction, renders the input operation and creates release activities as appropriate for each of the distribution targets in tgts.
void	getOperation(Releasable mpmOperation, boolean delta, boolean processPlanPart, boolean resource, boolean sequence, boolean standardProcedure, String suboperationDepth, boolean operatedOnPart, boolean bomPart, boolean componentParts, boolean alternates, boolean substitutes, boolean referenceDesignators, boolean lineNumber, String bomMultiLevel, boolean documents, boolean workInstructions, String navCriteriaRef, String auth, String wcAdapter, VdbBuilder builder, Map<Persistable,Set<Persistable>> processPlansAssociatedtoOperation)	This API is called from Change notice and Promotion Request.
protected MPMOperation	getRoot()	If root is already initialized, this method returns it to the caller; otherwise, it fetches a handle to the object corresponding to OBID, stores it in root and returns it.
void	setData(String obid, boolean provideDelta, boolean buildProcessPlanPart, boolean resources, boolean sequences, boolean standardProcedures, String suboperationDepth, boolean operatedOnPart, boolean buildBOMPart, boolean buildComponentParts, boolean buildAlternates, boolean buildSubs, boolean buildRefDes, boolean useLineNumbers, String multiLevel, boolean buildDocs, boolean workInstructions, String auth, String wcAdapter)	Initializes this renderer instance appropriately.
protected void	validate()	Makes sure that Operation is in proper state for release it to ERP system.

Methods inherited from class com.ptc.windchill.esi.rnd.BasicESIRenderer

addAtt, adjustConfigurableAndCollapsibleAtts, adjustDateEffCxt, adjustDateEffectivities, adjustEffectivities, adjustLotNumberEffCxt, adjustLotNumberEffectivities, adjustObjectID, adjustSerialNumberEffCxt, adjustSerialNumberEffectivities, adjustTargets, buildUfidString, evaluateBussinessRule, fetchLatestEffectivities, formatDateEffectivityElement, getAdapterName, getAssignedVariantSpec, getAssignedVariantSpec, getAUMRenderer, getAuth, getBuilder, getEffectivityElementMap, getEffectivityHandler, getEffectivityTargetAttributes, getElements, getERPMaterialAttributeList, getERPMaterialAttributeList, getERPMaterialTargetAttributes, getFormatedDate, getGroupInfo, getGroupInfo, getGroupInfo, getMap, getMap, getMapInfo, getMapInfo, getMapInfo, getNavigationFilter, getObjectTypeDefs, getPlantSpecificAttributeList, getPlantSpecificAttributeList, getPlantSpecificTargetAttributes, getPreviousObject, getPreviousPublishedEffectivity, getTargetsFromAssns, getTargetUtility, getTransactionUtility, getUnwantedAttributes, getVersionRefObjectRefMap, getWCAttributeList, getWCAttributeList, initEffectivityHandler, initializeElementForGroup, invokeQueryTask, invokeQueryTask, invokeQueryTask, invokeQueryTaskForObjects, isExpressionToBePublished, isGroupAvailable, isPublishAssocOptionSetFlagEnabled, mapDateEffectivities, mapEffectivities, mapEffectivityAttributes, mapEffectivityElement, mapEffectivityParentElement, mapElement, mapElement, mapElement, mapElementWithEffectivityAttrs, mapLotNumberEffectivities, mapObject, mapObject, mapSerialNumberEffectivities, mergeElements, overrideAttrValue, populateDateEffectivityInfo, populateEffectivityInfo, processBussinessRulesWithAnd, processBussinessRuleValidationResultSet, processNoMatchingVersionFound, removeAttributesNotRequired, removeUnwantedEffectivityAttributes, render, renderAssociatedSkinnyVariantSpec, renderAssociatedVariantSpec, renderAssocOptionSetLinks, renderAssocSkinnyVariantSpec, renderAssocVariantSpec, renderATONavigationFilter, renderChoiceRules, renderEffectivities, renderEffectivities, renderExpressions, renderOptionSets, renderRoleBObjectOfModuleVariantLink, setAttrValue, setAttrValue, setAttrValues, setBuilder, setCurrentTarget, setCurrentTarget, setCurrentTargetFromTgtAssocs, setEffectivityHandler, setObjectTypeDefs, setObjectTypeDefs, setObjectTypeDefsFromObj, setStartEndEffAttr, setTransactionUtility, shallPublishAssocOptionSet, shouldRenderEffectivityElementInPartElement, shouldUseOldEffectivityBehaviour, storeCurrentAndItsPreviousObject, storeCurrentAndItsPreviousObject

Methods inherited from class java.lang.Object

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

Method Details

buildGroups

public void buildGroups()
                 throws ESIRendererException

Populates the associated VdbBuilder instance with the response data for a operation by invoking associated process plan. If parts and Plant information is associated with the process plan are requested, and renders each of them using an appropriate renderer instance.

Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException

validate

protected void validate()
                 throws ESIRendererException

Makes sure that Operation is in proper state for release it to ERP system.

Supported API: true

Specified by:

validate in class BasicESIRenderer

Throws:

ESIRendererException

getOperation

public com.infoengine.object.IeCollection getOperation(String objectID,
 ESITransaction txn,
 Collection<ESITarget> tgts,
 String auth,
 String wcAdapter,
 boolean useECNDTAttrs,
 Map<Persistable,Set<Persistable>> processPlansAssociatedtoOperation)
                                                throws WTException

Creates a VdbBuilder instance for the input transaction, renders the input operation and creates release activities as appropriate for each of the distribution targets in tgts. The settings pertaining to ESI response generation for a given distribution target are fetched from the target itself. Returns the rendered output as an Info*Engine collection to the caller. Additionally this method renders the children of the assembly which is added as a related assembly to the input operation, if they are associated with any additional targets than their parent.

Supported API: true

Parameters:

objectID - UFID of the process plan to be rendered.

txn - ESITransaction object that represents the delivery of data to the distribution targets in tgts; will be null when the method is invoked for the Preview functionality.

tgts - Collection of distribution targets that represent a given destination, such as an ERP instance.

auth - This parameter contains authentication information required for executing certain Windchill adapter wtobjects as part of the rendering process.

wcAdapter - This parameter contains the name of the Windchill adapter instance.

useECNDTAttrs - If true, distribution target attributes that figure in the ECN Settings section will be used for the response generation; otherwise, attributes that figure in the Process Plan Settings section will be used. For example, a true will be passed for this parameter when the method is invoked for the Preview functionality and the preference "Automatically Generate Change Notice" has a value "Yes".

processPlansAssociatedtoOperation - Map that contains associated process plan for a given operation.

Returns:

IeCollection The Info*Engine collection that holds the ESI response.

Throws:

WTException - - if any of the invoked methods throws this exception.

getOperation

public void getOperation(Releasable mpmOperation,
 boolean delta,
 boolean processPlanPart,
 boolean resource,
 boolean sequence,
 boolean standardProcedure,
 String suboperationDepth,
 boolean operatedOnPart,
 boolean bomPart,
 boolean componentParts,
 boolean alternates,
 boolean substitutes,
 boolean referenceDesignators,
 boolean lineNumber,
 String bomMultiLevel,
 boolean documents,
 boolean workInstructions,
 String navCriteriaRef,
 String auth,
 String wcAdapter,
 VdbBuilder builder,
 Map<Persistable,Set<Persistable>> processPlansAssociatedtoOperation)
                  throws WTException

This API is called from Change notice and Promotion Request.

Supported API: true

Parameters:

mpmOperation - - MPMOperation

delta - - If false, renders the entire process plan as new; else renders the difference between the current and previously published iterations.

processPlanPart - - Specifies whether the part associated with the process plan needs to be published.

resource - - Specifies whether the resources associated with an operation need to be published.

sequence - - Specifies whether the sequences associated with the process plan need to be published.

standardProcedure - - Indicates if the associated Standard Procedures are to be rendered.

suboperationDepth - - Specifies the depth up to which sub-operations in an operation should be published.

operatedOnPart - - Specifies whether the operated on parts associated with an operation need to be published.

bomPart - - If true, returns part information for the BOM header associated with the process plan.

componentParts - - If true, returns part information for the components in the BOM associated with the process plan.

alternates - - If true, returns alternate parts info, default is "false". Only operative if buildBOMPart is true.

substitutes - - If true, returns substitutes data.

referenceDesignators - - If true, returns Reference Designator data.

lineNumber - - If true, returns line numbers info; no line numbers info otherwise.

bomMultiLevel - - Specifies the number of levels of the BOM associated with the process plan to be published.

documents - - Specifies whether the documents associated with an operation need to be published.

workInstructions - - Specifies whether the work-instructions associated with an operation need to be published.

navCriteriaRef - - Navigation criteria reference

auth - - I*E authentication information to use when executing a query task.

wcAdapter - - Name of the Windchill adapter instance to use when executing a wtobject.

builder - - vdbBuilder instance

processPlansAssociatedtoOperation - - Associated process plan. key is the process plan and value is MPMOperationHolder from PP to Operation

Throws:

WTException

setData

public void setData(String obid,
 boolean provideDelta,
 boolean buildProcessPlanPart,
 boolean resources,
 boolean sequences,
 boolean standardProcedures,
 String suboperationDepth,
 boolean operatedOnPart,
 boolean buildBOMPart,
 boolean buildComponentParts,
 boolean buildAlternates,
 boolean buildSubs,
 boolean buildRefDes,
 boolean useLineNumbers,
 String multiLevel,
 boolean buildDocs,
 boolean workInstructions,
 String auth,
 String wcAdapter)
             throws WTException

Initializes this renderer instance appropriately.

Supported API: true

Parameters:

obid - - Object ID of the process plan.

provideDelta - - If false, renders the entire process plan as new; else renders the difference between the current and previously published iterations.

buildProcessPlanPart - - Specifies whether the part associated with the process plan needs to be published.

resources - - Specifies whether the resources associated with an operation need to be published.

sequences - - Specifies whether the sequences associated with the process plan need to be published.

standardProcedures - - Indicates if the associated Standard Procedures are to be rendered.

suboperationDepth - - Specifies the depth up to which sub-operations in an operation should be published.

operatedOnPart - - Specifies whether the operated on parts associated with an operation need to be published.

buildBOMPart - - If true, returns part information for the BOM header associated with the process plan.

buildComponentParts - - If true, returns part information for the components in the BOM associated with the process plan.

buildAlternates - - If true, returns alternate parts info, default is "false". Only operative if buildBOMPart is true.

buildSubs - - If true, returns substitutes data.

buildRefDes - - If true, returns Reference Designator data.

useLineNumbers - - If true, returns line numbers info; no line numbers info otherwise.

multiLevel - - Specifies the number of levels of the BOM associated with the process plan to be published.

buildDocs - - Specifies whether the documents associated with an operation need to be published.

workInstructions - - Specifies whether the work-instructions associated with an operation need to be published.

auth - - I*E authentication information to use when executing a query task.

wcAdapter - - Name of the Windchill adapter instance to use when executing a wtobject.

Throws:

WTException - if any of the invoked methods throws this exception.

getRoot

protected MPMOperation getRoot()
                        throws ESIRendererException

If root is already initialized, this method returns it to the caller; otherwise, it fetches a handle to the object corresponding to OBID, stores it in root and returns it.

Supported API: true

Returns:

Handle to root.

Throws:

ESIRendererException - if any of the invoked methods throws this exception.