Windchill

https://nakedbikermonk.github.io/windchill-javadoc
Admin
Windchill is a comprehensive product lifecycle management (PLM) platform that includes foundation...
Tokens:5,063,029
Snippets:92,708
Trust Score:8.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### WTProperties Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/util/WTProperties.html

Example of getting applet properties and a specific property.

```java
Properties props = WTProperties.getAppletProperties();
String bar = props.getProperty("wt.foo.bar");
...
```

--------------------------------

### Example Code for Setting Up Context-Sensitive Help

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/help/HelpContext.html

This is a comprehensive example demonstrating the setup of context-sensitive help within a Java AWT component's addNotify method. It includes component initialization, HelpContext creation, adding components with specific topic IDs, setting the tool description display, and adding an action listener to a button to show help contents.

```Java
public void addNotify() {
// Call parents addNotify method. 
super.addNotify();

// This code is automatically generated by Visual Cafe when you add 
// components to the visual environment. It instantiates and initializes 
// the components. To modify the code, only use code syntax that matches 
// what Visual Cafe can generate, or Visual Cafe may be unable to back 
// parse your Java file into its visual environment. 
//{{INIT_CONTROLS   
setLayout(null);
setVisible(false);
...
showContentsButton = new java.awt.Button();
showContentsButton.setLabel("Show Contents");
showContentsButton.setBounds(insets().left + 216,insets().top + 108,96,24);
add(showContentsButton);
display = new java.awt.TextField();
display.setBounds(insets().left + 180,insets().top + 36,168,36);
add(display);
...
//}}

// Give the components a name that the help system recoginizes.
showButton.setName("TopicId_ShowContents");

// Create the HelpDeskContext. It will scan through and default a topic for each component. 
helpContext = new HelpContextImpl( this, helpSystem, "YourContextId" );

// Since the component "display" name doesn't match its topic id re-add it to the HelpContext.  
helpContext.addComponentHelp( display, "TopidId_Display" );

// Supply a TextComponent which will be used to display the tool descriptions. 
helpContext.setToolDescriptionDisplay( statusField );

// Show help contents when showContens button is pressed. 
showContentsButton.addActionListener(

// Anonymous inner class   
new java.awt.event.ActionListener() {
public void actionPerformed( java.awt.event.ActionEvent event ) {
helpContext.showContents();
}
}
);

} // addNotify()
```

--------------------------------

### WTUser Initialization Examples

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/org/WTUser.html

Examples of how to initialize a WTUser instance.

```Java
protected void initialize()
Supports initialization, following construction of an instance.
```

```Java
protected void initialize(String name)
Supports initialization, following construction of an instance.
```

```Java
protected void initialize(String name, String dn)
Supports initialization, following construction of an instance.
```

```Java
protected void initialize(String name, String dn, String service)
Supports initialization, following construction of an instance.
```

```Java
protected void initialize(String name, DirectoryContextProvider context)
Supports initialization, following construction of an instance.
```

--------------------------------

### getWfFolder Folder Path Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/workflow/engine/WfEngineService.html

Example of a folder path format for getWfFolder.

```plaintext
 /System/Workflows/invalid input: '<'folder-name>
```

--------------------------------

### FlexibleChangeConverter run example

Source: https://nakedbikermonk.github.io/windchill-javadoc/index-files/index-19.html

Example command-line usage for the FlexibleChangeConverter to perform conversion actions.

```bash
java wt.change2.flexible.FlexibleChangeConverter
java wt.change2.flexible.FlexibleChangeConverter -action <action_name>
java wt.change2.flexible.FlexibleChangeConverter -action <action_name> -u wcadmin -p wcadmin
```

--------------------------------

### start Method

Source: https://nakedbikermonk.github.io/windchill-javadoc/com/ptc/windchill/mpml/reports/MPMLReportDelegate.html

Called at the start of execution for initial setup.

```java
protected void start(ReportParams params) throws WTException
```

--------------------------------

### Method Details: setUploadedFromPath

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/content/_ApplicationData.html

Details for the setUploadedFromPath method.

```java
public void setUploadedFromPath(String uploadedFromPath) throws WTPropertyVetoException
The path where this piece of content was uploaded from
```

