Package com.dassault_systemes.ENOVJCESInterfaces.CESJAPIInterface

   
Interface ICESPartSelection

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

Framework : ENOJCESInterfaces

Module : CESJAPIInterface

Class Description

public interface ICESPartSelection

This Interface provides methods to Search for and retrieve Parts information from the CES Database.

Collaborative Enterprise Sourcing (CES) provides an Enterprise-wide Sourcing Catalog for items that may be used in a product design/lifecycle.

The catalog repository in CES is structured in a hierarchical manner such that common attributes of the item is captured at the top level and more specific attributes are captured in the subsequent levels. Each catalog grouping in CES is called as Category. A set of Attributes are defined for each category. A subcategory can inherit attributes from parent category and also define its own set of attributes. Attributes in a category are grouped under a View (a.k.a. Form). Forms can be created/modified to contain attributes that the User would use to search for and view Items in CES. Interestingly, cross-category forms can be created by pulling in attributes from other categories.

Following are the steps involved in executing a CES Search:
1. Select a Category on which Search is required to be performed.
2. Select a View (Form) defined on the selected Category.
3. Set Search Criteria against the Form Attributes.
4. Execute the Search.
The result of a CES search is a CESItemSet. CESItemSet is also driven by user/system defined forms. Each result form can have its own set of attributes which belong to the base category (the category on which the form is defined) or related categories. Search and Result forms need not have same set of attributes but can have the same name. They are distinguished by the type of the form (Search/Result) in a category.

Each Item used internally in a company may or may not have a PLM Item associated with it. By performing a Search in CES catalog, user will be able to pick an Internal Item and perform the following PLM Functions :
1. Load PLM Item
2. Instantiate in a product structure
3. Compare Geometry of two PLM Items
4. View PLM properties
5. View Where used details
6. Preview the PLM Item
7. Load / View attachments of PLM Item

This Interface provides methods to perform the following CES Searches:
1. Standard Search (a.k.a. Parametric Search) : Standard Search is based on the attributes of a CES Category.
2. Simple Search (a.k.a. Keyword Search) : Simple Search is based on attributes that are defined as Context Searchable in the CES Search View.
3. PLM Item Search : This performs a Search on the PLM Item ID attribute. Given a list of PLM Items IDs, it returns the corresponding CES Items.

NOTE:
1. The terms "Form" and "View", "Item" and "Part", "Attribute" and "Property", "Category" and "Class" can be used interchangeably.
2. CESSearchType specifies the type of Search.
Valid values: STANDARD_SEARCH, SIMPLE_SEARCH
3. CESSearchItemType specifies the type of Item.
Valid values: MANUFACTURER_ITEM, SUPPLIER_ITEM, INTERNAL_ITEM
4. CESSearchProjectOption specifies the project and revision option to use while performing a search.
Valid values: CURRENT_PROJECT_CURRENT_REVISION, CURRENT_PROJECT_ALL_REVISION, ALL_PROJECT_CURRENT_REVISION, ALL_PROJECT_ALL_REVISION, ALL_APPROVED_PROJECTS_CURRENT_REVISION, ALL_APPROVED_PROJECTS_ALL_REVISION

Field Summary

Constructor Summary

Method Summary
ICESCategoryList getCategoryList(String iCategoryCriteria)
ICESViewList getSearchViewList(ICESCategory iCategory, CESSearchItemType iItemType, CESSearchType iSearchType)
ICESViewAttributeList getCESViewAttributeList(ICESView iCESView, CESViewType iViewType)
ICESItemSet getSimpleSearchResults(CESSearchItemType iItemType, ICESView iCESView, CESSearchProjectOption iProjectOption, String iSimpleSearchCriteria, int iBatchSize, String currentUserProject)
ICESItemSet getStandardSearchResults(CESSearchItemType iItemType, ICESView iCESView, CESSearchProjectOption iProjectOption, ICESViewAttributeList iCESViewAttributeList, int iBatchSize, String currentUserProject)
ICESItemSet getPLMItemSearchResults(ICESView iCESView, CESSearchProjectOption iProjectOption, String[] iPlMItemIDs, int iBatchSize, String currentUserProject)
int getTotalItemCount(ICESItemSet itemSet)
ICESItemSet jumpToPage(ICESItemSet itemSet, int iPageNumber)


Field Detail

Constructor Detail

Method Detail

getCategoryList

    ICESCategoryList getCategoryList(String iCategoryCriteria)

Fetches the list of Categories matching the search criteria.

