|
|
Package com.dassault_systemes.enovwebsrvr.ews0infra.interfaces |
Interface ENOVIDataObject
|
Class Hierarchy |
com.dassault_systemes.enovwebsrvr.ews0infra.interfaces.ENOVIDataObject
Class Location |
Class Description |
public interface ENOVIDataObject
Object representation interface.
Field Summary |
Constructor Summary |
Method Summary |
Field Detail |
Constructor Detail |
Method Detail |
ENOVILogonToken getLogonToken()Retrieves the logon token under which this object was loaded.
String getObjectUUID()Retrieves the unique identifier for this object
String getObjectType()Retrieves the object web type name for the data object.
ENOVWebType getWebType()Retrieves the web type object from the data object.
ENOVIType getType()Retrieves the type definition for this object
String getObjectName()Retrieves the name of this object
Object getInterface()Returns alternative implementation for this object. For example, if this is a document object, the return value should implement the ENOVIDocument interface.
String getItfImplClass(String itfClassName)Get the name of the implementation for the interface class passed in.
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.
Enumeration getAttributes()Retrieves an enumeration of attributes for this data type. The elements in the enumeration must implement the ENOVIAttribute interface.
ENOVIAttribute getAttribute(String iAttrID)Retrieves an attribute definition of a single attribute given the attribute ID.
String getAttrString(String attrName)Retrieves the external attribute value in string form from the object.
String getAttrString(ENOVIAttribute attr)Retrieves the external attribute value in string form from the object.
String[] getAttrStrings(String attrName)Retrieves the external multi-valued attribute value in string form from the object.
String[] getAttrStrings(ENOVIAttribute attr)Retrieves the external multi-valued attribute value in string form from the object.
Object getAttrValue(String attrName)Retrieves an attribute internal value from the object. The type of the value will vary based on the attribute type.
Object getAttrValue(ENOVIAttribute attr)Retrieves an attribute value from the object. The type of the value will vary based on the attribute type.
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.
String getAdHocAttrString(String iAttrName)Convenience method, calls "getAdHocAttrValue" with the string type
boolean setAttrValue(String attrName, Object value)Sets an attribute value on the object. Returns true if the assignment was successful.
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"
Enumeration getRelationshipNames()Retrieves an enumeration of the object relationship names for this object.
ENOVIType getRelationshipType(String iRelName)Returns the server type information regarding the relationship
String getRelationshipWebType(String iRelName)Returns the web type information regarding the relationship
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.
ENOVIDataObject[] getRelatedObjects(String iRelName)Returns an array of related objects by passing in the relationship name