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
Since:
R18 SP1
Author:
PTP
Author:
OIN
Version:
R18, 12/01/2007
Field Summary

Constructor Summary

Method Summary
public ICESViewAttributeList getCESViewAttributeList(CESViewType iViewType)
Returns the List of Attributes defined in this View for the given View Type.
public int getIndexOfCESViewAttribute(CESViewType iViewType, ICESViewAttribute viewAttr)
Returns the Index of the View Attribute in this view for the given View Type.
public ICESCategory getQueryCategory()
Returns the View Query Category.
public String getViewContentType()
Returns the View Content Type.
public String getViewName()
Returns the View Name.
public String getViewObjectID()
Returns the View ObjectID.
public CESSearchType getViewSearchType()
Returns the View Search Type.
public CESViewType getViewType()
Returns the View Type.
public void setQueryCategory(ICESCategory iCategory)
Sets the View Query Category.
public void setViewContentType(String contentType)
Sets the View Content Type.
public void setViewName(String viewName)
Sets the View Name.
public void setViewObjectID(String viewObjectID)
Sets the View ObjectID.
public void setViewSearchType(CESSearchType iSearchType)
Sets the View Search Type.
public void setViewType(CESViewType cesViewType)
Sets the View Type.


Field Detail

Constructor Detail

Method Detail

getCESViewAttributeList

    public 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
Return:
List of Attributes defined in this View for the given View Type.

getIndexOfCESViewAttribute

    public 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.
Return:
Index of the View Attribute in this view for the given View Type.

getQueryCategory

    public ICESCategory getQueryCategory()

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

Return:
The View Query Category.

getViewContentType

    public String getViewContentType()

Returns the View Content Type.

Return:
The View Content Type.

getViewName

    public String getViewName()

Returns the View Name.

Return:
View Name.

getViewObjectID

    public String getViewObjectID()

Returns the View ObjectID.

Return:
The View ObjectID.

getViewSearchType

    public CESSearchType getViewSearchType()

Returns the View Search Type.

Return:
The View Search Type.

getViewType

    public CESViewType getViewType()

Returns the View Type.

Return:
The View Type.

setQueryCategory

    public void setQueryCategory(ICESCategory iCategory)

Sets the View Query Category.

Parameters:
iCategory
Specifies the View Query Category.

setViewContentType

    public void setViewContentType(String contentType)

Sets the View Content Type.

Parameters:
contentType
Specifies the View Content Type.

setViewName

    public void setViewName(String viewName)

Sets the View Name.

Parameters:
viewName
Specifies the View Name.

setViewObjectID

    public void setViewObjectID(String viewObjectID)

Sets the View ObjectID.

Parameters:
viewObjectID
Specifies the View ObjectID.

setViewSearchType

    public void setViewSearchType(CESSearchType iSearchType)

Sets the View Search Type.

Parameters:
iSearchType
Specifies the View Search Type.

setViewType

    public void setViewType(CESViewType cesViewType)

Sets the View Type.

Parameters:
cesViewType
Specifies the View Type.


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