All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

ENOVReportSolutionServer Class ENOVReportUtilities

ENOVReportUtilities
 

Usage: you must use this class as is. You should never derive it.


public class ENOVReportUtilities

Utilities to assist in creating reports.
Role: These Utilities will ease the effort it takes to create reports


Constructor and Destructor Index


o ENOVReportUtilities()
o ~ENOVReportUtilities()

Method Index


o AddComputedAttribute(ENOVPublishObjectNode*,CATUnicodeString,CATUnicodeString)
Method adds a computed attribute to the report stream.
o AddComputedAttribute(ENOVPublishObjectNode*,CATUnicodeString,double)
Method adds a computed attribute to the report stream.
o AddComputedAttribute(ENOVPublishObjectNode*,CATUnicodeString,int)
Method adds a computed attribute to the report stream.
o GetData(CATUnicodeString&,CATIVpmFactoryObject*,ENOVPublishObjectNode*,CATLISTV(CATBaseUnknown_var)&)
Method used to get the Report stream for any given object.
o GetLoginParam(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Method used to get the Login info of the current user.
o Set_OID(CATILinkableObject_var,ENOVPublishObjectNode*&,CATDbBinary&)
Method used to set the OID of an object into a publish Node.
o Set_SubObjectNode(CATBaseUnknown_var,ENOVPublishObjectNode*&,CATDbBinary&,CATUnicodeString,CATLISTV(CATBaseUnknown_var)&)
Method used by the GetData method to put subobjects in the report.
o get_OID(CATILinkableObject_var,CATDbBinary&)
Method used to get the OID of an object.

Constructor and Destructor


o ENOVReportUtilities
public ENOVReportUtilities()
o ~ENOVReportUtilities
public ~ENOVReportUtilities()

Methods


o AddComputedAttribute
public static HRESULT AddComputedAttribute(ENOVPublishObjectNode* TheNode,
CATUnicodeString AttributeName,
CATUnicodeString AttributeValue)
Method adds a computed attribute to the report stream.
Returns:
Error codes
Legal values: as a HRESULT.
Main returns code used:
  • S_OK If operation runs well
  • S_FALSE In case of errors
  • E_FAILED In case of errors
      Parameters:
      TheNode
      The publish node in which to put the attributes
      AttributeName
      The name of the attribute to be inserted.
      AttributeValue
      The value of the attribute to be inserted.
o AddComputedAttribute
public static HRESULT AddComputedAttribute(ENOVPublishObjectNode* TheNode,
CATUnicodeString AttributeName,
double AttributeValue)
Method adds a computed attribute to the report stream.
Returns:
Error codes
Legal values: as a HRESULT.
Main returns code used:
  • S_OK If operation runs well
  • S_FALSE In case of errors
  • E_FAILED In case of errors
      Parameters:
      TheNode
      The publish node in which to put the attributes
      AttributeName
      The name of the attribute to be inserted.
      AttributeValue
      The value of the attribute to be inserted.
o AddComputedAttribute
public static HRESULT AddComputedAttribute(ENOVPublishObjectNode* TheNode,
CATUnicodeString AttributeName,
int AttributeValue)
Method adds a computed attribute to the report stream.
Returns:
Error codes
Legal values: as a HRESULT.
Main returns code used:
  • S_OK If operation runs well
  • S_FALSE In case of errors
  • E_FAILED In case of errors
      Parameters:
      TheNode
      The publish node in which to put the attributes
      AttributeName
      The name of the attribute to be inserted.
      AttributeValue
      The value of the attribute to be inserted.
o GetData
public static HRESULT GetData( const CATUnicodeString& iViewName,
CATIVpmFactoryObject* TheObjectToPrint,
ENOVPublishObjectNode* TheNode,
CATLISTV(CATBaseUnknown_var)& printedObjects)
Method used to get the Report stream for any given object.
Returns:
Error codes
Legal values: as a HRESULT.
Main returns code used:
  • S_OK If operation runs well
  • S_FALSE In case of errors
  • E_FAILED In case of errors
      Parameters:
      iViewName
      The view in which you are working. If you use one of the default view names you will get the default behavior: iVewName = "one level" publishes the current object iVewName = "two levels" publishes the current and the first level objects which are linked by OID attributes iVewName = "anything else" publishes the current and all levels of OID objects
      TheObjectToPrint
      The object to be put in the report stream
      TheNode
      The PublishNode to put the object in.
      printedObjects
      a list of the objects which have been put into the stream
o GetLoginParam
public static HRESULT GetLoginParam(CATUnicodeString& oUserName,
CATUnicodeString& oOrgName,
CATUnicodeString& oRoleName)
Method used to get the Login info of the current user.
Returns:
Error codes
Legal values: as a HRESULT.
Main returns code used:
  • S_OK If operation runs well
  • S_FALSE In case of errors
  • E_FAILED In case of errors
      Parameters:
      oUserName
      The user namd
      oOrgName
      The users organization
      oRoleName
      The users current role
o Set_OID
public static HRESULT Set_OID(CATILinkableObject_var Linkable,
ENOVPublishObjectNode*& TheObject,
CATDbBinary& o_ObjectOID)
Method used to set the OID of an object into a publish Node.
Returns:
Error codes
Legal values: as a HRESULT.
Main returns code used:
  • S_OK If operation runs well
  • S_FALSE In case of errors
  • E_FAILED In case of errors
      Parameters:
      Linkable
      The object in which you want to get the OID
      TheObject
      The Publish Node in which to put the OID
      o_ObjectOID
      The OID.
o Set_SubObjectNode
public static HRESULT Set_SubObjectNode(CATBaseUnknown_var TheSubObject,
ENOVPublishObjectNode*& TheSuperObject,
CATDbBinary& o_PointedObjectOID,
CATUnicodeString iViewName,
CATLISTV(CATBaseUnknown_var)& printedObjects)
Method used by the GetData method to put subobjects in the report.
Returns:
Error codes
Legal values: as a HRESULT.
Main returns code used:
  • S_OK If operation runs well
  • S_FALSE In case of errors
  • E_FAILED In case of errors
o get_OID
public static HRESULT get_OID(CATILinkableObject_var iObj,
CATDbBinary& o_II_ObjectUUID)
Method used to get the OID of an object.
Returns:
Error codes
Legal values: as a HRESULT.
Main returns code used:
  • S_OK If operation runs well
  • S_FALSE In case of errors
  • E_FAILED In case of errors
      Parameters:
      iObj
      The object
      o_II_ObjectUUID
      The OID.

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

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