com.simplifiedlogic.nitro.jlink.data

Class ParameterData

java.lang.Object

com.simplifiedlogic.nitro.jlink.data.ParameterData

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ParameterDeleteData, ParameterDesignateData

public class ParameterData
extends java.lang.Object
implements java.io.Serializable

Information about a Creo parameter

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParameterData()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ParameterData data) Compares two parameter-data objects based on parameter name
boolean	equals(java.lang.Object data)
java.lang.String	getDecodedStringValue()
java.lang.String	getDescription()
java.lang.String	getName()
int	getOwnerId()
java.lang.String	getOwnerName()
java.lang.String	getOwnerType()
int	getSetDesignate()
java.lang.String	getType()
java.lang.Object	getValue()
int	hashCode()
boolean	isDesignate()
boolean	isEncoded()
void	setDescription(java.lang.String description)
void	setDesignate(boolean designate)
void	setEncoded(boolean encoded)
void	setName(java.lang.String name)
void	setOwnerId(int ownerId)
void	setOwnerName(java.lang.String ownerName)
void	setOwnerType(java.lang.String ownerType)
void	setSetDesignate(int setDesignate)
void	setType(java.lang.String type)
void	setValue(java.lang.Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterData

public ParameterData()

Method Detail

equals

public boolean equals(java.lang.Object data)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(ParameterData data)

Compares two parameter-data objects based on parameter name

Parameters:

data - The other Parameter to compare with

Returns:

the value 0 if the param name is equal to the data argument's name; a value less than 0 if this param name is lexicographically less than the data argument's name; and a value greater than 0 if this param name is lexicographically greater than the data argument's name.

getDecodedStringValue

public java.lang.String getDecodedStringValue()

Returns:

The parameter value as a decoded string, if it's marked encoded

getName

public java.lang.String getName()

Returns:

Parameter name

setName

public void setName(java.lang.String name)

Parameters:

name - Parameter name

getValue

public java.lang.Object getValue()

Returns:

Parameter value

setValue

public void setValue(java.lang.Object value)

Parameters:

value - Parameter value

getType

public java.lang.String getType()

Returns:

Data type

setType

public void setType(java.lang.String type)

Parameters:

type - Data type

isDesignate

public boolean isDesignate()

Returns:

Whether value is designated

setDesignate

public void setDesignate(boolean designate)

Parameters:

designate - Whether value is designated

isEncoded

public boolean isEncoded()

Returns:

Whether value is Base64-encoded

setEncoded

public void setEncoded(boolean encoded)

Parameters:

encoded - Whether value is Base64-encoded

getOwnerName

public java.lang.String getOwnerName()

Returns:

Owner Name (model or feature name)

setOwnerName

public void setOwnerName(java.lang.String ownerName)

Parameters:

ownerName - Owner Name (model or feature name)

getOwnerType

public java.lang.String getOwnerType()

Returns:

Owner type (if owner is a feature)

setOwnerType

public void setOwnerType(java.lang.String ownerType)

Parameters:

ownerType - Owner type (if owner is a feature)

getOwnerId

public int getOwnerId()

Returns:

Owner ID (if owner is a feature)

setOwnerId

public void setOwnerId(int ownerId)

Parameters:

ownerId - Owner ID (if owner is a feature)

getSetDesignate

public int getSetDesignate()

Returns:

Whether value's designated status should be changed; IJLParameter.DESIGNATE_ON,IJLParameter.DESIGNATE_OFF, IJLParameter.DESIGNATE_UNKNOWN

See Also:

IJLParameter

setSetDesignate

public void setSetDesignate(int setDesignate)

Parameters:

setDesignate - Whether value's designated status should be changed; IJLParameter.DESIGNATE_ON,IJLParameter.DESIGNATE_OFF, IJLParameter.DESIGNATE_UNKNOWN

See Also:

IJLParameter

getDescription

public java.lang.String getDescription()

Returns:

The parameter's description

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - The parameter's description