Package com.ptc.optegra.nav

Class NavClass

java.lang.Object

com.ptc.optegra.nav.NavClass

public final class NavClass
extends Object

Supported API: true

Constructor Summary

Constructors

Constructor	Description
NavClass(String c, String t, String f, String r)	Constructs the NavClass object Supported API: true

Method Summary

Modifier and Type	Method	Description
void	addClassAttribute(com.ptc.optegra.nav.NavAttribute attr)	Add a class attribute if it does not exist Supported API: true
void	delClassAttributes()	Deletes the class attributes for the object Supported API: true
Vector	getClassAttributes()	Gets the class attributes for the object Supported API: true
String	getClassName()	Gets the class name for the object Supported API: true
String	getItemApp()	Gets the application of the object Supported API: true
String	getItemName()	Gets the item name for the object Supported API: true
String	getItemRev()	Gets the revision for the object Supported API: true
boolean	getItemStructural()	Returns true if the object is structural, else returns false.
String	getItemType()	Gets the type of the object Supported API: true
void	navClassValidate()	Validate NavClass attributes.

Methods inherited from class java.lang.Object

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

Constructor Details

NavClass

public NavClass(String c,
 String t,
 String f,
 String r)

Constructs the NavClass object

Supported API: true

Parameters:

c - - String indicating the class name of the object

t - - Space delimited string made-up of item type, application and an indicator (that specifies if the object is structural in nature) in this order. ex: "P CADDS N", "F PS Y".

f - - The item name

r - - The revision of the item

Method Details

getClassName

public String getClassName()

Gets the class name for the object

Supported API: true

Returns:

String

getItemType

public String getItemType()

Gets the type of the object

Supported API: true

Returns:

String

getItemApp

public String getItemApp()

Gets the application of the object

Supported API: true

Returns:

String

getItemStructural

public boolean getItemStructural()

Returns true if the object is structural, else returns false.

Supported API: true

Returns:

boolean

getItemName

public String getItemName()

Gets the item name for the object

Supported API: true

Returns:

String

getItemRev

public String getItemRev()

Gets the revision for the object

Supported API: true

Returns:

String

getClassAttributes

public Vector getClassAttributes()

Gets the class attributes for the object

Supported API: true

Returns:

Vector

delClassAttributes

public void delClassAttributes()

Deletes the class attributes for the object

Supported API: true

addClassAttribute

public void addClassAttribute(com.ptc.optegra.nav.NavAttribute attr)

Add a class attribute if it does not exist

Supported API: true

navClassValidate

public void navClassValidate()
                      throws com.ptc.optegra.nav.NavException

Validate NavClass attributes.

In particular, this method checks for the validity of the following attributes. a) className. b) type of the component.

Supported API: true

Throws:

com.ptc.optegra.nav.NavException