Package com.dassault_systemes.ENOVJCESInterfaces.CESJAPIInterface

   
Interface ICESView

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

Framework : ENOJCESInterfaces

Module : CESJAPIInterface

Class Description

public interface ICESView

This is a custom interface that represents a View(Form) in CES.

CES supports two types of views under the same View Name: Search View and Result View. The Search View consists of attributes on which query criteria can be set to execute a Search. The Result View consists of attributes that are displayed in the Results, on execution of a Search. Refer the CESViewType Class documentation for more information on valid View Types.

   All Implemented Interfaces:
ICESObject
Field Summary

Constructor Summary

Method Summary
String getViewName()
void setViewName(String viewName)
String getViewObjectID()
void setViewObjectID(String viewObjectID)
CESViewType getViewType()
void setViewType(CESViewType cesViewType)
CESSearchType getViewSearchType()
void setViewSearchType(CESSearchType iSearchType)
String getViewContentType()
void setViewContentType(String contentType)
ICESCategory getQueryCategory()
void setQueryCategory(ICESCategory iCategory)
ICESViewAttributeList getCESViewAttributeList(CESViewType iViewType)
int getIndexOfCESViewAttribute(CESViewType iViewType, ICESViewAttribute viewAttr)


Field Detail

Constructor Detail

Method Detail

getViewName

    String getViewName()

Returns the View Name.

Returns:
View Name.

setViewName

    void setViewName(String viewName)

Sets the View Name.

Parameters:
viewName
Specifies the View Name.

getViewObjectID

    String getViewObjectID()

Returns the View ObjectID.

Returns:
The View ObjectID.

setViewObjectID

    void setViewObjectID(String viewObjectID)

Sets the View ObjectID.

Parameters:
viewObjectID
Specifies the View ObjectID.

getViewType

    CESViewType getViewType()

Returns the View Type.

Returns:
The View Type.

setViewType

    void setViewType(CESViewType cesViewType)

Sets the View Type.

Parameters:
cesViewType
Specifies the View Type.

getViewSearchType

    CESSearchType getViewSearchType()

Returns the View Search Type.

Returns:
The View Search Type.

setViewSearchType

    void setViewSearchType(CESSearchType iSearchType)

Sets the View Search Type.

Parameters:
iSearchType
Specifies the View Search Type.

getViewContentType

    String getViewContentType()

Returns the View Content Type.

Returns:
The View Content Type.

setViewContentType

    void setViewContentType(String contentType)

Sets the View Content Type.

Parameters:
contentType
Specifies the View Content Type.

getQueryCategory

    ICESCategory getQueryCategory()

Returns the View Query Category. This is the category on which the query is executed.

Returns:
The View Query Category.

setQueryCategory

    void setQueryCategory(ICESCategory iCategory)

Sets the View Query Category.

Parameters:
iCategory
Specifies the View Query Category.

getCESViewAttributeList

    ICESViewAttributeList getCESViewAttributeList(CESViewType iViewType)

Returns the List of Attributes defined in this View for the given View Type.

Parameters:
authObject==
This method required the authentication information to be sucessfull.
iViewType
View Type
Returns:
List of Attributes defined in this View for the given View Type.

getIndexOfCESViewAttribute

    int getIndexOfCESViewAttribute(CESViewType iViewType, ICESViewAttribute viewAttr)

Returns the Index of the View Attribute in this view for the given View Type.

Parameters:
iViewType
The View Type.
viewAttr
The View Attribute.
Returns:
Index of the View Attribute in this view for the given View Type.


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