All Frameworks Class Hierarchy This Framework Previous Indexes
ENOCESInterfaces Interface ENOVIPartSelection
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVIPartSelection
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIPartSelection
Interface representing PartSElectionApi.
Role:It gives methods to get ENOVICESViewAttribute,to make search on CES DB and corresponding search State.
- Example:
- ENOVICESAuthentication_var piSysMyInterfaceOnComponent;
HRESULT rc = ::CATInstantiateComponent( "ENOVCESAuthenticationImpl", IID_ENOVICESAuthentication,
(void**)&piSysMyInterfaceOnComponent);
ENOVIPartSelection_var partselection;
piSysMyInterfaceOnComponent->QueryInterface(IID_ENOVIPartSelection,(void**)&partselection);
- See also:
- ENOVICESAuthentication
Method Index
- o
GetCESViewAttributeList(CATListValENOVICESViewAttribute_var&,CATUnicodeString,CATUnicodeString)
- Fetches the list of attributes for the form/view name passed.
- o
GetCategoryList(CATListOfCATUnicodeString&,CATUnicodeString)
- search Category: Search Category fetches the list of Categories matching the search criteria.
- o
GetPLMItemSearchResults(CATListValCATICatalogDescription_var&,ENOVICESState_var&,CATListOfCATUnicodeString*,CATUnicodeString,CESSearchItemType,CATUnicodeString,CESSearchProjectOption,int)
- Performs CES Standard Search on PLM Item Id Attribute
- o
GetSearchViewList(CATListOfCATUnicodeString&,CESSearchItemType,CESSearchType)
- Search View : A view formed with a specific set of properties extracted from the search class and/or its related class (es)
Fetches the list of Views for the Given ItemType and SearchType
- o
GetSimpleSearchResults(CATListValCATICatalogDescription_var&,ENOVICESState_var&,CATUnicodeString,CESSearchItemType,CATUnicodeString,CESSearchProjectOption,CATUnicodeString,int)
- Performs CES Simple Search
Simple Search searches the properties that are defined as context searchable in the CES Search View
- o
GetStandardSearchResults(CATListValCATICatalogDescription_var&,ENOVICESState_var&,CATListOfCATUnicodeString*,CATListOfCATUnicodeString*,CATUnicodeString,CESSearchItemType,CATUnicodeString,CESSearchProjectOption,int)
- Performs CES Standard Search
- o
GetTotalItemCount(ENOVICESState_var&,int&)
- Method returns the total Item/Record count of the resultset/itemset represented by the state object.
- o
GetTotalPageCount(ENOVICESState_var&,int&)
- Method returns total Page number/count in the resultset/itemset represented by the state object.
- o
JumpToPage(CATListValCATICatalogDescription_var&,ENOVICESState_var&,int)
- Performs pagination based on the ENOVICESState object that is passed.
Methods
o GetCESViewAttributeList
public virtual HRESULT GetCESViewAttributeList( | CATListValENOVICESViewAttribute_var& | oFormAttributes, |
| CATUnicodeString | iSearchView | ="All Items" , |
| CATUnicodeString | iCategoryName | ="Supplemental Information")=0 |
-
Fetches the list of attributes for the form/view name passed.
Search View/Form : A view formed with a specific set of attributes extracted from the search class.
- Parameters:
-
- oFormAttributes
- List of Attributes for the specified Form/View. Attribute list will also contain the category specific attributes.
- iSearchView
- Selected Form View For fetching the attributes.
Default Value "All Items" View
- iCategoryName
- Selected Category For retreiving the form and the attributes. The attributes of this category will be augmented to
selected form.Default Value Supplemental Information Category Root Category of CES Catalog
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- If the method call is successful
- E_FAIL
- If the method call is not successful
o GetCategoryList
-
search Category: Search Category fetches the list of Categories matching the search criteria.
- Parameters:
-
- oCategoryResults
- List of category names as output.oCategoryResults will return an empty list if no matching records are found.
- iCategoryCriteria
- The criteria to search for categories. This does an explicit wild card search using the crteria as the category name.
e.g. "Supp*" criteria will return Supplemental Information
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- If the method call is successful
- E_FAIL
- If the method call is notsuccessful
o GetPLMItemSearchResults
-
Performs CES Standard Search on PLM Item Id Attribute
- Parameters:
-
- oResults
- Output List of CES Results Items corresponding to the input PLM Item Nos
- oStateObject
- Output the state object that contains the information about present state returned by the server ,which is used for page naviigation.
- iCategoryName
- Selected Category For Performing Search
Default Value Supplemental Information Category Root Category of CES Catalog
- iItemType
- Selected Item Type For Performing Search Can be "Items-Internal","Items-Manufacturer","Items-Supplier"
Default Value Internal Items
- iSearchView
- Selected Form View For Performing Search
Default Value All Items View
- iProjectOption
- Selected Project Options For Performing Search Can be "All Project and All Revisions",
"All Projects and Current Revision","Current Project and All Revisions",
"Current Project and Current Revision"
Default Value All Projects and All Revisions
- iPlMItemNos
- List of PLM Item Nos
- iBatchSize
- The batch size of the pages default value 15
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- If the method call is successful
- E_FAIL
- If the method call is not successful
o GetSearchViewList
-
Search View : A view formed with a specific set of properties extracted from the search class and/or its related class (es)
Fetches the list of Views for the Given ItemType and SearchType
- Parameters:
-
- oSearchViews
- List of Search Views output
- iItemType
- Selected Item Type For Performing Search Can be "Items-Internal","Items-Manufacturer","Items-Supplier"
Default Value Internal Items
- iSearchType
- Specifies the type of the Search It Can be PARAMETERIC_SEARCH or KEYWORD_SEARCH
PARAMETERIC_SEARCH -> Standard Search performed on the normal attributes of the Selected Category
KEYWORD_SEARCH -> Performed on the Context Searchable attributes of the Selected Category Refer PES CES Search for more on Keyword Search
Default Value PARAMETERIC_SEARCH
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- If the method call is successful
- E_FAIL
- If the method call is notsuccessful
o GetSimpleSearchResults
public virtual HRESULT GetSimpleSearchResults( | CATListValCATICatalogDescription_var& | oResults, |
| ENOVICESState_var& | oStateObject, |
| CATUnicodeString | iCategoryName | ="Supplemental Information", |
| CESSearchItemType | iItemType | =ITEMS_INTERNAL, |
| CATUnicodeString | iSearchView | ="All Items", |
| CESSearchProjectOption | iProjectOption | =ALL_PROJS_ALL_REVS, |
| CATUnicodeString | iSimpleSearchCriteria | ="", |
| int | iBatchSize | =15)=0 |
-
Performs CES Simple Search
Simple Search searches the properties that are defined as context searchable in the CES Search View
- Parameters:
-
- oResults
- Output List of CES Results Items matching the search criteria
- oStateObject
- Output the state object that contains the information about present state returned by the server ,which is used for page naviigation.
- iCategoryName
- Selected Category For Performing Search
Default Value Supplemental Information Category Root Category of CES Catalog
- iItemType
- Selected Item Type For Performing Search Can be "Items-Internal","Items-Manufacturer","Items-Supplier"
Default Value Internal Items
- iSearchView
- Selected Form View For Performing Search
Default Value All Items View
- iProjectOption
- Selected Project Options For Performing Search Can be "All Project and All Revisions",
"All Projects and Current Revision","Current Project and All Revisions",
"Current Project and Current Revision"
Default Value All Projects and All Revisions
- iSimpleSearchCriteria
- The actual search criteria to perform the search
- iBatchSize
- The batch size of the pages default value 15
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- If the method call is successful
- E_FAIL
- If the method call is notsuccessful
o GetStandardSearchResults
-
Performs CES Standard Search
- Parameters:
-
- oResults
- Output List of CES Results Items matching the search criteria
- oStateObject
- Output the state object that contains the information about present state returned by the server ,which is used for page naviigation.
- iCategoryName
- Selected Category For Performing Search
Default Value Supplemental Information Category Root Category of CES Catalog
- iItemType
- Selected Item Type For Performing Search Can be "Items-Internal","Items-Manufacturer","Items-Supplier"
Default Value Internal Items
- iSearchView
- Selected Form View For Performing Search
Default Value All Items View
- iProjectOption
- Selected Project Options For Performing Search Can be "All Project and All Revisions",
"All Projects and Current Revision","Current Project and All Revisions",
"Current Project and Current Revision"
Default Value All Projects and All Revisions
- iSearchAttibutes
- List of Search Attributes
- iSearchAttrbValues
- List of Input Search Values
- iBatchSize
- The batch size of the pages default value 15
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- If the method call is successful
- E_FAIL
- If the method call is not successful
o GetTotalItemCount
public virtual HRESULT GetTotalItemCount( | ENOVICESState_var& | iStateObject, |
| int& | oItemCount)=0 |
-
Method returns the total Item/Record count of the resultset/itemset represented by the state object. The state object is used to retrieve the ItemSet upon which this operation is performed.
- Parameters:
-
- ENOVICESState
- iStateObject -- This Object is used to retrieve the ItemSet on which this operation will be performed. State object retrieved from the result should be passed as a input parameter to this function.
- int
- oItemCount -- Output parameter TotalItem count for the itemset represented by the state object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- If the method call is successful
- E_FAIL
- If the method call is not successful
o GetTotalPageCount
public virtual HRESULT GetTotalPageCount( | ENOVICESState_var& | iStateObject, |
| int& | oPageCount)=0 |
-
Method returns total Page number/count in the resultset/itemset represented by the state object.It depends on the batch size and item count in the itemset. The state object is used to retrieve the ItemSet upon which this operation is performed.
- Parameters:
-
- ENOVICESState
- iStateObject -- This Object is used to retrieve the ItemSet on which this operation will be performed. State object retrieved from the result should be passed as a input parameter to this function.
- int
- oPageCount -- Output parameter TotalPagecount for the itemset represented by the state object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- If the method call is successful
- E_FAIL
- If the method call is not successful
o JumpToPage
public virtual HRESULT JumpToPage( | CATListValCATICatalogDescription_var& | oResults, |
| ENOVICESState_var& | iStateObject, |
| int | iPageNo)=0 |
-
Performs pagination based on the ENOVICESState object that is passed. The state object is used to retrieve the ItemSet upon which pagination is performed. Only the current result set specified as part of the page number is used.
- Parameters:
-
- oResults
- Output List of CES Results Items matching the search criteria
- CATBoolean
- & oHasExceedLastPage It returns True if the iPageNo crosses the last page no. in the result set.Otherwise False.
- ENOVICESState
- iStateObject -- This Object is used to retrieve the ItemSet on which pagination will be performed. State object of the result should be passed as a parameter to this function.
- int
- iPageNo -- The input Page Number representing the set of results. This may be used for performing pagination.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- If the method call is successful
- S_FALSE
- If the iPageNo is less than 1
- E_UNEXPECTED
- If the iPageNo is greater than 1maximum number of pages available
This object is included in the file: ENOVIPartSelection.h
If needed, your Imakefile.mk should include the module: ENOVCESPartSelectionApi