Parameters:
iCategoryCriteria
Specifies the criteria used to search for categories. This does an implicit wild card search using the criteria. For example, "Supp" criteria will return "Supplemental Information".
Returns:
CES Custom Interface with methods to retrieve the list of Categories that match the criteria.

getSearchViewList

    ICESViewList getSearchViewList(ICESCategory iCategory, CESSearchItemType iItemType, CESSearchType iSearchType)

Fetches the list of Views defined on the specified Category, given the CESSearchItemType and CESSearchType.

Parameters:
iCategory
Specifies the Category from which the Views are retrieved.
iItemType
Specifies the type of the Item to Search. Refer Class Description for more information.
iSearchType
Specifies the type of the Search. SearchType can be STANDARD_SEARCH or SIMPLE_SEARCH.
Returns:
CES Custom Interface with methods to retrieve 'View' information.

getCESViewAttributeList

    ICESViewAttributeList getCESViewAttributeList(ICESView iCESView, CESViewType iViewType)

Returns the List of Attributes for a given CES View and View Type.

Parameters:
iCESView
ICESView
iViewType
View Type
Returns:
List of Attributes defined in the CES View for the given View Type.

getSimpleSearchResults

    ICESItemSet getSimpleSearchResults(CESSearchItemType iItemType, ICESView iCESView, CESSearchProjectOption iProjectOption, String iSimpleSearchCriteria, int iBatchSize, String currentUserProject)

Performs CES Simple Search. Simple Search is based on the attributes in a View that are defined as context searchable in the CES Search View.

Parameters:
iItemType
Specifies the type of the Item to Search. Refer Class Description for more information.
iCESView
Specifies the CES Custom Object that represents the Selected Form/View For Performing Search.
iProjectOption
Specifies the the project and revision option to use while performing the search. Refer Class Description for more information.
iSimpleSearchCriteria
Specifies the search criteria to perform the Search.
iBatchSize
Specifies the maximum number of items fetched in any call to this method.
currentUserProject
Specifies the current workbench's Project name.
Returns:
CES Custom Interface with methods to retrieve results data and attributes.

getStandardSearchResults

    ICESItemSet getStandardSearchResults(CESSearchItemType iItemType, ICESView iCESView, CESSearchProjectOption iProjectOption, ICESViewAttributeList iCESViewAttributeList, int iBatchSize, String currentUserProject)

Performs CES Standard Search. Standard Search is based on parametric criteria set on attributes in a View that belong to a selected Category.

Parameters:
iItemType
Specifies the type of the Item to Search. Refer Class Description for more information.
iCESView
Specifies the CES Custom Object that represents the Selected Form/View For Performing Search.
iProjectOption
Specifies the the project and revision option to use while performing the search. Refer Class Description for more information.
iCESViewAttributeList
Specifies the CES Custom Object that represents the Search View Attributes loaded with the actual search criteria to perform the Parametric/Standard search.
iBatchSize
Specifies the maximum number of items fetched in any call to this method.
currentUserProject
Specifies the current workbench's Project name.
Returns:
CES Custom Interface with methods to retrieve results data and attributes.

getPLMItemSearchResults

    ICESItemSet getPLMItemSearchResults(ICESView iCESView, CESSearchProjectOption iProjectOption, String[] iPlMItemIDs, int iBatchSize, String currentUserProject)

Performs CES Standard Search on PLM Item ID Attribute

Parameters:
iCESView
Specifies the CES Custom Object that represents the Selected Form/View For Performing Search.
iProjectOption
Specifies the the project and revision option to use while performing the search. Refer Class Description for more information.
iPlMItemIDs
Specifies the String array containing the PLM Item IDs used as search criteria to perform the Search.
iBatchSize
Specifies the maximum number of items fetched in any call to this method.
currentUserProject
Specifies the current workbench's Project name.
Returns:
CES Custom Interface with methods to retrieve results data and attributes.

getTotalItemCount

    int getTotalItemCount(ICESItemSet itemSet)

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

Parameters:
ICESItemSet
itemSet, specify the itemset for which TotalItemCount has bto be returned.
Returns:
The total number of items in the database that match the current query criteria.

jumpToPage

    ICESItemSet jumpToPage(ICESItemSet itemSet, int iPageNumber)

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

Parameters:
ICESItemSet
itemSet, specify the itemset for which the specified page has to be returned.
int
iPageNumber, the page number of the page to be returned
Returns:
The Results page (CESItemSet) for the specified Page Number.


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