Package com.dassault_systemes.vpmdesktop.vdk0interfaces.interfaces

   
Interface ENOVIAttribute

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

Framework : VPMDesktop

Module : VDK0Interfaces

Class Description

public interface ENOVIAttribute

Interface representing the attribute definition.

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

Field Summary

Constructor Summary

Method Summary
String getName()
String getAlias()
short getDBLength()
short getLength()
String getObjectTypeOwner()
boolean isRequired()
boolean isUpdatable()
boolean isVisible()
boolean isSensible()
String[] GetExternalAuthorizedValues()
String[] GetInternalAuthorizedValues()
String[] GetExternalHelpValues()
String[] GetInternalHelpValues()
short getLetterCase()
boolean isString()
boolean isList()
boolean isInteger()
boolean isBinary()
boolean isFloat()
boolean isEnum()
boolean isEntity()
boolean isDate()
boolean isBoolean()
int getOrder()
Object getInternalDefaultValue()
Object[] getInternalDefaultValues()
String getExternalDefaultValue()
String[] getExternalDefaultValues()


Field Detail

Constructor Detail

Method Detail

getName

    String getName()

Gets the name of the attribute


getAlias

    String getAlias()

Gets the alias of the attribute.


getDBLength

    short getDBLength()

Gets the Database length of the attribute


getLength

    short getLength()

Gets the actual length of the attribute (relevant if string type).


getObjectTypeOwner

    String getObjectTypeOwner()

Returns the base type of the object owning this attribute


isRequired

    boolean isRequired()

Returns true if the attribute is Mandatory otherwise returns false


isUpdatable

    boolean isUpdatable()

Gets the read / write facet of the attribute.


isVisible

    boolean isVisible()

Returns true if the attribute is visible otherwise returns false


isSensible

    boolean isSensible()

Gets the sensible facet of the attribute. If the attribute is sensible, the user exit will be called every time this attribute looses the focus.


GetExternalAuthorizedValues

    String[] GetExternalAuthorizedValues()

Gets the authorized values affected to the attribute after translation to the external values. If defined, the values of the attribute must be one of the list of authorized values.


GetInternalAuthorizedValues

    String[] GetInternalAuthorizedValues()

Gets the authorized values affected to the attribute before translation. If defined,the values of the attribute must be one of the list of authorized values.


GetExternalHelpValues

    String[] GetExternalHelpValues()

Gets the list of help values for this attribute after translation to external values. If defined, the values of the attribute can be chosen from one of the list of help values.


GetInternalHelpValues

    String[] GetInternalHelpValues()

Gets the list of help values for this attribute before translation to external values. If defined, the values of the attribute can be chosen from one of the list of help values.


getLetterCase

    short getLetterCase()

Gets the case of the attribute.

Returns:
<0 if the attribute is lower case, >0 if the attribute is upper case, =0 if none.

isString

    boolean isString()

Returns true if the attribute type is string otherwise returns false


isList

    boolean isList()

Returns true if the attribute type is a list otherwise returns false


isInteger

    boolean isInteger()

Returns true if the attribute type is an Integer otherwise returns false


isBinary

    boolean isBinary()

Returns true if the attribute type is Binary (UUID) otherwise returns false


isFloat

    boolean isFloat()

Returns true if the attribute type is Float otherwise returns false


isEnum

    boolean isEnum()

Returns true if the attribute type is an Enum otherwise returns false


isEntity

    boolean isEntity()

Returns true if the attribute type is an entity otherwise returns false


isDate

    boolean isDate()

Returns true if the attribute type is Date otherwise returns false


isBoolean

    boolean isBoolean()

Returns true if the attribute type is Boolean otherwise returns false


getOrder

    int getOrder()

Returns the order of this attribute.


getInternalDefaultValue

    Object getInternalDefaultValue()

Gets the default value of this attribute before translation to external value. Do not use this method for a list type attribute instead use getInternalDefaultValues method.


getInternalDefaultValues

    Object[] getInternalDefaultValues()

Gets the default values for a list type attribute, before translation to external values.


getExternalDefaultValue

    String getExternalDefaultValue()

Gets the default string value of this attribute, after translation to external value. Do not use this method for a list type attribute instead use getExternalDefaultValues method.


getExternalDefaultValues

    String[] getExternalDefaultValues()

Gets the default values for a list type attribute, after translation to external values.



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