Package com.dassault_systemes.vpmdesktop.vdk0interfaces.interfaces

   
Interface ENOVIObject

 
Class Hierarchy
com.dassault_systemes.vpmdesktop.vdk0interfaces.interfaces.ENOVIObject
Class Location

Framework : VPMDesktop

Module : VDK0Interfaces

Class Description

public interface ENOVIObject

Interface representing a generic client object.

An implementation of this interface is supplied and you must use it as is. You should not reimplement it.

Field Summary

Constructor Summary

Method Summary
ENOVIType getType()
String getBaseType()
String getName()
Object getInternalValue(String sAttrName)
Object getInternalValue(String sAttrName, String sBaseType)
Object getInternalValue(ENOVIAttribute oAttrDesc)
String getInternalStringValue(String sAttrName)
String getInternalStringValue(String sAttrName, String sBaseType)
String getInternalStringValue(ENOVIAttribute oAttrDesc)
String[] getInternalStringArrayValue(String sAttrName)
String[] getInternalStringArrayValue(String sAttrName, String sBaseType)
String[] getInternalStringArrayValue(ENOVIAttribute oAttrDesc)
String getExternalStringValue(String sAttrName)
String getExternalStringValue(String sAttrName, String sBaseType)
String getExternalStringValue(ENOVIAttribute oAttrDesc)
String[] getExternalStringArrayValue(String sAttrName)
String[] getExternalStringArrayValue(String sAttrName, String sBaseType)
String[] getExternalStringArrayValue(ENOVIAttribute oAttrDesc)
byte[] getUUID()
ENOVTypeMask getMask()
int getLevel()


Field Detail

Constructor Detail

Method Detail

getType

    ENOVIType getType()

Gets the type definition associated to this Object.

Returns:
the object type interface ENOVIType.

getBaseType

    String getBaseType()

Gets the base type.
If there is more than one base type, it returns the type name associated to this object otherwise it returns base type.

Example 1: Part instance that contains 3 base types(Part Master, Part version Item Instance).
returns : VPMBOPartInstance.

Example 2: Action Design that contains one base type.
returns : ENOVIA_AFLAction.

Returns:
the base type.

getName

    String getName()

Gets the name associated to this object.

Returns:
the object name.

getInternalValue

    Object getInternalValue(String sAttrName)

Returns the value for an attribute without translation to external value. If there is more than one attribute with this name, the last occurrence will be returned.

Parameters:
sAttrName
the attribute name.
Returns:
the attribute value.

getInternalValue

    Object getInternalValue(String sAttrName, String sBaseType)

Returns the value for an attribute without translation to external value.

Parameters:
sAttrName
the attribute name.
sBaseType
the base type. Example : ENOVIA_VPMItemInstance.
Returns:
the attribute value.

getInternalValue

    Object getInternalValue(ENOVIAttribute oAttrDesc)

Returns the value for an attribute without translation to external value.

Parameters:
oAttrDesc
the attribute definition.
Returns:
the attribute value.

getInternalStringValue

    String getInternalStringValue(String sAttrName)

Returns the string value for an attribute without translation to external value. If there is more than one attribute with this name, the last occurrence will be returned. Do not use this method for list type attribute instead use getInternalStringArrayValue method.

Parameters:
sAttrName
the attribute name.
Returns:
the attribute value.

getInternalStringValue

    String getInternalStringValue(String sAttrName, String sBaseType)

Returns the string value for an attribute without translation to external value. Do not use this method for list type attribute instead use getInternalStringArrayValue method.

Parameters:
sAttrName
the attribute name.
sBaseType
the base type. Example : ENOVIA_VPMItemInstance.
Returns:
the attribute value.

getInternalStringValue

    String getInternalStringValue(ENOVIAttribute oAttrDesc)

Returns the string value for an attribute without translation to external value. Do not use this method for list type attribute instead use getInternalStringArrayValue method.

Parameters:
oAttrDesc
the attribute definition.
Returns:
the attribute value.

getInternalStringArrayValue

    String[] getInternalStringArrayValue(String sAttrName)

Returns the list of values for a list type attribute without translation to external value. If there is more than one attribute with this name, the last occurrence will be returned.

Parameters:
sAttrName
the attribute name.
Returns:
the attribute value.

getInternalStringArrayValue

    String[] getInternalStringArrayValue(String sAttrName, String sBaseType)

Returns the list of values for a list type attribute without translation to external value.

Parameters:
sAttrName
the attribute name.
sBaseType
the base type. Example : ENOVIA_VPMItemInstance.
Returns:
the attribute value.

getInternalStringArrayValue

    String[] getInternalStringArrayValue(ENOVIAttribute oAttrDesc)

Returns the list of values for a list type attribute without translation to external value.

Parameters:
oAttrDesc
the attribute definition.
Returns:
the attribute value.

getExternalStringValue

    String getExternalStringValue(String sAttrName)

Returns the value for an attribute after translation to external value. If there is more than one attribute with this name, the last occurrence will be returned. Do not use this method for list type attribute instead use getExternalStringArrayValue method.

Parameters:
sAttrName
the attribute name.
Returns:
the attribute value.

getExternalStringValue

    String getExternalStringValue(String sAttrName, String sBaseType)

Returns the value for an attribute after translation to external value. Do not use this method for list type attribute instead use getExternalStringArrayValue method.

Parameters:
sAttrName
the attribute name.
sBaseType
the base type. Example : ENOVIA_VPMItemInstance.
Returns:
the attribute value.

getExternalStringValue

    String getExternalStringValue(ENOVIAttribute oAttrDesc)

Returns the value for an attribute after translation to external value. Do not use this method for list type attribute instead use getExternalStringArrayValue method.

Parameters:
oAttrDesc
the attribute definition.
Returns:
the attribute value.

getExternalStringArrayValue

    String[] getExternalStringArrayValue(String sAttrName)

Returns the list of values for a list type attribute after translation to external values. If there is more than one attribute with this name, the last occurrence will be returned.

Parameters:
sAttrName
the attribute name.
Returns:
the attribute value.

getExternalStringArrayValue

    String[] getExternalStringArrayValue(String sAttrName, String sBaseType)

Returns the list of values for a list type attribute after translation to external value.

Parameters:
sAttrName
the attribute name.
sBaseType
the base type. Example : ENOVIA_VPMItemInstance.
Returns:
the attribute value.

getExternalStringArrayValue

    String[] getExternalStringArrayValue(ENOVIAttribute oAttrDesc)

Returns the list of values for a list type attribute after translation to external value.

Parameters:
oAttrDesc
the attribute definition.
Returns:
the attribute value.

getUUID

    byte[] getUUID()

Get the UUID of this object.

Returns:
the UUID in byte array.

getMask

    ENOVTypeMask getMask()

Gets the mask.

Returns:
the mask.

getLevel

    int getLevel()

Gets the level. This method is applicable only if this object is a result of an expand function.



Copyright © 2000, Dassault Systèmes. All rights reserved