--------------------------------

### getPropertyValue Method Implementation Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/com/ptc/core/businessfield/common/BusinessField.html

Example of how to get a field's property value.

```java
Object getPropertyValue(String propertyName, Locale locale, String screenName)
Get the fields property value.   
  
**Supported API:** true 

Parameters:
    `propertyName` - The name of the property to get the value of.     `locale` - The locale to get the property value for. This is only necessary when requesting the value of a localizable property. May be null.     `screenName` - The name of the screen to get the property value of. This is only necessary when requesting the property value of an attribute defined for an attribute in a layout (i.e. group membership). May be null. 

Returns:
    The value of the property. May return null. The datatype returned will be whatever the datatype of the property definition.
```

--------------------------------

### Example application main

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/util/WTProperties.html

Initializes WTContext with command line arguments, replaces system properties with WTProperties, and retrieves a property.

```java
public static void main (String args)
 {
    // Initialize WTContext with command line arguments
    WTContext.init(args);

    // Replace system properties with WTProperties
    Properties props = WTProperties.getLocalProperties();
    System.setProperties(props);

    // Get our wt.foo.bar property
    String bar = props.getProperty("wt.foo.bar");
    ...
 }
```

--------------------------------

### getStartTimeStamp Method

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/esi/ESITransactionFacade.html

Gets the start timestamp of the transaction.

```java
Timestamp getStartTimeStamp()
Gets the start timestamp of the transaction. 
**Supported API:** true 

See Also:
    
      * `ESITransaction`
```

--------------------------------

### WTContainer initializer example

Source: https://nakedbikermonk.github.io/windchill-javadoc/index-files/index-24.html

Example of how implementors of WTContainer should create a new WTContainerInfo in their initializer.

```Java
protected void initialize() throws WTException {
    super.initialize();
    try {
       setContainerInfo(WTContainerInfo.newWTContainerInfo());
    }
    catch (WTPropertyVetoException wtpve) {
       throw new WTException(wtpve);
    }
 }
  
```

--------------------------------

### AssociationDisplayAssistant Usage Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/facade/persistedcollection/AssociationDisplayAssistant.html

An example demonstrating how to instantiate and use the AssociationDisplayAssistant to get a localized display name for a relation key.

```java
AssociationDisplayAssistant displayAssistant = new AssociationDisplayAssistant(locale, "com.myCompany.myBundle");
String displayValue = displayAssistant.getDisplayName(thisRelationKey);
```

--------------------------------

### Delegate Registration Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/com/ptc/core/businessRules/relationship/BusinessRuleSetRelationshipDelegate.html

Example of a delegate registration for getting the resulting objects for a primary object. The selector is the relationship key used to look up the delegate instance.

```xml
<Option serviceClass="com.ptc.core.businessRules.relationship.ResultingObjectsRelationshipDelegate"
    selector="wt.change2.ChangeRecord2"
    cardinality="singleton"
    requestor="null"/>
```

--------------------------------

### HelpResources Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/help/HelpSystem.html

An example of a help resource bundle implemented using ListResourceBundle, showing how to define keys for URLs, display strings, and tooltips.

```java
public class HelpResources extends ListResourceBundle {
    public Object[][] getContents() {
        return contents;
    }
    static final Object[][] contents = {
        // LOCALIZE THIS
        {"Contents/HelpDesk", "HelpDeskContents.html"}, // Contents URL for appl HelpDesk
        {"Help/HelpDesk", "HelpDeskHelp.html"}, // Help URL for HelpDesk
        {"Desc/HelpDesk", "Press F1 for help." }, // Description URL.
        {"Help/HelpDesk/Login", "Login/help.html"}, // Help URL for login.
        {"Desc/HelpDesk/Login", "Press F1 for help."}, // Description for login.
        {"Help/HelpDesk/Login/OKButton", "Login/OKButton/help.html"},// URL Help for login OK button.
        {"Tip/HelpDesk/Login/OKButton", "Press OK to login." }, // Tool tip for login OK button.
        {"Desc/HelpDesk/Login/OKButton", "This is Description11" } // Descriptoin for login OK button.
        // END OF MATERIAL TO LOCALIZE
    };
}
```

--------------------------------

