Package com.dassault_systemes.ENOVJCESInterfaces.CESJAPIInterface

   
Interface ICESItemSet

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

Framework : ENOJCESInterfaces

Module : CESJAPIInterface

Class Description

public interface ICESItemSet

This is a custom interface that represents a result set obtained on execution of a Search in CES.

A CESItemSet contains an array of CESItems (A CESItem is represented by the custom interface ICESItem).

Field Summary

Constructor Summary

Method Summary
ICESItem getCESItem(int index)
String getValue(int rowIndex, int columnIndex)
String getValue(int rowIndex, ICESViewAttribute viewAttribute)
String getValueByViewAttributeLabel(int rowIndex, String viewAttributeLabel)
String getValueByViewAttributeDBName(int rowIndex, String viewAttributeDBName)
ICESView getView()
int getBatchSize()
void setBatchSize(int batchSize)
int getTotalPageCount()
int getCurrentPageItemCount()
int getCurrentPageNumber()
String getStateID()
String getPageName()
String getComponentName()
boolean hasItems()
String get(String key)
int getTotalItemCount()
ICESItemSet jumpToPage(int iPageNumber)


Field Detail

Constructor Detail

Method Detail

getCESItem

    ICESItem getCESItem(int index)

Returns the CESItem for the specified index.
NOTE: Indices count from 0.

Parameters:
index
The index of the CESItem.
Returns:
The CESItem for the specified index.

getValue

    String getValue(int rowIndex, int columnIndex)

Returns the value for the specified row and column indices.
NOTE: Indices count from 0.

Parameters:
rowIndex
The index of the Row.
columnIndex
The index of the Column.
Returns:
The value for the specified row and column indices.

getValue

    String getValue(int rowIndex, ICESViewAttribute viewAttribute)

Returns the value for the specified row index and CESViewAttribute.
NOTE: Indices count from 0.

Parameters:
rowIndex
The index of the Row.
viewAttribute
The CESViewAttribute that identifies the Column.
Returns:
The value for the specified row index and CESViewAttribute.

getValueByViewAttributeLabel

    String getValueByViewAttributeLabel(int rowIndex, String viewAttributeLabel)

Returns the value for the specified row index and View Attribute Label.
NOTE: Indices count from 0.

Parameters:
rowIndex
The index of the Row.
viewAttributeLabel
The Label of the View Attribute that identifies the Column.
Returns:
The value for the specified row index and View Attribute Label.

getValueByViewAttributeDBName

    String getValueByViewAttributeDBName(int rowIndex, String viewAttributeDBName)

Returns the value for the specified row index and View Attribute DataBase Name.
NOTE: Indices count from 0.

Parameters:
rowIndex
The index of the Row.
viewAttributeDBName
The DataBase Name of the View Attribute that identifies the Column.
Returns:
The value for the specified row index and View Attribute DataBase Name.

getView

    ICESView getView()

Returns the CESView associated with this CESItemSet.

Returns:
The CESView associated with this CESItemSet.

getBatchSize

    int getBatchSize()

Returns the BatchSize of the CESItemSet.

Returns:
BatchSize of the CESItemSet.

setBatchSize

    void setBatchSize(int batchSize)

Sets the BatchSize of the CESItemSet.

Parameters:
batchSize
Specifies the BatchSize of the CESItemSet.

getTotalPageCount

    int getTotalPageCount()

Returns the total number of pages (for the current batchsize) obtained on executing a Search with the current query criteria.

Returns:
The total number of pages (for the current batchsize) obtained on executing a Search with the current query criteria.

getCurrentPageItemCount

    int getCurrentPageItemCount()

Returns the total number of CESItems in the current page.

Returns:
The total number of CESItems in the current page.

getCurrentPageNumber

    int getCurrentPageNumber()

Returns the Current Page Number.

Returns:
The Current Page Number.

getStateID

    String getStateID()

Returns the StateID of the CESItemSet.

Returns:
StateID of the CESItemSet.

getPageName

    String getPageName()

Returns the Page Name of the CESItemSet.

Returns:
Page Name of the CESItemSet.

getComponentName

    String getComponentName()

Returns the Component Name of the CESItemSet.

Returns:
Component Name of the CESItemSet.

hasItems

    boolean hasItems()

Determines if the CESItemSet has any CESItems.

Returns:
true, if the CESItemSet has atleast one CESItem; false, if CESItemSet is empty.

get

    String get(String key)

Returns the value to which the specified key is mapped, for this CESItemSet. Keys represent certain attributes of the CESItemSet (like "startindex", "endindex", "hasnext" etc.).

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

getTotalItemCount

    int getTotalItemCount()

Returns the total number of items in the database that match the current query criteria.

Returns:
The total number of items in the database that match the current query criteria.

jumpToPage

    ICESItemSet jumpToPage(int iPageNumber)

Returns the Results page (CESItemSet) for the specified Page Number.
NOTE: Page Number of the first page is 1.

Parameters:
iPageNumber
Specifies the pageNumber of the page to be returned
Returns:
The Results page (CESItemSet) for the specified Page Number.


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