Package com.ptc.windchill.ws

Class GenericBusinessObject

java.lang.Object
com.ptc.windchill.ws.GenericBusinessObject
All Implemented Interfaces:
com.infoengine.soap.Introspectable, com.infoengine.soap.SAXSOAPElementHandler, com.infoengine.soap.SOAPElementHandler, Serializable
public class GenericBusinessObject extends Object implements Serializable, com.infoengine.soap.Introspectable, com.infoengine.soap.SAXSOAPElementHandler
Java bean that defines a generic business object.

Important When being used in a client JVM (e.g. an Info*Engine JCA client) the system property named "com.ptc.windchill.ws.GenericBusinessObject.client" must be set to true before this class is loaded.

A generic business object has three properties

  • typeIdentifier The name of this object's type.
  • ufid The Unique Federation Identifier of this object.
  • properties The list of properties associated with this object.



Supported API: true

Extendable: false
See Also:

  • Field Details

    • CLIENT_PROPERTY

      public static final String CLIENT_PROPERTY


      Supported API: true The name of the boolean System property to set to true when running in a client JVM. Important This system property must be set before this class is loaded.
      See Also:

  • Constructor Details

    • GenericBusinessObject

      public GenericBusinessObject()
      Constructs a new empty GenericBusinessObject.

      Supported API: true

  • Method Details

    • setTypeIdentifier

      public void setTypeIdentifier(String typeIdentifier)
      Sets this business object's typeIdentifier.

      Supported API: true
      Parameters:
      typeIdentifier - The new typeIdentifier value.

    • getTypeIdentifier

      public String getTypeIdentifier()
      Retrieves this business object's typeIdentifier.

      Supported API: true
      Returns:
      The typeIdentifier.

    • setUfid

      public void setUfid(String ufid)
      Sets this business object's Unique Federation Identifier.

      Supported API: true
      Parameters:
      ufid - The new ufid.

    • getUfid

      public String getUfid()
      Retrieves this business object's Unique Federation Identifier.

      Supported API: true
      Returns:
      The ufid.

    • setProperties

      public void setProperties(int index, Property property)
      Sets a Property object by index.

      Supported API: true
      Parameters:
      index - The index of the Property object to set.
      property - The property object to set.

    • getProperties

      public Property getProperties(int index)
      Retrieves a Property object by index.

      Supported API: true
      Parameters:
      index - The index of the property object to get.
      Returns:
      The Property object or null if invalid index.

    • setProperties

      public void setProperties(Property[] properties)
      Sets the entire list of Property objects.

      Supported API: true
      Parameters:
      properties - The new list of Property objects.

    • getProperties

      public Property[] getProperties()
      Retrieves the entire list of Property objects.

      Supported API: true
      Returns:
      The list of Property objects or null if none..

    • toString

      public String toString()


      Supported API: true
      Overrides:
      toString in class Object
      Returns:
      A basic String representation of this business object.

    • addProperty

      public void addProperty(Property property)
      Adds a Property object to the list of this object's properties.

      Supported API: true
      Parameters:
      property - The property to add.

    • addProperty

      public void addProperty(String name, String value)
      Adds a Property object to the list with name and value.

      Supported API: true
      Parameters:
      name - The name of the new property.
      value - The value of the new proprty.

    • getPropertyObject

      public Property getPropertyObject(String name)
      Gets a Property object by name.

      Supported API: true
      Parameters:
      name - The name of the Property object to retrieve.
      Returns:
      The Property object or null if not found.

    • getPropertyObjects

      public Property[] getPropertyObjects(String name)
      Gets a list of Property objects by name.

      Supported API: true
      Parameters:
      name - The name of the property objects to retrieve.
      Returns:
      The Property objects or null if not found.

    • getPropertyValue

      public String getPropertyValue(String name)
      Gets a property value by name.

      Supported API: true
      Parameters:
      name - The name of the property value to retrieve.
      Returns:
      The value or null if not found.

    • getPropertyValues

      public String[] getPropertyValues(String name)
      Gets a list of property values by name.

      Supported API: true
      Parameters:
      name - The name of the property values to retrieve.
      Returns:
      The values or null if not found.

    • equals

      public boolean equals(Object o)
      Tests this GenericBusinessObject object against another object for equality.

      Supported API: true
      Overrides:
      equals in class Object
      Returns:
      true if o is equivalent.