### getRecentlyVisitedObjectStack Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/recent/RecentlyVisitedService.html

Gets all the most recently accessed objects currently in the preference.

```Java
Vector getRecentlyVisitedObjectStack() throws WTException
```

--------------------------------

### Example application main

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/util/WTContext.html

Demonstrates how to initialize WTContext with command line arguments in an application's main method.

```java
public static void main (String args)
 {
    // Initialize WTContext with command line arguments
    WTContext.init(args);

    // Do application stuff
    ...
 }
```

--------------------------------

### AttributeRange Methods

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/query/AttributeRange.html

Methods for getting and setting the start and end values of the range.

```java
public Object getStart()
public void setStart(Object a_Start) throws WTPropertyVetoException
public Object getEnd()
public void setEnd(Object a_End) throws WTPropertyVetoException
```

--------------------------------

### Sample Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/com/ptc/windchill/option/variantspec/loader/ATORuleConfigSpecXMLLoader.html

Example provided to create two different types of option filter configuration specification - Latest, Effectivity configuration specfications.

```text
yyyy-MM-dd partConfigSpec1 Design INWORK partConfigSpec2 2020-02-07
```

--------------------------------

### Example Usage of TransitionHandlerFactory

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/maturity/TransitionHandlerFactory.html

Demonstrates how to get an instance of TransitionHandlerFactory and use it to find transition targets.

```java
TransitionHandlerFactory.getInstance().transitionTargets(contextObject, transition, false);
```

--------------------------------

### ICacheManagerClassicMBean.getAveOverflowAgeThresholdSec() replacement

Source: https://nakedbikermonk.github.io/windchill-javadoc/deprecated-list.html

Example of using the recommended method for getting the thrashing time threshold.

```java
wt.cache.ICacheManagerClassicMBean.getAveOverflowAgeThresholdSec()
Replaced by `ICacheManagerClassicMBean.getThrashingTimeThreshold()`   
  
**Supported API:** true
```

--------------------------------

### PlantEffConfigSpecGroup Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/index-files/index-2.html

For WTPartEFF Config Spec : - SELECT classnameA2A2,idA2A2 FROM wt.part.WTPart A0 WHERE (A0.idA3masterReference = 157644) AND (A0.classnamekeycontainerReferen invalid input: '<'> 'wt.projmgmt.admin.Project2') AND ((A0.statecheckoutInfo invalid input: '<'> 'wrk-p') AND (A0.idA3view = 156040) OR (A0.idA3view = 28596) OR (A0.viewIsNull IS NULL )) AND (A0.variation1 IS NULL ) AND (A0.variation2 IS NULL ) AND ((A0.latestiterationInfo = 1) AND ( 1 != 1 ) OR (A0.latestiterationInfo = 1) AND (EXISTS (SELECT E0.branchIdA3targetReference FROM WTDatedEffectivity E0 WHERE (((E0.idA3deletionReference IS NULL ) OR (E0.idA3deletionReference = 0)) AND ((E0.branchIdA3targetReference = A0.branchIditerationInfo) AND ((E0.idA3effContextReference = 156097)) AND ((E0.startrange invalid input: '<'= TO_DATE('2019:02:04:23:59:00','YYYY:MM:DD:HH24:MI:SS')) AND ((E0.endrange >= TO_DATE('2019:02:04:00:00:00','YYYY:MM:DD:HH24:MI:SS')) OR (E0.endrange IS NULL ))))))))

```sql
SELECT classnameA2A2,idA2A2 FROM wt.part.WTPart A0 WHERE (A0.idA3masterReference = 157644) AND (A0.classnamekeycontainerReferen invalid input: '<'> 'wt.projmgmt.admin.Project2') AND ((A0.statecheckoutInfo invalid input: '<'> 'wrk-p') AND (A0.idA3view = 156040) OR (A0.idA3view = 28596) OR (A0.viewIsNull IS NULL )) AND (A0.variation1 IS NULL ) AND (A0.variation2 IS NULL ) AND ((A0.latestiterationInfo = 1) AND ( 1 != 1 ) OR (A0.latestiterationInfo = 1) AND (EXISTS (SELECT E0.branchIdA3targetReference FROM WTDatedEffectivity E0 WHERE (((E0.idA3deletionReference IS NULL ) OR (E0.idA3deletionReference = 0)) AND ((E0.branchIdA3targetReference = A0.branchIditerationInfo) AND ((E0.idA3effContextReference = 156097)) AND ((E0.startrange invalid input: '<'= TO_DATE('2019:02:04:23:59:00','YYYY:MM:DD:HH24:MI:SS')) AND ((E0.endrange >= TO_DATE('2019:02:04:00:00:00','YYYY:MM:DD:HH24:MI:SS')) OR (E0.endrange IS NULL ))))))))
```

