Package com.dassault_systemes.catweb.databackend.dataType

   
Class PEAttribute

 
Class Hierarchy
java.lang.Object
  |
  +-com.dassault_systemes.catweb.databackend.dataType.PEAttribute
Class Location

Framework : CATJDataAccessBasicModel

Module : PLAdatabackend

Class Description

public class PEAttribute

Class representing an attribute of a PEType. For example if a type "car" is defined, this type could have the attribute "version", "color" and "number of door".

Field Summary
int FORMAT_STRING
int FORMAT_INT
int FORMAT_DATE

Constructor Summary
PEAttribute(String iName, String iAlias, PEType iType, int iFormat)

Method Summary
void setName(String iName)
String getName()
void setAlias(String iAllias)
String getAlias()
void setType(PEType iType)
PEType getType()
void setformatValue(int iFormat)
int getformatValue()
void setOperators(String[] iOperators)
String[] getOperators()
void setHelpValues(String[] iHelpValues)
String[] getHelpValues()
void setAuthorizedValues(String[] iAuthorizedValues)
String[] getAuthorizedValues()
void setTreeVisibility(int iTreeVisibility)
int getTreeVisibility()


Field Detail

FORMAT_STRING

    int FORMAT_STRING


FORMAT_INT

    int FORMAT_INT


FORMAT_DATE

    int FORMAT_DATE


Constructor Detail

PEAttribute

    PEAttribute(String iName, String iAlias, PEType iType, int iFormat)

Constructs the attribute of a PELeaf.

Parameters:
iName
The String Object representing the unique identifier of the PEAttribute.
iAlias
The String Object representing the name of the attribute for the user.
iType
The PEType to which the PEAttribute is tied.
iFormat
The format of the attribute : 0, 1, 2, ... corresponding to String, int, ... for now, the only solution is 0, the attribute is a String.

Method Detail

setName

    void setName(String iName)

Sets the unique identifier of the PEAttribute.

Parameters:
iName
The String Object representing the unique identifier of the PEAttribute.

getName

    String getName()

Returns a String Object representing the unique identifier of the PEAttribute.


setAlias

    void setAlias(String iAllias)

Sets the name of the PEAttribute for the user.

Parameters:
iAlias
The String Object representing the name of the PEAttribute for the user.

getAlias

    String getAlias()

Returns a String Object representing the name of the PEAttribute for the user.


setType

    void setType(PEType iType)

Sets the type to which the PEAttribute is tied.

Parameters:
iType
The PEType Object to which the PEAttribute is tied.

getType

    PEType getType()

Returns the PEType Object to which the PEAttribute is tied.


setformatValue

    void setformatValue(int iFormat)

Sets the format (String, integer, ... ) of the PEAttribute.

Parameters:
iFormat
The int Object 0, corresponding to a java.lang.String is the only available format in the curent code version.
See Also:
FORMAT_STRING
FORMAT_INT

getformatValue

    int getformatValue()

Returns the format (String, integer, ... ) of the PEAttribute. The int Object 0, corresponding to a java.lang.String is the only available format in the curent code version.

See Also:
FORMAT_STRING
FORMAT_INT

setOperators

    void setOperators(String[] iOperators)

Sets the operators that can be applied on the PEAttribute during an Extended Query. If no operator is specified, the PEAttribute can not be used in the Extended Query.

Parameters:
iOperators
An array of String, containing the operators that can be applied to this PEAttribute if an Extended Query is performed.

getOperators

    String[] getOperators()

Returns an array of String, containing the operators that can be applied to this PEAttribute if an Extended Query is performed.


setHelpValues

    void setHelpValues(String[] iHelpValues)

Sets the operand proposed for matching with the PEAttribute during an Extended Query. The operand value are options, the user could add his own values in the Extended Query.

Parameters:
iHelpValues
An array of String, containing the operand values, proposed for matching with the PEAttribute if an Extended Query is performed.

getHelpValues

    String[] getHelpValues()

Returns an array of String, containing the operand values, proposed for matching with the PEAttribute if an Extended Query is performed.


setAuthorizedValues

    void setAuthorizedValues(String[] iAuthorizedValues)

Sets the values that the operand can have during an Extended Query. If HelpValues and AuthorizedValues are specified, AuthorizedValues are prioritary.

Parameters:
iAuthorizedValues
An array of String, containing the mandatory operand, for the Extended Query.

getAuthorizedValues

    String[] getAuthorizedValues()

Returns the values that the operand can have if an Extended Query is performed.


setTreeVisibility

    void setTreeVisibility(int iTreeVisibility)

Tells what is the visibility of the PEAttribute. The name of a node in the Portal Product Explorer is defined by the concatenation of the value of all visible PEAttribute of this node.

Parameters:
iTreeVisibility
If iTreeVisibility equals 0 the attribute isn't visible.
If iTreeVisibility is bigger than 0, the attribute is visible, iTreeVisibility indicates the position in the visible name.

getTreeVisibility

    int getTreeVisibility()

Returns an integer indicating the visibility of the PEAttribute in the Portal Product Explorer.

Returns:
If the reterned int equals 0 the attribute isn't visible.
If the reterned int is bigger than 0, the attribute is visible, the int indicates the position in the visible name.


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