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.

Since:
V5R11
Field Summary

Constructor Summary

Method Summary
public String getAlias()
Gets the alias of the attribute.
public short getDBLength()
Gets the Database length of the attribute
public String[] GetExternalAuthorizedValues()
Gets the authorized values affected to the attribute after translation to the external values.
public String getExternalDefaultValue()
Gets the default string value of this attribute, after translation to external value.
public String[] getExternalDefaultValues()
Gets the default values for a list type attribute, after translation to external values.
public String[] GetExternalHelpValues()
Gets the list of help values for this attribute after translation to external values.
public String[] GetInternalAuthorizedValues()
Gets the authorized values affected to the attribute before translation.
public Object getInternalDefaultValue()
Gets the default value of this attribute before translation to external value.
public Object[] getInternalDefaultValues()
Gets the default values for a list type attribute, before translation to external values.
public String[] GetInternalHelpValues()
Gets the list of help values for this attribute before translation to external values.
public short getLength()
Gets the actual length of the attribute (relevant if string type).
public short getLetterCase()
Gets the case of the attribute.
public String getName()
Gets the name of the attribute
public String getObjectTypeOwner()
Returns the base type of the object owning this attribute
public int getOrder()
Returns the order of this attribute.
public boolean isBinary()
Returns true if the attribute type is Binary (UUID) otherwise returns false
public boolean isBoolean()
Returns true if the attribute type is Boolean otherwise returns false
public boolean isDate()
Returns true if the attribute type is Date otherwise returns false
public boolean isEntity()
Returns true if the attribute type is an entity otherwise returns false
public boolean isEnum()
Returns true if the attribute type is an Enum otherwise returns false
public boolean isFloat()
Returns true if the attribute type is Float otherwise returns false
public boolean isInteger()
Returns true if the attribute type is an Integer otherwise returns false
public boolean isList()
Returns true if the attribute type is a list otherwise returns false
public boolean isRequired()
Returns true if the attribute is Mandatory otherwise returns false
public boolean isSensible()
Gets the sensible facet of the attribute.
public boolean isString()
Returns true if the attribute type is string otherwise returns false
public boolean isUpdatable()
Gets the read / write facet of the attribute.
public boolean isVisible()
Returns true if the attribute is visible otherwise returns false


Field Detail

Constructor Detail

Method Detail

getAlias

    public String getAlias()

Gets the alias of the attribute.


getDBLength

    public short getDBLength()

Gets the Database length of the attribute


GetExternalAuthorizedValues

    public 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.


getExternalDefaultValue

    public 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

    public String[] getExternalDefaultValues()

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


GetExternalHelpValues

    public 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.


GetInternalAuthorizedValues

    public 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.


getInternalDefaultValue

    public 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

    public Object[] getInternalDefaultValues()

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


GetInternalHelpValues

    public 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.


getLength

    public short getLength()

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


getLetterCase

    public short getLetterCase()

Gets the case of the attribute.

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

getName

    public String getName()

Gets the name of the attribute


getObjectTypeOwner

    public String getObjectTypeOwner()

Returns the base type of the object owning this attribute


getOrder

    public int getOrder()

Returns the order of this attribute.


isBinary

    public boolean isBinary()

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


isBoolean

    public boolean isBoolean()

Returns true if the attribute type is Boolean otherwise returns false


isDate

    public boolean isDate()

Returns true if the attribute type is Date otherwise returns false


isEntity

    public boolean isEntity()

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


isEnum

    public boolean isEnum()

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


isFloat

    public boolean isFloat()

Returns true if the attribute type is Float otherwise returns false


isInteger

    public boolean isInteger()

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


isList

    public boolean isList()

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


isRequired

    public boolean isRequired()

Returns true if the attribute is Mandatory otherwise returns false


isSensible

    public 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.


isString

    public boolean isString()

Returns true if the attribute type is string otherwise returns false


isUpdatable

    public boolean isUpdatable()

Gets the read / write facet of the attribute.


isVisible

    public boolean isVisible()

Returns true if the attribute is visible otherwise returns false



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