All Frameworks  Class Hierarchy  This Framework  Indexes   

VPMXBom Interface ENOVIAttributeDefinitions

Usage: you can freely reimplement this interface.


interface ENOVIAttributeDefinitions

Interface representing a list of attribute definition.
Role: All object definition should derive from this interface, this applies to Business Objects as well as to commands.

See also:
ENOVIBODefinition
See also:
ENOVICommand
See also:
ENOVIAttributeDefinition


Method Index


o Item(long,ENOVIAttributeDefinition**)
Retrieves an attribute definition by index.
o Item(char*,ENOVIAttributeDefinition**)
Retrieves an attribute definition by name.
o Item(CORBAAny*,ENOVIAttributeDefinition**)
Retrieves an attribute definition by index or by name.
o get_Enum(IEnumENOVIAttributeDefinition**)
not yet implemented
o get_FinderInterface(ENOVIQuery**)
Retrieves the finder interface for this type Object.
o get_ListOfSubTypes(CATListOfCATString**)
Retrieves the list of subtypes of the object described by this interface.
o get_TypeAlias(wchar_t**)
Retrieves the type alias of the object described by this interface.
o get_TypeName(char**)
Retrieves the type name of the object described by this interface.
o get_Visibility(VPMDicVISIBILITY*)
Retrieves the visibility for this type of objects.
o put_Visibility(VPMDicVISIBILITY)
Sets the visibility for this object.

Methods


o Item
public virtual Item( iIndex,
oItem)
Retrieves an attribute definition by index.
Parameters:
iIndex
1 based index of the attribute to retrieve
oItem
the retrieved attribute definition.
Returns:
An HRESULT value
Legal values:
S_OK
All went well
S_FALSE
there is no attribute definition by this name
E_???
Something went wrong
o Item
public virtual Item( const iAttributeName,
oItem)
Retrieves an attribute definition by name.
Parameters:
iAttributeName
name of the attribute to retrieve
oItem
the retrieved attribute definition.
Returns:
An HRESULT value
Legal values:
S_OK
All went well
S_FALSE
there is no attribute by this name
E_???
Something went wrong
o Item
public virtual Item( iIndex,
oItem)
Retrieves an attribute definition by index or by name.
Parameters:
iIndex
1 based index of the attribute to retrieve or name of the attribute to retrieve
Legal values:
  • a
CORBAAny with an integer typed value > 0
  • a CORBAAny with a string (tk_string or tk_unicodestring) typed value >
  • oItem
    the retrieved attribute definition.
    Returns:
    An HRESULT value
    Legal values:
    S_OK
    All went well
    S_FALSE
    there is no attribute by this name
    E_???
    Something went wrong
    o get_Enum
    public virtual get_Enum( oEnum)
    not yet implemented
    o get_FinderInterface
    public virtual get_FinderInterface( oFinder)
    Retrieves the finder interface for this type Object.
    Parameters:
    oFinder
    the retrieved finder inteface
    Returns:
    An HRESULT value
    Legal values:
    S_OK
    All went well
    S_FALSE
    there is no attribute by this name
    E_???
    Something went wrong
    See also:
    ENOVIQuery
    o get_ListOfSubTypes
    public virtual get_ListOfSubTypes( oListOfSubTypes)
    Retrieves the list of subtypes of the object described by this interface.
    Parameters:
    oListOfSubTypes
    the retrieved list of types
    Returns:
    An HRESULT value
    o get_TypeAlias
    public virtual get_TypeAlias( oTypeAlias)
    Retrieves the type alias of the object described by this interface.
    Parameters:
    oTypeAlias
    the retrieved type alias
    Returns:
    An HRESULT value
    Legal values:
    S_OK
    All went well
    E_???
    Something went wrong
    o get_TypeName
    public virtual get_TypeName( const oTypeName)
    Retrieves the type name of the object described by this interface.
    Parameters:
    oTypeName
    the retrieved type name
    Returns:
    An HRESULT value
    Legal values:
    S_OK
    All went well
    E_???
    Something went wrong
    o get_Visibility
    public virtual get_Visibility( oVisibility)
    Retrieves the visibility for this type of objects.
    Role: this will influence the visibility of the attribute in the user interface.
    Parameters:
    oVisibility
    the retrieved Visibility
    Returns:
    An HRESULT value
    Legal values:
    S_OK
    All went well
    E_???
    Something went wrong
    See also:
    VPMDicVISIBILITY
    o put_Visibility
    public virtual put_Visibility( iVisibility)
    Sets the visibility for this object.
    Parameters:
    iVisibility
    the new visibility
    Returns:
    An HRESULT value
    Legal values:
    S_OK
    All went well
    E_???
    Something went wrong
    See also:
    get_Visibility

    This object is included in the file: ENOVIAttributeDefinitions.h
    If needed, your Imakefile.mk should include the module: VPMXbmItf

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