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