Package com.dassault_systemes.ENOVJCESInterfaces.CESJAPIInterface

   
Interface ICESCategoryList

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

Framework : ENOJCESInterfaces

Module : CESJAPIInterface

Class Description

public interface ICESCategoryList

This is a custom interface that represents a List of Categories in CES.

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

Constructor Summary

Method Summary
public ICESCategory[] getCategories()
Returns an array of CESCategories in this CategoryList.
public int getCategoryListSize()
Returns the number of Categories in this Category List.
public ICESCategory getCESCategoryByDBName(String categoryDBName)
Returns the Category for the specified Category DataBase name in this Category List.
public ICESCategory getCESCategoryByIndex(int index)
Returns the Category at the specified index in this Category List.
public ICESCategory getCESCategoryByLabel(String categoryLabel)
Returns the Category for the specified Category Label in this Category List.


Field Detail

Constructor Detail

Method Detail

getCategories

    public ICESCategory[] getCategories()

Returns an array of CESCategories in this CategoryList.

Return:
Array of all CESCategories in this CategoryList.

getCategoryListSize

    public int getCategoryListSize()

Returns the number of Categories in this Category List.

Return:
Number of Categories in this Category List.

getCESCategoryByDBName

    public ICESCategory getCESCategoryByDBName(String categoryDBName)

Returns the Category for the specified Category DataBase name in this Category List.

Parameters:
categoryDBName
The DataBase name of the Category.
Return:
Category for the specified Category DataBase name.

getCESCategoryByIndex

    public ICESCategory getCESCategoryByIndex(int index)

Returns the Category at the specified index in this Category List. NOTE: Indices count from 0.

Parameters:
index
The index of the Category.
Return:
Category at the specified index.

getCESCategoryByLabel

    public ICESCategory getCESCategoryByLabel(String categoryLabel)

Returns the Category for the specified Category Label in this Category List.

Parameters:
categoryLabel
The Label of the Category.
Return:
Category for the specified Category Label.


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