--------------------------------

### createProcess Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/workflow/engine/WfEngineService.html

Creates and returns a process from the given template, associated team specification and a reference to the context where the process is to be created.

```Java
WfProcess createProcess(WfProcessDefinition template, Object team_spec, WTContainerRef context_ref) throws WTException
```

--------------------------------

### getVersionDisplayIdentifier Method

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/vc/VersionControlHelper.html

Get the displayable identifier of the object's version. The identifier for the version might be for example A or B for a Revision.

```Java
public static LocalizableMessage getVersionDisplayIdentifier(Versioned version) throws VersionControlException
Get the displayable identifier of the object's version. The identifier for the version might be for example A or B for a Revision.

**Supported API:** true

Parameters:
    
```

--------------------------------

### Example Usage of BaseQueryService

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/enterprise/tabularresults/BaseQueryService.html

This snippet demonstrates how to use QueryServiceProvider to get an instance of BaseQueryService and retrieve query results.

```java
QueryServiceProvider query_service_provider = new QueryServiceProvider();
BaseQueryService base_query_service = query_service_provider.getqueryService(query_service_name);

queryResults = (Object[])base_query_service.getQuery( getContextObj(),
 parameters,
 locale);

```

--------------------------------

### Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/taglib/util/PluginTag.html

Excerpt from wt/clients/folderexplorer/explorer.jsp

```jsp
<%@ taglib uri="http://www.ptc.com/windchill/taglib/util" prefix="util" %>
 <util:plugin
   code="wt/clients/folderexplorer/WindchillExplorerApplet.class"
   codebase="../../.."
   archive="wt/security/security.jar"
   width="96" height="66">
   <util:params>
     <util:param name="cabinets" value="wt/security/security.cab" />
     <util:param name="cache_option" value="Plugin" />
     <util:param name="cache_archive" value="wt.jar" />
   </util:params>
 </util:plugin>
 

```

--------------------------------

### PlantPersistableEffConfigSpec Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/index-files/index-2.html

Appends a 'context =  and start invalid input: '<'=  and (end >=  or end = null' to the QuerySpec.

```java
wt.part.PlantPersistableEffConfigSpec
```

--------------------------------

### initialize Method

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/part/WTPartPromotionNoticeConfigSpec.html

Supports initialization, following construction of an instance. Invoked by 'new' factory having the same signature.

```java
protected void initialize(PromotionNotice a_PromotionNotice) throws WTPropertyVetoException
```

--------------------------------

### PersistableEffConfigSpec Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/index-files/index-2.html

Appends a 'context =  and start invalid input: '<'=  and (end >=  or end = null' to the QuerySpec.

```java
wt.eff.PersistableEffConfigSpec
```

--------------------------------

### Example applet init

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/util/WTProperties.html

Initializes WTContext for an applet and retrieves a property from various sources.

```java
public void init () 
 {
    // Initialize WTContext for this applet
    WTContext.init(this);

    // Get the wt.foo.bar property from applet parameters, server
    // configuration properties, local configuration properties,
    // or system properties.

```

--------------------------------

### getIterationDisplayIdentifier (Versioned)

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/vc/VersionControlHelper.html

Gets the displayable identifier of the object's iteration. The identifier for the iteration might be for example A.1 or A.2 after an Iteration.

```java
public static LocalizableMessage getIterationDisplayIdentifier(Versioned version) throws VersionControlException
```

--------------------------------

### getStart Method Details

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/eff/_EffRange.html

Detailed explanation of the getStart method.

```java
Serializable getStart()
The start, which is required, indicates when an Eff becomes valid. Implementations of EffRange must constrain the type to a type, such as String and Timestamp, that can be queried in the database using standard operators.
**Supported API:** true
```

