All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATICfgProductType

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATICfgProductType
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATICfgProductType



Method Index


o AddCV(CATIConfigurableObject_var&)
Add this PT below iCV.
o AddSpec(CATICfgSimpleSpecification_var&)
Add a 'type defining' specification.
o Delete()
Delete Product Type.
o GetAlias(CATUnicodeString&)
Function added by Pavan 03/11/02 Get ProductType Alias.
o GetCO(CATIConfigurable_var&)
Get Configurable .
o GetCV(CATListValCATIConfigurableObject_var&)
Get the list of 'CV' that the PT relates to.
o GetConfigurationCV(CATIConfigurableObject_var&)
Retrieve the CV used to configure this Product Type.
o GetListOfAuthorizedSpecs(CATTime&,CATTime&,CATListValCATICfgSimpleSpecification_var&)
Get list of authorized specifications for an interval of date.
o GetListOfAuthorizedSpecs(CATUnicodeString&,CATTime&,CATTime&,CATListValCATICfgSimpleSpecification_var&)
o GetName(CATUnicodeString&)
Get ProductType name.
o GetSpec(CATListValCATICfgSimpleSpecification_var&)
Get the list of 'type defining' specifications.
o GetSpecApplicability(CATICfgSimpleSpecification_var&,CATICfgEffectivity_var&)
o GetSpecApplicability(CATUnicodeString&,CATICfgSimpleSpecification_var&,CATICfgEffectivity_var&)
Get the applicability of a specification of this product type.
o RemoveCV(CATIConfigurableObject_var&)
RemoveCV
o RemoveSpec(CATICfgSimpleSpecification_var&)
Remove a 'type defining' specification.
o SetAlias(CATUnicodeString&)
Function added by Pavan 03/11/02 Set ProductType Alias.
o SetAuthorizedSpecValidity(CATICfgEffectivity_var&,CATICfgSimpleSpecification_var&)
o SetAuthorizedSpecValidity(CATTime&,CATICfgSimpleSpecification_var&)
Define the validity of a specification from iDate to infinity.
o SetAuthorizedSpecValidity(CATTime&,CATTime&,CATICfgSimpleSpecification_var&)
o SetAuthorizedSpecValidity(CATUnicodeString&,CATICfgEffectivity_var&,CATICfgSimpleSpecification_var&)
Define the validity of a specification .
o SetAuthorizedSpecValidity(CATUnicodeString&,CATTime&,CATICfgSimpleSpecification_var&)
o SetAuthorizedSpecValidity(CATUnicodeString&,CATTime&,CATTime&,CATICfgSimpleSpecification_var&)
Define the validity of a specification from iStartDate to iEndDate.
o UnsetAlias(CATUnicodeString&)
Function added by Pavan 03/11/02 Unset ProductType Alias.

Methods


