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

Since:
R18
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 CESItemSet.
public int getBatchSize()
Returns the BatchSize of the CESItemSet.
public ICESItem getCESItem(int index)
Returns the CESItem for the specified index.
public String getComponentName()
Returns the Component Name of the CESItemSet.
public int getCurrentPageItemCount()
Returns the total number of CESItems in the current page.
public int getCurrentPageNumber()
Returns the Current Page Number.
public String getPageName()
Returns the Page Name of the CESItemSet.
public String getStateID()
Returns the StateID of the CESItemSet.
public int getTotalItemCount()
Returns the total number of items in the database that match the current query criteria.
public int getTotalPageCount()
Returns the total number of pages (for the current batchsize) obtained on executing a Search with the current query criteria.
public String getValue(int rowIndex, ICESViewAttribute viewAttribute)
Returns the value for the specified row index and CESViewAttribute.
public String getValue(int rowIndex, int columnIndex)
Returns the value for the specified row and column indices.
public String getValueByViewAttributeDBName(int rowIndex, String viewAttributeDBName)
Returns the value for the specified row index and View Attribute DataBase Name.
public String getValueByViewAttributeLabel(int rowIndex, String viewAttributeLabel)
Returns the value for the specified row index and View Attribute Label.
public ICESView getView()
Returns the CESView associated with this CESItemSet.
public boolean hasItems()
Determines if the CESItemSet has any CESItems.
public ICESItemSet jumpToPage(int iPageNumber)
Returns the Results page (CESItemSet) for the specified Page Number.
public void setBatchSize(int batchSize)
Sets the BatchSize of the 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 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.
Return:
The value to which the specified key is mapped, for this CESItemSet.

getBatchSize

    public int getBatchSize()

Returns the BatchSize of the CESItemSet.

Return:
BatchSize of the CESItemSet.

getCESItem

    public ICESItem getCESItem(int index)

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

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

getComponentName

    public String getComponentName()

Returns the Component Name of the CESItemSet.

Return:
Component Name of the CESItemSet.

getCurrentPageItemCount

    public int getCurrentPageItemCount()

Returns the total number of CESItems in the current page.

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

getCurrentPageNumber

    public int getCurrentPageNumber()

Returns the Current Page Number.

Return:
The Current Page Number.

getPageName

    public String getPageName()

Returns the Page Name of the CESItemSet.

Return:
Page Name of the CESItemSet.

getStateID

    public String getStateID()

Returns the StateID of the CESItemSet.

Return:
StateID of the CESItemSet.

getTotalItemCount

    public int getTotalItemCount()

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

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

getTotalPageCount

    public int getTotalPageCount()

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

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

getValue

    public 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.
Return:
The value for the specified row index and CESViewAttribute.

getValue

    public 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.
Return:
The value for the specified row and column indices.

getValueByViewAttributeDBName

    public 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.
Return:
The value for the specified row index and View Attribute DataBase Name.

getValueByViewAttributeLabel

    public 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.
Return:
The value for the specified row index and View Attribute Label.

getView

    public ICESView getView()

Returns the CESView associated with this CESItemSet.

Return:
The CESView associated with this CESItemSet.

hasItems

    public boolean hasItems()

Determines if the CESItemSet has any CESItems.

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

jumpToPage

    public 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
Return:
The Results page (CESItemSet) for the specified Page Number.

setBatchSize

    public void setBatchSize(int batchSize)

Sets the BatchSize of the CESItemSet.

Parameters:
batchSize
Specifies the BatchSize of the CESItemSet.


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