--------------------------------

### Example APIs to get context objects

Source: https://nakedbikermonk.github.io/windchill-javadoc/com/ptc/netmarkets/util/beans/NmCommandBean.html

Provides helper APIs to access current context objects for the page or action.

```java
getPageOid()
getActionOid()
getActionOidsWithWizard()
getActionOidsWithoutWizard()
```

--------------------------------

### Usage Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/com/ptc/windchill/enterprise/maturity/PromotionNoticeWorkflowHelper.html

Demonstrates how to instantiate and use the PromotionNoticeWorkflowHelper class.

```java
PromotionNoticeWorkflowHelper helper = new PromotionNoticeWorkflowHelper((PromotionNotice)notice, false);
helper.updateWithLatestIterations();
```

--------------------------------

### getIndex Method (AssociationTypeIdentifier, TypeInstanceIdentifier, int)

Source: https://nakedbikermonk.github.io/windchill-javadoc/com/ptc/core/command/common/bean/entity/SavePersistentEntitySubCommand.html

Gets the index based on association type, type instance, and start index.

```java
public int getIndex(AssociationTypeIdentifier the_association_type_identifier, TypeInstanceIdentifier the_type_instance_identifier, int start_index)

Parameters:
    the_association_type_identifier -      the_type_instance_identifier -      start_index -  

Returns:
    int
```

--------------------------------

### Example applet init

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/util/WTContext.html

Shows how to initialize WTContext for an applet and how to properly destroy it.

```java
public void init () 
 {
    // Initialize WTContext for this applet
    WTContext.init(this);

    // Do applet init stuff
    ...
 }

 public void destroy () 
 {
    // Destroy WTContext for this applet
    WTContext.getContext(this).destroy(this);
 }
```

--------------------------------

### Example Usage of buildSysAdmHREF

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/sysadm/SysAdmServletHelper.html

Demonstrates how to use the buildSysAdmHREF method to construct a System Administration gateway URL.

```java
buildSysAdmHREF( aURLFactory, "wt.httpgw.HTTPServer", "echo", null )
```

--------------------------------

### Example APIs to get combo box values

Source: https://nakedbikermonk.github.io/windchill-javadoc/com/ptc/netmarkets/util/beans/NmCommandBean.html

Demonstrates how to retrieve changed, old, and current values for combo box components.

```java
getChangedComboBox()
getOldComboBox()
getComboBox()
```

--------------------------------

### getServer Method (service_name)

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/manager/RemoteServerManager.html

Gets a reference to a remote server object using a service name. If no server is available, one will be started.

```java
public Remote getServer(String service_name) throws RemoteException
```

--------------------------------

### Command Line Usage Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/load/LoadFromFile.html

Example of how to use the LoadFromFile utility from the command line, including handling arguments with spaces on Windows.

```bash
windchill wt.load.LoadFromFile -d [data file name] -u [user name] -p [user password] -CONT_PATH [container path]
```

```bash
windchill wt.load.LoadFromFile
-d D:\Dev\LoadfileforTesting\Part.xml
-CONT_PATH "/wt.inf.container.OrgContainer=TST/wt.pdmlink.PDMLinkProduct=part 4"
```

--------------------------------

### main Method

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/util/WTProperties.html

Simple tester. Prints local and server properties lists. If an argument is specified, it is used as a prefix filter on the keys.

```java
public static void main(String[] args) throws IOException
```

--------------------------------

### getOption Method

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/query/SearchCondition.html

Deprecated method to get the value of the attribute: option; String representation of the option (for example, ESCAPE option for LIKE).

```java
public String getOption()
```

--------------------------------

### postCreateDocument

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/doc/WTDocumentService.html

Uses the DocumentFactory to get the delegate to allow for extra post processing of the document after it has been persisted. For example this will handle the creation and persistance of relationships.

```java
FormatContentHolder postCreateDocument(FormatContentHolder document, DocumentFormData form_data) throws WTException
```

--------------------------------

### setUpstreamIteration Method Details

Source: https://nakedbikermonk.github.io/windchill-javadoc/com/ptc/windchill/associativity/equivalence/EquivalenceNetwork.EquivalenceData.html