o AddCV
public virtual HRESULT AddCV( const CATIConfigurableObject_var& iCV) = 0
Add this PT below iCV.
Parameters:
iCV
ConfigurableObject.
o AddSpec
public virtual HRESULT AddSpec( const CATICfgSimpleSpecification_var& iSpec) = 0
Add a 'type defining' specification.
Parameters:
iSpec
'type defining' specification. This specification must belong to one of the 'type defining' categories.
o Delete
public virtual HRESULT Delete()= 0
Delete Product Type.
Returns:
An HRESULT
Legal values:
S_OK
The objects is successfully deleted and the interface pointer is successfully returned
E_FAIL
Failed to delete the Object
o GetAlias
public virtual HRESULT GetAlias(CATUnicodeString& oAlias) const = 0
Function added by Pavan 03/11/02 Get ProductType Alias.
Parameters:
oName
Alias of Product Type.
o GetCO
public virtual HRESULT GetCO(CATIConfigurable_var& oCO) const = 0
Get Configurable .
Parameters:
oCO
The Configurable on Product Type.
o GetCV
public virtual HRESULT GetCV(CATListValCATIConfigurableObject_var& oList) const = 0
Get the list of 'CV' that the PT relates to.
Parameters:
oList
List of CV.
o GetConfigurationCV
public virtual HRESULT GetConfigurationCV(CATIConfigurableObject_var& oCV) const = 0
Retrieve the CV used to configure this Product Type.
Parameters:
oCV
Configurable object used to configure this PT.
o GetListOfAuthorizedSpecs
public virtual HRESULT GetListOfAuthorizedSpecs( const CATTime& iStartDate,
const CATTime& iEndDate,
CATListValCATICfgSimpleSpecification_var& oList) const = 0
Get list of authorized specifications for an interval of date. Rem: CATTime will build a CATTime containing the current day. Rem: Use CATTime(0,0,0,0,0,0) to build an infinite CATTime
Parameters:
iDomain
Domain name.
iStartDate
Start date.
iEndDate
End date.
oList
List of specifications.
o GetListOfAuthorizedSpecs
public virtual HRESULT GetListOfAuthorizedSpecs( const CATUnicodeString& iDomain,
const CATTime& iStartDate,
const CATTime& iEndDate,
CATListValCATICfgSimpleSpecification_var& oList) const = 0
o GetName
public virtual HRESULT GetName(CATUnicodeString& oName) const = 0
Get ProductType name. You may also used ENOVINamedObject.
Parameters:
oName
Name of Product Type.
o GetSpec
public virtual HRESULT GetSpec(CATListValCATICfgSimpleSpecification_var& oList) const = 0
Get the list of 'type defining' specifications.
Parameters:
oList
List of specifications.
o GetSpecApplicability
public virtual HRESULT GetSpecApplicability( const CATICfgSimpleSpecification_var& iSpec,
CATICfgEffectivity_var& oEff) const = 0
o GetSpecApplicability
public virtual HRESULT GetSpecApplicability( const CATUnicodeString& iDomain,
const CATICfgSimpleSpecification_var& iSpec,
CATICfgEffectivity_var& oEff) const = 0
Get the applicability of a specification of this product type.
Returns:
An HRESULT value.
Legal values:
S_OK
GetSpecApplicability succeeds.
E_FAIL
An error occured
Parameters:
iDomain
Domain name.
iSpec
Specification from which you want to know the applicability.
oEff
Applicability of iSpec.
o RemoveCV
public virtual HRESULT RemoveCV( const CATIConfigurableObject_var& iCV) = 0
RemoveCV
Parameters:
iCV
ConfigurableObject.
o RemoveSpec
public virtual HRESULT RemoveSpec( const CATICfgSimpleSpecification_var& iSpec) = 0
Remove a 'type defining' specification.
Parameters:
iSpec
'type defining' specification. This specification must belong to one of the 'type defining' categories.
o SetAlias
public virtual HRESULT SetAlias( const CATUnicodeString& iAlias) = 0
Function added by Pavan 03/11/02 Set ProductType Alias.
Parameters:
oName
Alias of Product Type.
o SetAuthorizedSpecValidity
public virtual HRESULT SetAuthorizedSpecValidity( const CATICfgEffectivity_var& iEffectivity,
const CATICfgSimpleSpecification_var& iSpec) = 0
o SetAuthorizedSpecValidity
public virtual HRESULT SetAuthorizedSpecValidity( const CATTime& iDate,
const CATICfgSimpleSpecification_var& iSpec) = 0
Define the validity of a specification from iDate to infinity.
Parameters:
iDomain
Domain name.
iDate
Date parameter.
iSpec
specification. iSpec must belong to the CATIConfigurable of the ProductType
o SetAuthorizedSpecValidity
public virtual HRESULT SetAuthorizedSpecValidity( const CATTime& iStartDate,
const CATTime& iEndDate,
const CATICfgSimpleSpecification_var& iSpec) = 0
o SetAuthorizedSpecValidity
public virtual HRESULT SetAuthorizedSpecValidity( const CATUnicodeString& iDomain,
const CATICfgEffectivity_var& iEffectivity,
const CATICfgSimpleSpecification_var& iSpec) = 0
Define the validity of a specification .
Parameters:
iDomain
Domain name.
iEffectivity
Applicability of specification for this ProductType.
iSpec
specification. iSpec must belong to the CATIConfigurable of the ProductType
o SetAuthorizedSpecValidity
public virtual HRESULT SetAuthorizedSpecValidity( const CATUnicodeString& iDomain,
const CATTime& iDate,
const CATICfgSimpleSpecification_var& iSpec) = 0
o SetAuthorizedSpecValidity
public virtual HRESULT SetAuthorizedSpecValidity( const CATUnicodeString& iDomain,
const CATTime& iStartDate,
const CATTime& iEndDate,
const CATICfgSimpleSpecification_var& iSpec) = 0
Define the validity of a specification from iStartDate to iEndDate.
Parameters:
iDomain
Domain name.
iStartDate
StartDate parameter.
iEndDate
EndDate parameter.
iSpec
specification. iSpec must belong to the CATIConfigurable of the ProductType
o UnsetAlias
public virtual HRESULT UnsetAlias( const CATUnicodeString& iAlias) = 0
Function added by Pavan 03/11/02 Unset ProductType Alias.
Parameters:
oName
Alias of Product Type.

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

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