Package com.dassault_systemes.ENOVJCESInterfaces.CESJAPIInterface

   
Interface ICESItem

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

Framework : ENOJCESInterfaces

Module : CESJAPIInterface

Class Description

public interface ICESItem

This is a custom interface that represents a row in the results obtained on execution of a Search in CES.

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

Constructor Summary

Method Summary
public String get(String key)
Returns the value to which the specified key is mapped, for this CESItem.
public String getCESItemObjectID()
Returns the ObjectID of this CESItem.
public ArrayList getRowData()
Returns an ArrayList that contains the data in this CESItem.
public String getValue(ICESViewAttribute viewAttribute)
Returns the value under the column for the specified CESViewAttribute.
public String getValue(int columnIndex)
Returns the value under the column for the specified column index.
public String getValueByViewAttributeDBName(String viewAttributeDBName)
Returns the value under the column for the specified View Attribute DataBase Name.
public String getValueByViewAttributeLabel(String viewAttributeLabel)
Returns the value under the column for the specified View Attribute Label.
public ICESView getView()
Returns the CESView associated with this CESItem (the CESView from the parent CESItemSet).
public void setParentItemSet(ICESItemSet itemSet)
Links this CESItem with a (parent)CESItemSet.


Field Detail

Constructor Detail

Method Detail

get

    public String get(String key)

Returns the value to which the specified key is mapped, for this CESItem. Keys represent certain attributes of the CESItem (like "row_id", "obj_id", "markedforedit" etc.).

Parameters:
String
key Specifies the key for which the corresponding value has to be reteived.
Return:
The value to which the specified key is mapped, for this CESItem.

getCESItemObjectID

    public String getCESItemObjectID()

Returns the ObjectID of this CESItem.

Return:
The ObjectID of this CESItem.

getRowData

    public ArrayList getRowData()

Returns an ArrayList that contains the data in this CESItem.

Return:
ArrayList that contains the data in this CESItem.

getValue

    public String getValue(ICESViewAttribute viewAttribute)

Returns the value under the column for the specified CESViewAttribute.
NOTE: Indices count from 0.

Parameters:
viewAttribute
The CESViewAttribute that identifies the Column.
Return:
The value under the column for the specified CESViewAttribute.

getValue

    public String getValue(int columnIndex)

Returns the value under the column for the specified column index.

Parameters:
columnIndex
The index of the Column.
Return:
The value under the column for the specified column index.

getValueByViewAttributeDBName

    public String getValueByViewAttributeDBName(String viewAttributeDBName)

Returns the value under the column for the specified View Attribute DataBase Name.

Parameters:
viewAttributeDBName
The DataBase Name of the View Attribute that identifies the Column.
Return:
The value under the column for the specified View Attribute DataBase Name.

getValueByViewAttributeLabel

    public String getValueByViewAttributeLabel(String viewAttributeLabel)

Returns the value under the column for the specified View Attribute Label.

Parameters:
viewAttributeLabel
The Label of the View Attribute that identifies the Column.
Return:
The value under the column for the specified View Attribute Label.

getView

    public ICESView getView()

Returns the CESView associated with this CESItem (the CESView from the parent CESItemSet).

Return:
The CESView associated with this CESItem (the CESView from the parent CESItemSet).

setParentItemSet

    public void setParentItemSet(ICESItemSet itemSet)

Links this CESItem with a (parent)CESItemSet.

Parameters:
itemSet
Parent CESItemSet.


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