Detailed documentation for the setUpstreamIteration method.

```java
public void setUpstreamIteration(Iterated upstreamIteration)
  
  
**Supported API:** true 

Parameters:
    `upstreamIteration` - the upstreamIteration to set
```

--------------------------------

### getServer Method (service_name, start_num)

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/manager/RemoteServerManager.html

Gets a reference to a remote server object using a service name and a starting number for multiple servers.

```java
public Remote getServer(String service_name, int start_num) throws RemoteException
```

--------------------------------

### startProcess Method

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/workflow/engine/WfEngineService.html

Start a process given, in addition to the input data, absolute start time and deadline. The values provided (if not null) supersede the default values calculated using the process template. If any of the values is null then the corresponding default value is used.

```Java
WfProcess startProcess(WfProcess process, ProcessData input, long priority, Timestamp start_time, Timestamp deadline) throws WTException
```

--------------------------------

### postUpdateDocument

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/doc/WTDocumentService.html

Uses the DocumentFactory to get the delegate to allow for extra post processing of the document after it has been persisted. For example this will handle the creation and persistance of relationships or the removal of relationships.

```java
FormatContentHolder postUpdateDocument(FormatContentHolder document, DocumentFormData form_data) throws WTException
```

--------------------------------

### EffConfigSpec Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/index-files/index-2.html

Restricts the query to return only those items with the specified invalid reference EffConfigSpec#effContext and whose _EffConfigSpec.value is between the start and end values any effectivities.

```java
EffConfigSpec#effContext
```

--------------------------------

### initialize

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/vc/VersionReference.html

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

```Java
protected void initialize(Iterated obj) throws WTException
```

--------------------------------

### initialize

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/vc/VersionReference.html

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

```Java
protected void initialize(VersionForeignKey objId) throws WTException
```

--------------------------------

### valueToValueAsString

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/eff/EffConfigSpecAssistant.html

Converts a value to a String. Uses EffHelper.getEffRange(Class) and getEffGroupRangeDelegate(java.lang.Class) to get an EffGroupRangeDelegate so it can figure out what type of value for start or end of a Range to convert to a String.

```java
public static String valueToValueAsString(Class effType, Serializable value) throws WTPropertyVetoException
```

--------------------------------

### getIcon

Source: https://nakedbikermonk.github.io/windchill-javadoc/com/ptc/netmarkets/util/misc/NmAction.html

Gets the value of the attribute: icon; Action icon gets an icon path relative to the codebase directory. Assumes icon is in /netmarkets/images/ unless the path starts with "wt", "wtcore", "com", or if a property for custom action image location has been set.

```Java
public String getIcon()
```

--------------------------------

### wt.eff._EffConfigurationItem.getSolution()

Source: https://nakedbikermonk.github.io/windchill-javadoc/index-files/index-8.html

The solution for this EffConfigurationItem.

```Java
getSolution()
```

--------------------------------

### WTProperties Constructor

Source: https://nakedbikermonk.github.io/windchill-javadoc/index-files/index-24.html

Construct a new `WTProperties` object.

```java
new WTProperties(properties);
```

--------------------------------

### init Method Details

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/enterprise/BasicLinkComparison.html

Detailed description of the init method.

```java
public void init(int number)

Specified by:
    init in interface LinkComparison
```

--------------------------------

### valueAsStringToValue

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/eff/EffConfigSpecAssistant.html

Converts the String representation of a value to the serialized object represented by the type. Uses EffHelper.getEffRange(Class) and getEffGroupRangeDelegate(java.lang.Class) to get an EffGroupRangeDelegate so it can figure out what type of value for start or end of a Range to convert the value to.

```java
public static Serializable valueAsStringToValue(Class effType, String valueAsString) throws WTPropertyVetoException
```

--------------------------------

### getDash Method

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/eff/EffGroupAssistant.html

Gets the value of the attribute: dash; The string value representing the dash for the range. For example, the hyphen in the following string is the dash "8- 10". The value for the separator is locale-specific and is obtained from effResource's DASH constant.

