All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface CATICfgSimpleSpecification
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---VPMInterfaces.CATICfgSpecification
|
+---CATICfgSimpleSpecification
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICfgSimpleSpecification
Method Index
- o
Attach(CATIConfigurable_var&,CATICfgSpecLnk_var&)
- Attach this SimpleSpecification to a Configurable.
- o
Attach(SEQUENCE(octet)&)
- Attach this SimpleSpecification to a Configurable.
- o
Detach(SEQUENCE(octet)&)
- Detach this SimpleSpecification from a Configurable.
- o
GetAlias(CATUnicodeString&)
- Return the SpecAlias of this SimpleSpecification.
- o
GetDescription(CATUnicodeString&)
- Return the Description of this SimpleSpecification.
- o
GetFullName(CATUnicodeString&)
- Return the full Name as Category.
- o
GetFullOid(char*&)
- Return the full Name as "Category Oid".
- o
GetLinkForUID(SEQUENCE(octet)&,CATICfgSpecLnk_var&)
- Return the link between this SimpleSpecification and a UUID-Configurable.
- o
GetName(CATUnicodeString&)
- Return the Name of this SimpleSpecification.
- o
GetSpecCategory(CATICfgSpecCategory_var&)
- Return the SpecCategory owning this SimpleSpecification.
- o
GetUIDList(SEQUENCE(CORBAAny)&)
- Return the list of UUIDs-Configurables this SimpleSpecification is attached to.
- o
SetAlias(CATUnicodeString&)
- Sets the Alias of this SimpleSpecification.
- o
SetDescription(CATUnicodeString&)
- Set the Description of this SimpleSpecification.
- o
UnsetAlias(CATUnicodeString&)
- Unsets the Alias of this SimpleSpecification.
Methods
o Attach
public virtual HRESULT Attach( | const CATIConfigurable_var& | iCO, |
| CATICfgSpecLnk_var& | oSpecLnk)=0 |
-
Attach this SimpleSpecification to a Configurable.
- Parameters:
-
- iCO
- Configurable this SimpleSpecification will be attached to.
- oSpecLnk
- Link between the configurable and the specification.
o Attach
public virtual HRESULT Attach( | SEQUENCE(octet)& | iObjectUUID)=0 |
-
Attach this SimpleSpecification to a Configurable.
- Parameters:
-
- iObjectUUID
- UUID of the Configurable this SimpleSpecification will be attached to.
o Detach
public virtual HRESULT Detach( | SEQUENCE(octet)& | iConfigurableUID) = 0 |
-
Detach this SimpleSpecification from a Configurable.
Postcondition: If the SimpleSpecification belongs to a Configuration Rule attached to the
Configurable, the method doesn't detach it.
- Parameters:
-
- iConfigurableUID
- UUID of the Configurable this SimpleSpecification will be detached from.
o GetAlias
-
Return the SpecAlias of this SimpleSpecification.
- Parameters:
-
- oAlias
- SpecAlias of this SimpleSpecification to be returned.
o GetDescription
-
Return the Description of this SimpleSpecification.
- Parameters:
-
- oDescription
- The SimpleSpecification Description to return.
o GetFullName
-
Return the full Name as Category.SimpleSpecification.
- Parameters:
-
- oName
- The full Name obtained by concatenation of the owning Category Name and the SimpleSpecification Name.
o GetFullOid
public virtual HRESULT GetFullOid( | char*& | oOid) = 0 |
-
Return the full Name as "Category Oid"."SimpleSpecification Oid".
- Parameters:
-
- oName
- The full Name obtained by concatenation of the owning Category Oid and the SimpleSpecification Oid.
o GetLinkForUID
public virtual HRESULT GetLinkForUID( | const SEQUENCE(octet)& | iUuid, |
| CATICfgSpecLnk_var& | oSpecLink)=0 |
-
Return the link between this SimpleSpecification and a UUID-Configurable.
Legal values: S_OK if the SpecLnk link exists, S_FALSE else.
- Parameters:
-
- iUuid
- UUID of the Configurable this SimpleSpecification is supposed to be linked with.
- oSpecLink
- Link between this SimpleSpecification and the UUID-Configurable.
o GetName
-
Return the Name of this SimpleSpecification.
- Parameters:
-
- oName
- The SimpleSpecification Name.
o GetSpecCategory
public virtual HRESULT GetSpecCategory( | CATICfgSpecCategory_var& | oCategory) const = 0 |
-
Return the SpecCategory owning this SimpleSpecification.
- Parameters:
-
- oCategory
- SpecCategory owning this SimpleSpecification: it may be NULL_var.
o GetUIDList
public virtual HRESULT GetUIDList( | SEQUENCE(CORBAAny)& | Ret) const = 0 |
-
Return the list of UUIDs-Configurables this SimpleSpecification is attached to.
- Parameters:
-
- Ret
- List of UUIDs-Configurables this SimpleSpecification is attached to.
o SetAlias
-
Sets the Alias of this SimpleSpecification.
- Parameters:
-
- iAlias
- The SimpleSpecification Alias to set.
o SetDescription
-
Set the Description of this SimpleSpecification.
- Parameters:
-
- oDescription
- The SimpleSpecification Description to set.
o UnsetAlias
-
Unsets the Alias of this SimpleSpecification.
- Parameters:
-
- iAlias
- The SimpleSpecification Alias to unset.
This object is included in the file: CATICfgSimpleSpecification.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces