AnnotationClientHelper

java.lang.Object

com.ptc.windchill.enterprise.annotation.AnnotationClientHelper

public class AnnotationClientHelper extends Object

Helper class used by some of the processors and code of the annotation clients.

Supported API: true

Extendable: false

Method Summary

Modifier and Type

Method

Description

static String

appendOidsToHiddenField(String origValue, String oidString)

Appends the value to the original string value..

static ComponentMode

getMode(NmCommandBean cb)

Will retrieve the Component Mode from the NmCommandBean.

static String

getNmOidString(Object obj)

Given a Persistable object, returns NmOidString , if the convert flag is true, it will replace the ":" with "%3A"
Supported API: true

static WTHashSet

parseToNmOid(String annotations)

parseToNmOid utility to parse the string to return a list of NmOid.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- getMode
  
  public static ComponentMode getMode(NmCommandBean cb)
  
  Will retrieve the Component Mode from the NmCommandBean. Will default to "VIEW" if the mode can not be determined.
  
  Supported API: true
  
  Extendable: false
  
  Parameters:
  
  cb - The current command bean.
  
  Returns:
  
  ComponentMode the component mode for the current operation.
- getNmOidString
  
  public static String getNmOidString(Object obj) throws WTException
  
  Given a Persistable object, returns NmOidString , if the convert flag is true, it will replace the ":" with "%3A"
  Supported API: true
  
  Parameters:
  
  obj -
  
  Returns:
  
  object id string
  
  Throws:
  
  WTException
- parseToNmOid
  
  public static WTHashSet parseToNmOid(String annotations) throws WTException
  
  parseToNmOid utility to parse the string to return a list of NmOid.
  Supported API: true
  
  Parameters:
  
  annotations -
  
  Returns:
  
  a list of NmOid
  
  Throws:
  
  WTException
- appendOidsToHiddenField
  
  public static String appendOidsToHiddenField(String origValue, String oidString) throws WTException
  
  Appends the value to the original string value.. Used for build the value for the hidden field.
  Supported API: true
  
  Parameters:
  
  origValue -
  
  oidString -
  
  Returns:
  
  value for the hidden field
  
  Throws:
  
  WTException