```Java
public static String getDash()
Gets the value of the attribute: dash; The string value representing the dash for the range. For example, the hyphen in the following string is the dash "8- 10".   
  
The value for the separator is locale-specific and is obtained from effResource's DASH constant.   
  
**Supported API:** true 

Returns:
    String 

See Also:
    
      * `effResource`
```

--------------------------------

### initialize (master) Method

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/change2/WTAnalysisActivity.html

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

```java
protected void initialize(WTAnalysisActivityMaster master) throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.   
  
**Supported API:** true 

Parameters:
    `master` -  

Throws:
    `WTException`
```

--------------------------------

### getSeparator Method

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/eff/EffGroupAssistant.html

Gets the value of the attribute: separator; The string value representing the separator for the range. For example, the comma in the following string is the separator "8, 10". The value for the separator is locale-specific and is obtained from effResource's SEPARATOR constant.

```Java
public static String getSeparator()
Gets the value of the attribute: separator; The string value representing the separator for the range. For example, the comma in the following string is the separator "8, 10".   

The value for the separator is locale-specific and is obtained from effResource's SEPARATOR constant.   
  
**Supported API:** true 

Returns:
    String 

See Also:
    
      * `effResource`
```

--------------------------------

### Method: initialize

Source: https://nakedbikermonk.github.io/windchill-javadoc/com/ptc/arbortext/windchill/partlist/PartListMasterToPartListMasterLink.html

Supports initialization, following construction of an instance.

```java
protected void initialize(PartListMaster generatedFrom,  PartListMaster generated,  NavigationCriteria navCriteria)
```

--------------------------------

### Get Series

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/vc/OneOffVersionIdentifier.html

Gets the series.

```java
public Series getSeries() throws VersionControlException
```

--------------------------------

### Example Usage of QueryHint

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/query/QueryHint.html

Demonstrates how to create and use a QueryHint to pass datastore-specific hints to QuerySpec.

```Java
QueryHint queryHint = QueryHintFactory.createSQLServerTableHint(wtPartIdx, "wtpart.forcescan");
ArrayList queryHintList = new ArrayList();
queryHintList.add(queryHint);
querySpec.appendQueryHint(queryHintList)
```

--------------------------------

### toDiscrepancyType Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/com/ptc/windchill/associativity/reconciliation/client/DiscrepancyType.html

Example of using the toDiscrepancyType API to create discrepancy instances. It also shows examples of invalid references.

```Java
public static DiscrepancyType toDiscrepancyType(String internal_value) throws WTInvalidParameterException
Use this API to create the discrepancy instances. This will mark the discrepancies as `DiscrepancyType.CreateDiscrepancy` if from valid list. Examples are  invalid reference ```
#ASSEMBLE_UNDER_UPSTREAM
```
,  invalid reference ```
#ASSEMBLE_UNDER_DOWNSTREAM
```
```

--------------------------------

### doAction Method Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/federation/FederationHelper.html

Example demonstrating how to pass arguments to the doAction method, which executes Info*Engine tasks.

```java
Object[][] argv = { {"arg1Name", arg1Value}, {"arg2Name", arg2Value}, {"arg3Name", arg3Value} };
```

--------------------------------

### process Method Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/part/PlantEffConfigSpecGroup.html

Example of the process method.

```java
QueryResult
process(QueryResult results)
Returns the latest effective version for each master.
```

--------------------------------

### start

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/pom/Transaction.html

Start a transaction block.

```java
public void start() throws PersistenceException
```

--------------------------------

### getStart Method Details

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/eff/_StringEffRange.html

Details for the getStart method.

```java
public Serializable getStart()
The start value, constrained as a String. 
**Supported API:** true 

Specified by:
    `getStart` in interface `_EffRange` 

Specified by:
    `getStart` in interface `EffRange` 

Returns:
    Serializable 

See Also:
    
      * `StringEffRange`
      * `EffRange`
```

--------------------------------

### createAdHocProcess Example

Source: https://nakedbikermonk.github.io/windchill-javadoc/wt/workflow/engine/WfEngineService.html

Creates a process given a template object that can be a process template, a block template or an activity template.

```Java
WfProcess createAdHocProcess(WfTemplateObject template, Object team_spec, WTContainerRef context_ref) throws WTException
```
Tokens:
Raw