All Categories  Class Hierarchy  This Category  Next  Indexes

Miscellaneous Class CATCfgUsrCfgHandler

CATCfgUsrCfgHandler

public class CATCfgUsrCfgHandler

A configuration handler.

Constructor and Destructor Index

o ~CATCfgUsrCfgHandler(): Destructor.

Method Index

o AddBrother(CATCfgUsrCfgHandler*): Create a brother relationship with a configuration handler.
o AddChild(CATCfgUsrCfgHandler*): Create a child relationship with a configuration handler.
o AddOption(CATUnicodeString&): Add an option to this configuration handler.
o Create(CATDMUsrInstance&,CATUnicodeString&,CATUnicodeString&,CATCfgUsrCfgHandler*&): Create an empty configuration handler.
o Delete(): Delete this configuration handler.
o GetBrothers(CATLISTP(CATCfgUsrCfgHandler)&): Retrieve the list of brother configuration handlers.
o GetChildren(CATLISTP(CATCfgUsrCfgHandler)&): Retrieve the list of child configuration handlers.
o GetCurrentDateFlag(boolean&): Retrieve the current date flag for this configuration handler.
o GetDate(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Retrieve the date effectivity for this configuration handler.
o GetDate(time_t&,time_t&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Retrieve the date effectivity for this configuration handler.
o GetDescription(CATUnicodeString&): Retrieve this configuration handler description.
o GetId(CATUnicodeString&): Retrieve the configuration handler identifier.
o GetIdList(CATDMUsrInstance&,CATLISTV(CATUnicodeString)&): Get all configuration handler identifiers attached to a part.
o GetList(CATDMUsrInstance&,CATLISTP(CATCfgUsrCfgHandler)&): Get all configuration handlers attached to a part.
o GetModifications(CATLISTV(CATUnicodeString)&): Retrieve the modification effectivity for this configuration handler.
o GetOptions(CATLISTV(CATUnicodeString)&): Retrieve the option effectivity for this configuration handler.
o GetOrganization(CATUnicodeString&): Retrieve this configuration handler owning organization.
o GetOwner(CATUnicodeString&): Retrieve this configuration handler owner.
o GetPlannedEffectivity(int&): Retrieve the planned effectivity flag for this configuration handler.
o GetProduct(CATDMUsrInstance&): Retrieve the product to which this configuration handler is attached.
o GetRange(int&,int&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Retrieve the range effectivity for this configuration handler.
o GetVisibility(CATUnicodeString&): Retrieve the visibility of this configuration handler.
o IsDeleted(): Check if this configuration handler object has been performed a Delete operation.
o ModifyOption(CATUnicodeString&,int): Modify an option of this configuration handler.
o ModifyOwnership(CATUnicodeString&,CATUnicodeString&): Transfer the ownership of this configuration handler.
o QueryByName(CATDMUsrInstance&,CATUnicodeString&,CATCfgUsrCfgHandler*&): Get a configuration handler by its name.
o RemoveBrother(CATCfgUsrCfgHandler*): Remove a brother relationship with a configuration handler.
o RemoveChild(CATCfgUsrCfgHandler*): Remove a child relationship with a configuration handler.
o RemoveOption(CATUnicodeString&): Remove an option from this configuration handler.
o SetCurrentDateFlag(boolean): Set the current date flag for this configuration handler.
o SetDate(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Set the date effectivity for this configuration handler.
o SetDate(time_t,time_t,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Set the date effectivity for this configuration handler.
o SetDescription(CATUnicodeString&): Set this configuration handler description.
o SetPlannedEffectivity(int): Set the planned effectivity flag for this configuration handler.
o SetRange(int,int,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Set the range effectivity for this configuration handler.
o SetVisibility(CATUnicodeString&): Set the visibility of this configuration handler.

Constructor and Destructor

o ~CATCfgUsrCfgHandler

public ~CATCfgUsrCfgHandler(

)

Destructor.

Methods

o AddBrother

public Error AddBrother( CATCfgUsrCfgHandler* iBrother)

Create a brother relationship with a configuration handler.

Parameters:

iBrother: Configuration handler to define as a brother.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o AddChild

public Error AddChild( CATCfgUsrCfgHandler* iChild)

Create a child relationship with a configuration handler.

Parameters:

iBrother: Configuration handler to define as a brother.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o AddOption

public Error AddOption( const CATUnicodeString& iOption)

Add an option to this configuration handler.

Parameters:

iOption: Option.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o Create

public static Error Create(	const CATDMUsrInstance&	`iProduct`,
	const CATUnicodeString&	`iCHId`,
	const CATUnicodeString&	`iDescription`,
	CATCfgUsrCfgHandler*&	`oCfgHandler`)

Create an empty configuration handler.

Parameters:

iProduct: Part the configuration handler is to be attached to.
iCHId: Configuration handler identifier.
iDescription: Configuration handler description.
oCfgHandler: Created configuration handler.
It is the caller's responsibility to free the returned object thanks to the delete operator.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o Delete

public Error Delete(

)

Delete this configuration handler.
This object may not be used any more after a successful deletion.

Returns:: Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetBrothers

public Error GetBrothers( CATLISTP(CATCfgUsrCfgHandler)& oBrothers) const

Retrieve the list of brother configuration handlers.

Parameters:

oBrothers: List of found configuration handlers.
It is the caller's responsibility to free each returned object thanks to the delete operator.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetChildren

public Error GetChildren( CATLISTP(CATCfgUsrCfgHandler)& oBrothers) const

Retrieve the list of child configuration handlers.

Parameters:

oChildren: List of found configuration handlers.
It is the caller's responsibility to free each returned object thanks to the delete operator.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetCurrentDateFlag

public Error GetCurrentDateFlag( boolean& oCurrentFlag) const

Retrieve the current date flag for this configuration handler.

Parameters:

oCurrentFlag: Current date flag.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetDate

public Error GetDate(	CATUnicodeString&	`oStartDate`,
	CATUnicodeString&	`oEndDate`,
	CATUnicodeString&	`oStartMilestonePgm`,
	CATUnicodeString&	`oStartMilestone`,
	CATUnicodeString&	`oEndMilestonePgm`,
	CATUnicodeString&	`oEndMilestone`) const

Retrieve the date effectivity for this configuration handler.

Parameters:

oStartDate: Start date with "YYYY-MM-DD" format.
oEndDate: End date with "YYYY-MM-DD" format (Empty string for infinity).
oStartMilestonePgm: Program name for milestone of starting date.
oStartMilestone: Name for milestone of starting date.
oEndMilestonePgm: Program name for milestone of end date.
oEndMilestone: Name for milestone of end date.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetDate

public Error GetDate(	time_t&	`oStartDate`,
	time_t&	`oEndDate`,
	CATUnicodeString&	`oStartMilestonePgm`,
	CATUnicodeString&	`oStartMilestone`,
	CATUnicodeString&	`oEndMilestonePgm`,
	CATUnicodeString&	`oEndMilestone`) const

Retrieve the date effectivity for this configuration handler.

Parameters:

oStartDate: Start date.
oEndDate: End date (=0 for infinity).
oStartMilestonePgm: Program name for milestone of starting date.
oStartMilestone: Name for milestone of starting date.
oEndMilestonePgm: Program name for milestone of end date.
oEndMilestone: Name for milestone of end date.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetDescription

public Error GetDescription( CATUnicodeString& oDescription) const

Retrieve this configuration handler description.

Parameters:

oDescription: Configuration handler description.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetId

public Error GetId( CATUnicodeString& oId) const

Retrieve the configuration handler identifier.

Parameters:

oId: Configuration handler identifier.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetIdList

public static Error GetIdList(	const CATDMUsrInstance&	`iProduct`,
	CATLISTV(CATUnicodeString)&	`oCfgHnldrIds`)

Get all configuration handler identifiers attached to a part.

Parameters:

iProduct: Part the searched configuration handlers are attached to.
oCfgHandlerIds: List of found configuration handler identifiers.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetList

public static Error GetList(	const CATDMUsrInstance&	`iProduct`,
	CATLISTP(CATCfgUsrCfgHandler)&	`oCfgHandlers`)

Get all configuration handlers attached to a part.

Parameters:

iProduct: Part the searched configuration handlers are attached to.
oCfgHandlers: List of found configuration handlers.
It is the caller's responsibility to free each returned object thanks to the delete operator.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetModifications

public Error GetModifications( CATLISTV(CATUnicodeString)& oModifs) const

Retrieve the modification effectivity for this configuration handler.

Parameters:

oModifs: List of modifications.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetOptions

public Error GetOptions( CATLISTV(CATUnicodeString)& oOptions) const

Retrieve the option effectivity for this configuration handler.

Parameters:

oOptions: List of options.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetOrganization

public Error GetOrganization( CATUnicodeString& oOrganization) const

Retrieve this configuration handler owning organization.

Parameters:

oOrganization: Owning organization.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetOwner

public Error GetOwner( CATUnicodeString& oOwner) const

Retrieve this configuration handler owner.

Parameters:

oOwner: Owner.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetPlannedEffectivity

public Error GetPlannedEffectivity( int& oPlannedEffFlag) const

Retrieve the planned effectivity flag for this configuration handler.

Parameters:

oPlannedEffFlag

Planned effectivity flag.
Legal values:

=-1: Undefined
=0: Unset
=1: Set

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetProduct

public Error GetProduct( CATDMUsrInstance& oProduct) const

Retrieve the product to which this configuration handler is attached.

Parameters:

oProduct: The product part.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetRange

public Error GetRange(	int&	`oBottomRange`,
	int&	`oTopRange`,
	CATUnicodeString&	`oBottomMilestonePgm`,
	CATUnicodeString&	`oBottomMilestone`,
	CATUnicodeString&	`oTopMilestonePgm`,
	CATUnicodeString&	`oTopMilestone`) const

Retrieve the range effectivity for this configuration handler.

Parameters:

oBottomRange: Bottom range.
oEndDate: Top range (=0 for infinity).
oBottomMilestonePgm: Program name for milestone of bottom range.
oBottomMilestone: Name for milestone of bottom range.
oTopMilestonePgm: Program name for milestone of top range.
oTopMilestone: Name for milestone of top range.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o GetVisibility

public Error GetVisibility( CATUnicodeString& oVisibility) const

Retrieve the visibility of this configuration handler.

Parameters:

oVisibility

Visibility.
Legal values:

PUBLIC
PRIVATE
DATAGROUP

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o IsDeleted

public boolean IsDeleted(

)

Check if this configuration handler object has been performed a Delete operation.

o ModifyOption

public Error ModifyOption(	const CATUnicodeString&	`iOption`,
	int	`iOptionState`	`=1`)

Modify an option of this configuration handler.

Parameters:

iOption

Option to modify.

iOptionState

State of the option.
Legal values:

-1 : Not selected.
0 : Undefined (Advanced configuration mode only).
1 : Selected by user.
2 : Selected by rules.
3 : Rejected by user.
4 : Rejected by rules.
5 : Ignored (Advanced configuration mode only).

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o ModifyOwnership

public Error ModifyOwnership(	const CATUnicodeString&	`iOwner`,
	const CATUnicodeString&	`iOrganization`)

Transfer the ownership of this configuration handler.

Parameters:

sOwner: New owner.
iOrganization: New owning organization.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o QueryByName

public static Error QueryByName(	const CATDMUsrInstance&	`iProduct`,
	const CATUnicodeString&	`iCHId`,
	CATCfgUsrCfgHandler*&	`oCfgHandler`)

Get a configuration handler by its name.

Parameters:

iProduct: Part the searched configuration handler is attached to.
iCHId: Configuration handler identifier.
oCfgHandler: Found configuration handler or 0.
It is the caller's responsibility to free the possibly returned object thanks to the delete operator.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o RemoveBrother

public Error RemoveBrother( CATCfgUsrCfgHandler* iBrother)

Remove a brother relationship with a configuration handler.

Parameters:

iBrother: Brother configuration handler to detach.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o RemoveChild

public Error RemoveChild( CATCfgUsrCfgHandler* iChild)

Remove a child relationship with a configuration handler.

Parameters:

iBrother: Child configuration handler to detach.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o RemoveOption

public Error RemoveOption( const CATUnicodeString& iOption)

Remove an option from this configuration handler.

Parameters:

iOption: Option.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o SetCurrentDateFlag

public Error SetCurrentDateFlag( boolean iCurrentFlag)

Set the current date flag for this configuration handler.

Parameters:

iCurrentFlag: Current date flag.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o SetDate

public Error SetDate(	const CATUnicodeString&	`iStartDate`,
	const CATUnicodeString&	`iEndDate`,
	const CATUnicodeString&	`iStartMilestonePgm`	`=""`,
	const CATUnicodeString&	`iStartMilestone`	`=""`,
	const CATUnicodeString&	`iEndMilestonePgm`	`=""`,
	const CATUnicodeString&	`iEndMilestone`	`=""`)

Set the date effectivity for this configuration handler.

Parameters:

iStartDate: Start date with "YYYY-MM-DD" format.
iEndDate: End date with "YYYY-MM-DD" format (Empty string for infinity).
iStartMilestonePgm: Program name for milestone of starting date.
iStartMilestone: Name for milestone of starting date.
iEndMilestonePgm: Program name for milestone of end date.
iEndMilestone: Name for milestone of end date.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o SetDate

public Error SetDate(	time_t	`iStartDate`,
	time_t	`iEndDate`,
	const CATUnicodeString&	`iStartMilestonePgm`	`=""`,
	const CATUnicodeString&	`iStartMilestone`	`=""`,
	const CATUnicodeString&	`iEndMilestonePgm`	`=""`,
	const CATUnicodeString&	`iEndMilestone`	`=""`)

Set the date effectivity for this configuration handler.

Parameters:

iStartDate: Start date.
iEndDate: End date (=0 for infinity).
iStartMilestonePgm: Program name for milestone of starting date.
iStartMilestone: Name for milestone of starting date.
iEndMilestonePgm: Program name for milestone of end date.
iEndMilestone: Name for milestone of end date.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o SetDescription

public Error SetDescription( const CATUnicodeString& iDescription)

Set this configuration handler description.

Parameters:

iDescription: Configuration handler description.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o SetPlannedEffectivity

public Error SetPlannedEffectivity( int iPlannedEffFlag)

Set the planned effectivity flag for this configuration handler.

Parameters:

iPlannedEffFlag

Planned effectivity flag.
Legal values:

=-1: Undefined
=0: Unset
=1: Set

Returns:

Error structure.

o SetRange

public Error SetRange(	int	`iBottomRange`,
	int	`iTopRange`,
	const CATUnicodeString&	`iBottomMilestonePgm`	`=""`,
	const CATUnicodeString&	`iBottomMilestone`	`=""`,
	const CATUnicodeString&	`iTopMilestonePgm`	`=""`,
	const CATUnicodeString&	`iTopMilestone`	`=""`)

Set the range effectivity for this configuration handler.

Parameters:

iBottomRange: Bottom range.
iEndDate: Top range (=0 for infinity).
iBottomMilestonePgm: Program name for milestone of bottom range.
iBottomMilestone: Name for milestone of bottom range.
iTopMilestonePgm: Program name for milestone of top range.
iTopMilestone: Name for milestone of top range.

Returns:

Error structure.
It is the caller's responsibility to free the possibly returned character strings through the delete [] operator.

o SetVisibility

public Error SetVisibility( const CATUnicodeString& iVisibility)

Set the visibility of this configuration handler.

Parameters:

iVisibility

Visibility.
Legal values:

PUBLIC
PRIVATE
DATAGROUP

Returns:

Error structure.

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