|
|
|||||
| 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 |
| 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 |
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.).
String
public int getBatchSize()
Returns the BatchSize of the CESItemSet.
public ICESItem getCESItem(int index)
Returns the CESItem for the specified index.
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.
rowIndexviewAttribute
public String getValue(int rowIndex, int columnIndex)
Returns the value for the specified row and column indices.
rowIndexcolumnIndex
public String getValueByViewAttributeDBName(int rowIndex, String viewAttributeDBName)
Returns the value for the specified row index and View Attribute DataBase Name.
rowIndexviewAttributeDBName
public String getValueByViewAttributeLabel(int rowIndex, String viewAttributeLabel)
Returns the value for the specified row index and View Attribute Label.
rowIndexviewAttributeLabel
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.
iPageNumber
public void setBatchSize(int batchSize)
Sets the BatchSize of the CESItemSet.
batchSize