Package com.dassault_systemes.ENOVJCESInterfaces.CESJAPIInterface

   
Interface ICESViewAttributeList

 
Class Hierarchy
com.dassault_systemes.ENOVJCESInterfaces.CESJAPIInterface.ICESViewAttributeList
Class Location

Framework : ENOJCESInterfaces

Module : CESJAPIInterface

Class Description

public interface ICESViewAttributeList

This is a custom interface that represents a List of View Attributes in CES.

Since:
R18 SP1
Author:
PTP
Author:
OIN
Version:
R18, 12/01/2007
Field Summary

Constructor Summary

Method Summary
public ICESViewAttribute getCESViewAttributeByAliasName(String aliasName)
Returns the View Attribute for the specified View Attribute Alias Name in this ViewAttributeList.
public ICESViewAttribute getCESViewAttributeByDBName(String viewAttributeDBName)
Returns the View Attribute for the specified View Attribute Database Name in this ViewAttributeList.
public ICESViewAttribute getCESViewAttributeByIndex(int index)
Returns the View Attribute at the specified index in this ViewAttributeList.
public ICESViewAttribute getCESViewAttributeByLabel(String viewAttributeLabel)
Returns the View Attribute for the specified View Attribute Label in this ViewAttributeList.
public ICESViewAttribute getCESViewAttributeBySearchFieldName(String viewAttributeSearchFieldName)
Returns the View Attribute for the specified View Attribute SearchField Name in this ViewAttributeList.
public int getIndexOfCESViewAttribute(ICESViewAttribute viewAttr)
Returns the Index of the View Attribute in this List.
public int getIndexOfCESViewAttributeByDBName(String viewAttrDBName)
Returns the Index of the View Attribute in this List given the View Attribute Databse Name.
public int getIndexOfCESViewAttributeByLabel(String viewAttrLabel)
Returns the Index of the View Attribute in this List given the View Attribute Label.
public int getViewAttributeListSize()
Returns the number of View Attributes in this ViewAttributeList.
public ICESViewAttribute[] getViewAttributes()
Returns an array of CESViewAttributes in this CESViewAttributeList.


Field Detail

Constructor Detail

Method Detail

getCESViewAttributeByAliasName

    public ICESViewAttribute getCESViewAttributeByAliasName(String aliasName)

Returns the View Attribute for the specified View Attribute Alias Name in this ViewAttributeList.

Parameters:
aliasName
The Alias Name of the View Attribute.
Return:
CESViewAttribute for the specified View Attribute Alias Name.

getCESViewAttributeByDBName

    public ICESViewAttribute getCESViewAttributeByDBName(String viewAttributeDBName)

Returns the View Attribute for the specified View Attribute Database Name in this ViewAttributeList.

Parameters:
viewAttributeDBName
The Database Name of the View Attribute.
Return:
CESViewAttribute for the specified View Attribute Database Name.

getCESViewAttributeByIndex

    public ICESViewAttribute getCESViewAttributeByIndex(int index)

Returns the View Attribute at the specified index in this ViewAttributeList. NOTE: Indices count from 0.

Parameters:
index
The index of the View Attribute.
Return:
View Attribute at the specified index.

getCESViewAttributeByLabel

    public ICESViewAttribute getCESViewAttributeByLabel(String viewAttributeLabel)

Returns the View Attribute for the specified View Attribute Label in this ViewAttributeList.

Parameters:
viewAttributeLabel
The Label of the View Attribute.
Return:
CESViewAttribute for the specified View Attribute Label.

getCESViewAttributeBySearchFieldName

    public ICESViewAttribute getCESViewAttributeBySearchFieldName(String viewAttributeSearchFieldName)

Returns the View Attribute for the specified View Attribute SearchField Name in this ViewAttributeList.

Parameters:
viewAttributeSearchFieldName
The SearchField Name of the View Attribute.
Return:
CESViewAttribute for the specified View Attribute SearchField Name.

getIndexOfCESViewAttribute

    public int getIndexOfCESViewAttribute(ICESViewAttribute viewAttr)

Returns the Index of the View Attribute in this List. The view attributes are listed in the same order in this List as in the corresponding View. NOTE: Indices count from 0.

Parameters:
viewAttr
The View Attribute.
Return:
Index of the View Attribute in this Attribute List (same as the Index of the View Attribute in the corresponding View).

getIndexOfCESViewAttributeByDBName

    public int getIndexOfCESViewAttributeByDBName(String viewAttrDBName)

Returns the Index of the View Attribute in this List given the View Attribute Databse Name. The view attributes are listed in the same order in this List as in the corresponding View. NOTE: Indices count from 0.

Parameters:
viewAttrDBName
The Databse Name of the View Attribute.
Return:
Index of the View Attribute in this Attribute List (same as the Index of the View Attribute in the corresponding View).

getIndexOfCESViewAttributeByLabel

    public int getIndexOfCESViewAttributeByLabel(String viewAttrLabel)

Returns the Index of the View Attribute in this List given the View Attribute Label. The view attributes are listed in the same order in this List as in the corresponding View. NOTE: Indices count from 0.

Parameters:
viewAttrLabel
The Label of the View Attribute.
Return:
Index of the View Attribute in this Attribute List (same as the Index of the View Attribute in the corresponding View).

getViewAttributeListSize

    public int getViewAttributeListSize()

Returns the number of View Attributes in this ViewAttributeList.

Return:
The number of View Attributes in this ViewAttributeList.

getViewAttributes

    public ICESViewAttribute[] getViewAttributes()

Returns an array of CESViewAttributes in this CESViewAttributeList.

Return:
Array of all CESViewAttributes in this CESViewAttributeList.


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