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