All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface CATIConfigurableObject
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIConfigurableObject
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIConfigurableObject
Method Index
- o
BelongsTo(CATIConfigurableObject_var&)
- Check if an input ConfigurableObject belongs (is instantiated) to this ConfigurableObject.
- o
CheckRemove(SEQUENCE(octet)&,CATUnicodeString&,CATICfgEffectivity_var&)
- Check if it is possible to remove an input Effectivity from the Effectivity associated to a Filterable by
a given DomainName.
- o
CheckRemove(SEQUENCE(octet)&,CATUnicodeString&,CATICfgORExpression_var&)
- Check if it is possible to remove an input ORExpression from the ORExpression associated to a Filterable by
a given DomainName.
- o
CreateConfigHandler(CATUnicodeString&,CATUnicodeString&,CATIConfigHandler_var&)
- Create a new ConfigHandler associated to this ConfigurabeObject, given its Name and Description.
- o
CreateModificationEffectivity(CATICfgModification_var&)
- Create a new ModificationEffectivity, Name generated by the method, assiociated to this ConfigurableObject.
- o
CreateModificationEffectivity(CATUnicodeString&,CATICfgModification_var&)
- Create a new ModificationEffectivity, given its Name, assiociated to this ConfigurableObject.
- o
Delete()
- Delete this ConfigurableObject.
- o
DisplayObjectsEffectivity(SEQUENCE(CORBAAny)&,CATListOfCATUnicodeString&)
- Return the effectivity XML string for each object.
- o
GetApplicativeConfiguration(CATICfgFilter_var&)
- Return the current configuration as a Filter.
- o
GetBSFFilter(CATUnicodeString&,CATICfgFilter_var&)
- Return a User defined Filter.
- o
GetConfigurable(CATIConfigurable_var&)
- Return the Configurable owning this Configurableobject.
- o
GetListOfConfigHandler(CATListValCATIConfigHandler_var&)
- Return the List of ConfigHandler associated to this ConfigurableObject.
- o
GetModificationList(CATListValCATICfgModification_var&)
- Return the List of all ModificationEffectivites belonging to this ConfigurableObject.
- o
GetModificationListByName(CATUnicodeString&,CATListValCATICfgModification_var&)
- Return the List of ModificationEffectivites, having the same given Name, belonging to this ConfigurableObject.
- o
GetName(CATUnicodeString&)
- Return the Name of this ConfigurableObject.
- o
GetObject(SEQUENCE(octet)&)
- Return the UUID of the Object linked to this ConfigurableObject.
- o
GetProductName(CATUnicodeString&)
- Return the Name of the Object linked to this ConfigurableObject.
- o
IsVersionable(CATILinkableObject_var&,CATTime&)
- Check if an object can be versioned
- o
QueryEffectivitiesByStatus(CATListOfCATUnicodeString&,CATListOfCATICfgModification_var&)
- Return the List of ModificationEffectivities for this ConfigurableObject, where at least one of the X_Eff has a
Status included in an input StatusList.
- o
QueryEffectivitiesMinus(SEQUENCE(octet)&,CATListOfCATICfgModification_var&)
- Return the List of ModificationEffectivities pointing in "-" toward a given UUID Filterable.
- o
QueryEffectivitiesPlus(SEQUENCE(octet)&,CATListOfCATICfgModification_var&)
- Return the List of ModificationEffectivities pointing in "+" toward a given UUID Filterable.
- o
QueryEffectivityByType(CATUnicodeString&,CATListOfCATICfgModification_var&)
- Return the List of ModificationEffectivities for this ConfigurableObject for a given type.
- o
Register(SEQUENCE(octet)&)
- Every Object keeping a persistent pointer toward this ConfigurableObject must register itself in order to avoid
the deletion of this ConfigurableObject.
- o
SetApplicativeConfiguration(CATICfgFilter_var&)
- Set the current configuration, given a Filter.
- o
UnRegister(SEQUENCE(octet)&)
- Cancel a registration.
Methods
o BelongsTo
public virtual HRESULT BelongsTo( | const CATIConfigurableObject_var& | iCV) = 0 |
-
Check if an input ConfigurableObject belongs (is instantiated) to this ConfigurableObject.
- Parameters:
-
- iCV
- The input ConfigurableObject.
o CheckRemove
public virtual HRESULT CheckRemove( | SEQUENCE(octet)& | iFilterable, |
| const CATUnicodeString& | iDomain, |
| const CATICfgEffectivity_var& | iEffectivities) =0 |
-
Check if it is possible to remove an input Effectivity from the Effectivity associated to a Filterable by
a given DomainName.
- Parameters:
-
- iFilterable
- The Filterable to cut.
- iDomain
- The Domain on which the cut is applied.
- iEffectivities
- The Effectivity used to cut.
o CheckRemove
public virtual HRESULT CheckRemove( | SEQUENCE(octet)& | iFilterable, |
| const CATUnicodeString& | iDomain, |
| const CATICfgORExpression_var& | iORExp)= 0 |
-
Check if it is possible to remove an input ORExpression from the ORExpression associated to a Filterable by
a given DomainName.
- Parameters:
-
- iFilterable
- The Filterable to cut.
- iDomain
- The Domain on which the cut is applied.
- iORExp
- The ORExpression used to cut.
o CreateConfigHandler
-
Create a new ConfigHandler associated to this ConfigurabeObject, given its Name and Description.
- Parameters:
-
- iId
- Name of the ConfigHandler.
- iDescription
- Description of the ConfigHandler.
- oConfigHandler
- ConfigHandler to create.
o CreateModificationEffectivity
public virtual HRESULT CreateModificationEffectivity( | CATICfgModification_var& | oModification) = 0 |
-
Create a new ModificationEffectivity, Name generated by the method, assiociated to this ConfigurableObject.
Postcondition: First, the method generates a Name for the ModificationEffectivity, and then apply
the method described just before.
- Parameters:
-
- oModification
- ModificationEffectivity to create.
o CreateModificationEffectivity
public virtual HRESULT CreateModificationEffectivity( | const CATUnicodeString& | iModName, |
| CATICfgModification_var& | oModification) = 0 |
-
Create a new ModificationEffectivity, given its Name, assiociated to this ConfigurableObject.
Postcondition: If a ModificationEffectivity of such a Name already exists, the method does nothing
and returns S_FALSE: in this case, oModification is the ModificationEffectivity already existing.
Else, a ModificationEffectivity is created, initialized, and added to the List of
ModificationEffectivities of this ConfigurableObject.
- Parameters:
-
- iModName
- Name of the ModificationEffectivity.
- oModification
- ModificationEffectivity returned.
o Delete
-
Delete this ConfigurableObject.
Postcondition: If it is used by other Objects, the method does nothing, returns E_FAIL and set
ErrorNumber 200. Else, the List of ModificationEffectivities and the List of ConfigHandler held
by this ConfigurableObject are deleted. At last, it is removed from the ConfigurableObject List of the
Configurable it is associated to.
o DisplayObjectsEffectivity
-
Return the effectivity XML string for each object.
- Parameters:
-
- iUUIDs
- list of object UUID.
- oEffectivities
- list of returned effectivity XML strings.
- Returns:
- An HRESULT value.
o GetApplicativeConfiguration
public virtual HRESULT GetApplicativeConfiguration( | CATICfgFilter_var& | oCfgFilter) const = 0 |
-
Return the current configuration as a Filter.
- Parameters:
-
- oCfgFilter
- Filter determining the current configuration.
o GetBSFFilter
-
Return a User defined Filter.
- Parameters:
-
- iBSFName
- Name of the Filter.
- oFilter
- Filter to return.
o GetConfigurable
public virtual HRESULT GetConfigurable( | CATIConfigurable_var& | oConfigurable) = 0 |
-
Return the Configurable owning this Configurableobject.
- Parameters:
-
- oConfigurable
- The Configurable to return.
o GetListOfConfigHandler
public virtual HRESULT GetListOfConfigHandler( | CATListValCATIConfigHandler_var& | oCfgandlerList) = 0 |
-
Return the List of ConfigHandler associated to this ConfigurableObject.
- Parameters:
-
- oCfgandlerList
- List of ConfigHandler.
o GetModificationList
public virtual HRESULT GetModificationList( | CATListValCATICfgModification_var& | oEffectivityList) const = 0 |
-
Return the List of all ModificationEffectivites belonging to this ConfigurableObject.
- Parameters:
-
- oEffectivityList
- List of ModificationEffectivities to return.
o GetModificationListByName
public virtual HRESULT GetModificationListByName( | const CATUnicodeString& | iModFlag, |
| CATListValCATICfgModification_var& | oEffectivityList) const = 0 |
-
Return the List of ModificationEffectivites, having the same given Name, belonging to this ConfigurableObject.
- Parameters:
-
- iModFlag
- Name of the ModificationEffectivites.
- oEffectivityList
- List of ModificationEffectivities to return (The size of the List cannot be greater than 1).
o GetName
-
Return the Name of this ConfigurableObject.
- Parameters:
-
- oName
- The ConfigurableObject Name.
o GetObject
public virtual HRESULT GetObject( | SEQUENCE(octet)& | oUID) const = 0 |
-
Return the UUID of the Object linked to this ConfigurableObject.
- Parameters:
-
- oUID
- UUID of the Object.
o GetProductName
-
Return the Name of the Object linked to this ConfigurableObject.
- Parameters:
-
- oName
- The Object Name.
o IsVersionable
public virtual HRESULT IsVersionable( | const CATILinkableObject_var& | iObj, |
| const CATTime& | iTime) const = 0 |
-
Check if an object can be versioned
- Parameters:
-
- iObj
- Object to check.
- iTime
- Date of versionning.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- iObj is versionable
- S_FALSE
- No error, but iObj is not versionable
- E_FAIL
- An error occured during the process
o QueryEffectivitiesByStatus
-
Return the List of ModificationEffectivities for this ConfigurableObject, where at least one of the X_Eff has a
Status included in an input StatusList.
- Parameters:
-
- iStatusList
- The input StatusList.
- oList
- The resulting List of ModificationEffectivities.
o QueryEffectivitiesMinus
-
Return the List of ModificationEffectivities pointing in "-" toward a given UUID Filterable.
- Parameters:
-
- iUUID
- UUID of the input Filterable.
- oList
- List of the ModificationEffectivities pointing in "-" toward this ItemInstance.
o QueryEffectivitiesPlus
-
Return the List of ModificationEffectivities pointing in "+" toward a given UUID Filterable.
- Parameters:
-
- iUUID
- UUID of the input Filterable.
- oList
- List of the ModificationEffectivities pointing in "+" toward this ItemInstance.
o QueryEffectivityByType
-
Return the List of ModificationEffectivities for this ConfigurableObject for a given type.
- Parameters:
-
- iType
- The input type.
- oList
- The resulting List of ModificationEffectivities.
o Register
public virtual HRESULT Register( | const SEQUENCE(octet)& | iUuid)=0 |
-
Every Object keeping a persistent pointer toward this ConfigurableObject must register itself in order to avoid
the deletion of this ConfigurableObject.
- Parameters:
-
- iUuid
- UUID of the Object to register.
o SetApplicativeConfiguration
public virtual HRESULT SetApplicativeConfiguration( | CATICfgFilter_var& | iFilter) = 0 |
-
Set the current configuration, given a Filter.
- Parameters:
-
- iFilter
- Filter determining the current configuration.
o UnRegister
public virtual HRESULT UnRegister( | const SEQUENCE(octet)& | iUuid) =0 |
-
Cancel a registration.
- Parameters:
-
- iUuid
- UUID of the object to unregister.
This object is included in the file: CATIConfigurableObject.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces