com.ptc.windchill.ws
Class TypeDescription

java.lang.Object
  com.ptc.windchill.ws.TypeDescription

All Implemented Interfaces:

Serializable

public class TypeDescription
extends Object
implements Serializable

The TypeDescription class is a bean class that describes the detailed characteristics of a business object type. It identifies the name of the type, the names of the type's supertypes, and the names and characteristics of all properties supported by the type.

Supported API: true

Extendable: false

See Also:

SchemaNode, Serialized Form

Constructor Summary

TypeDescription()
Constructs a new TypeDescription.

Method Summary

PropertyDescription[]	getProperties() Returnsa list of PropertyDescriptions supported by this type.
PropertyDescription	getProperties(int i) Returns a PropertyDescription by index.
SchemaNode	getType() Returns the SchemaNode representing this type.
void	setProperties(int i, PropertyDescription property) Sets a PropertyDescription by index.
void	setProperties(PropertyDescription[] properties) Sets the PropertyDescriptions supported by this type.
void	setType(SchemaNode type) Sets the SchemaNode representing this type.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeDescription

public TypeDescription()

Constructs a new TypeDescription.

Supported API: true

Method Detail

getType

public SchemaNode getType()

Returns the SchemaNode representing this type.

Supported API: true

Returns:

The SchemaNode.

setType

public void setType(SchemaNode type)

Sets the SchemaNode representing this type.

Supported API: true

Parameters:

type - The new SchemaNode.

getProperties

public PropertyDescription[] getProperties()

Returnsa list of PropertyDescriptions supported by this type.

Supported API: true

Returns:

The supported PropertyDescriptions.

setProperties

public void setProperties(PropertyDescription[] properties)

Sets the PropertyDescriptions supported by this type.

Supported API: true

Parameters:

properties - The new PropertyDescriptions.

getProperties

public PropertyDescription getProperties(int i)

Returns a PropertyDescription by index.

Supported API: true

Parameters:

i - The index.

Returns:

The PropertyDescription at index i.

setProperties

public void setProperties(int i,
                          PropertyDescription property)

Sets a PropertyDescription by index.

Supported API: true

Parameters:

i - The index.

property - The new PropertyDescription.