Package com.dassault_systemes.enovwebsrvr.ews0infra.interfaces

   
Interface ENOVIDataObject

 
Class Hierarchy
com.dassault_systemes.enovwebsrvr.ews0infra.interfaces.ENOVIDataObject
Class Location

Framework : ENOVWebSrvr

Module : EWS0Infra

Class Description

public interface ENOVIDataObject

Object representation interface.

Field Summary

Constructor Summary

Method Summary
ENOVILogonToken getLogonToken()
String getObjectUUID()
String getObjectType()
ENOVWebType getWebType()
ENOVIType getType()
String getObjectName()
Object getInterface()
String getItfImplClass(String itfClassName)
Object getInterface(Class iInterface)
Enumeration getAttributes()
ENOVIAttribute getAttribute(String iAttrID)
String getAttrString(String attrName)
String getAttrString(ENOVIAttribute attr)
String[] getAttrStrings(String attrName)
String[] getAttrStrings(ENOVIAttribute attr)
Object getAttrValue(String attrName)
Object getAttrValue(ENOVIAttribute attr)
Object getAdHocAttrValue(String iAttrName, ENOVAttributeType iType)
String getAdHocAttrString(String iAttrName)
boolean setAttrValue(String attrName, Object value)
void setAdHocAttrValue(String iAttrName, Object iValue)
Enumeration getRelationshipNames()
ENOVIType getRelationshipType(String iRelName)
String getRelationshipWebType(String iRelName)
String getRelationshipAlias(String iRelName)
ENOVIDataObject[] getRelatedObjects(String iRelName)


Field Detail

Constructor Detail

Method Detail

getLogonToken

    ENOVILogonToken getLogonToken()

Retrieves the logon token under which this object was loaded.


getObjectUUID

    String getObjectUUID()

Retrieves the unique identifier for this object


getObjectType

    String getObjectType()

Retrieves the object web type name for the data object.


getWebType

    ENOVWebType getWebType()

Retrieves the web type object from the data object.


getType

    ENOVIType getType()

Retrieves the type definition for this object


getObjectName

    String getObjectName()

Retrieves the name of this object


getInterface

    Object getInterface()

Returns alternative implementation for this object. For example, if this is a document object, the return value should implement the ENOVIDocument interface.


getItfImplClass

    String getItfImplClass(String itfClassName)

Get the name of the implementation for the interface class passed in.


getInterface

    Object getInterface(Class iInterface)

Returns an instance of the requested interface class for this instance. The interface class must be registered as a supported interface for the data object.


getAttributes

    Enumeration getAttributes()

Retrieves an enumeration of attributes for this data type. The elements in the enumeration must implement the ENOVIAttribute interface.


getAttribute

    ENOVIAttribute getAttribute(String iAttrID)

Retrieves an attribute definition of a single attribute given the attribute ID.


getAttrString

    String getAttrString(String attrName)

Retrieves the external attribute value in string form from the object.


getAttrString

    String getAttrString(ENOVIAttribute attr)

Retrieves the external attribute value in string form from the object.


getAttrStrings

    String[] getAttrStrings(String attrName)

Retrieves the external multi-valued attribute value in string form from the object.


getAttrStrings

    String[] getAttrStrings(ENOVIAttribute attr)

Retrieves the external multi-valued attribute value in string form from the object.


getAttrValue

    Object getAttrValue(String attrName)

Retrieves an attribute internal value from the object. The type of the value will vary based on the attribute type.


getAttrValue

    Object getAttrValue(ENOVIAttribute attr)

Retrieves an attribute value from the object. The type of the value will vary based on the attribute type.


getAdHocAttrValue

    Object getAdHocAttrValue(String iAttrName, ENOVAttributeType iType)

Retrieves the value of an ad-hoc attribute (i.e. an attribute which may not be defined as part of the object definition) If the attribute is defined on the object, then the this method is the same as calling "getAttrValue" and in this case the "iType" input should be ignored since the type definition specifies the attribute type.


getAdHocAttrString

    String getAdHocAttrString(String iAttrName)

Convenience method, calls "getAdHocAttrValue" with the string type


setAttrValue

    boolean setAttrValue(String attrName, Object value)

Sets an attribute value on the object. Returns true if the assignment was successful.


setAdHocAttrValue

    void setAdHocAttrValue(String iAttrName, Object iValue)

Sets the value of an ad-hoc attribute (i.e. an attribute which may not be defined as part of the object definition) If the attribute is defined on the object, then the this method is the same as calling "setAttrValue"


getRelationshipNames

    Enumeration getRelationshipNames()

Retrieves an enumeration of the object relationship names for this object.


getRelationshipType

    ENOVIType getRelationshipType(String iRelName)

Returns the server type information regarding the relationship


getRelationshipWebType

    String getRelationshipWebType(String iRelName)

Returns the web type information regarding the relationship


getRelationshipAlias

    String getRelationshipAlias(String iRelName)

Returns the alias name for the given relationship. If none is defined or cannot be located, the relationship name will be returned.


getRelatedObjects

    ENOVIDataObject[] getRelatedObjects(String iRelName)

Returns an array of related objects by passing in the relationship name



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