All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATRepTemplateUseItf Interface CATIUdfFeatureInstance

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

interface CATIUdfFeatureInstance

Interface to edit a User Feature instance.
Role: This interface is implemented on a User Feature to modify it. You can change its inputs or/and modify the value of its published parameters.
Note:Before any calls, you must call , and the last call must be .

Method Index

o FilterInput(int,CATPathElement*,CATPathElement**): Filters the selection.
o FilterInput(CATUnicodeString&,CATPathElement*,CATPathElement**): Filters the selection.
o GetInput(int,CATBaseUnknown_var&): Retrieves one input.
o GetInput(CATUnicodeString&,CATBaseUnknown_var&): Retrieves one input.
o GetInputRole(int,CATUnicodeString&): Retrieves the role of one input.
o GetInputsNumber(int&): Retrieves the input count.
o GetOutput(int,CATBaseUnknown_var&): Retrieves one output.
o GetOutput(CATUnicodeString&,CATBaseUnknown_var&): Retrieves one output.
o GetOutputsNumber(int&): Retrieves the output count.
o GetParameter(CATUnicodeString&,CATBaseUnknown_var&): Retrieves a published parameter from its role.
o GetParameterRole(CATBaseUnknown_var&,CATUnicodeString&): Retrieves the role of a published parameter.
o GetParameters(CATListValCATBaseUnknown_var*&): Retrieves all published parameters.
o GetSourceInput(CATUnicodeString&,CATBaseUnknown_var&): Retrieves the source input.
o Init(): Initializes the modification transaction.
o Reset(): Ends the modification transaction.
o SetNewInput(int,CATPathElement*): Changes one input.
o SetNewInput(CATUnicodeString&,CATPathElement*): Changes one input.

Methods

o FilterInput

public virtual FilterInput(	const	`iPos`,
		`iSelection`,
		`oFilteredSelection`)

Filters the selection.

Parameters:

iPos: Input position, from 1 to
iSelection: A CATPathElement with the new object, this path must contains the full selection path for a valid import mechanism in multidocument context.
oFilteredSelection: A subpath of iSelection

Returns:

classic HRESULT

o FilterInput

public virtual FilterInput(	const	`iRole`,
		`iSelection`,
		`oFilteredSelection`)

Filters the selection.

Parameters:

iRole: The role of the input.
The role of an input, is the NLS String which appears in the instantiate or in the edit dialog box.
iSelection: A CATPathElement with the new object, this path must contains the full selection path for a valid import mechanism in multidocument context.
oFilteredSelection: A subpath of iSelection

Returns:

classic HRESULT

o GetInput

public virtual GetInput(	const	`iPos`,
		`oInput`)

Retrieves one input.
Role:This method returns the iPos input. You can consult the returned input, but don't try to modify it. Use the method to change it.

Parameters:

iPos: Input position, from 1 to
oInput: The iPos input.

Returns:

classic HRESULT

o GetInput

public virtual GetInput(	const	`iRole`,
		`oInput`)

Retrieves one input.
Role:This method returns an input from its role. You can consult the returned input, but don't try to modify it. Use the method to change it.

Parameters:

iRole: The role of the input.
The role of an input, is the NLS String which appears in the instantiate or in the edit dialog box.
oInput: The input.

Returns:

classic HRESULT

o GetInputRole

public virtual GetInputRole(	const	`iPos`,
		`oRole`)

Retrieves the role of one input.

Parameters:

iPos: Input position, from 1 to
oRole: The role of the iPos input.
The role of an input, is the NLS String which appears in the instantiate or in the edit dialog box.
Note:The iPos role is the same for all instances, it is independant of the current instance.

Returns:

classic HRESULT

o GetInputsNumber

public virtual GetInputsNumber( oInputCount)

Retrieves the input count.

Parameters:

oInputCount: Count of inputs.
Note:This value is the same for all instances, it is independant of the current instance.

Returns:

classic HRESULT

o GetOutput

public virtual GetOutput(	const	`iPos`,
		`oOutput`)

Retrieves one output.
Role:This method returns the iPos output.

Parameters:

iPos: Input position, from 1 to
oOutput: The iPos output.

Returns:

classic HRESULT

o GetOutput

public virtual GetOutput(	const	`iRole`,
		`oInput`)

Retrieves one output.
Role:This method returns an output from its role.

Parameters:

iRole: The role of the output.
The role of an output is the Name of the ouput which appears in the tree
oInput: The input.

Returns:

classic HRESULT

o GetOutputsNumber

public virtual GetOutputsNumber( oOutputCount)

Retrieves the output count.

Parameters:

oOutputCount: Count of outputs.
Note:This value is the same for all instances, it is independant of the current instance.

Returns:

classic HRESULT

o GetParameter

public virtual GetParameter(	const	`iRole`,
		`oParam`)

Retrieves a published parameter from its role.

Parameters:

iRole: The role of the parameter you want to retrieve.
The role of a parameter, is the NLS String which appears in the instantiate or in the edit dialog box and it is the string in the specifications tree under the User Feature instance or reference.
oParam: A published parameter.
Use the CATICkeParm to modify it.

Returns:

classic HRESULT

o GetParameterRole

public virtual GetParameterRole(	const	`iParam`,
		`oRole`)

Retrieves the role of a published parameter.

Parameters:

iParam: A published parameter which must be one of the list given by
oRole: The role of the iParam parameter.
The role of a parameter, is the NLS String which appears in the instantiate or in the edit dialog box and it is the string in the specifications tree under the User Feature instance or reference.
Note:Roles are independant of the current instance.

Returns:

classic HRESULT

o GetParameters

public virtual GetParameters( oParametersList)

Retrieves all published parameters.

Parameters:

oParametersList: liste of published parameters.
Use the CATICkeParm to modify them.

Returns:

classic HRESULT

o GetSourceInput

public virtual GetSourceInput(	const	`iRole`,
		`oSourceInput`)

Retrieves the source input.
Role:If the input is an external reference, it returns the reference of this external reference. Otherwise it returns the input. See .

Parameters:

iRole: The role of the input.
The role of an input, is the NLS String which appears in the instantiate or in the edit dialog box.
oSourceInput: The source input.

Returns:

Legal values:

S_OK: The source input is retrieved.
E_FAIL: The source input is not retrieved, for instance because the reference of the external reference is not loaded.

o Init

public virtual Init(

)

Initializes the modification transaction.
Role: Need to be called before all other services in one transaction. At the end of the transaction, call to clean internal data.

Returns:: classic HRESULT

o Reset

public virtual Reset(

)

Ends the modification transaction.
Role:: Need to be called at the end of a modification transaction to clean all internal data. At the beginning of the transation, you have call the method.

Returns:: classic HRESULT

o SetNewInput

public virtual SetNewInput(	const	`iPos`,
		`iSelection`)

Changes one input.
Role:This method replaces the iPos input by the new one.

Parameters:

iPos: Input position, from 1 to
iSelection: A CATPathElement with the new object, this path must contains the full selection path for a valid import mechanism in multidocument context.

Returns:

classic HRESULT

o SetNewInput

public virtual SetNewInput(	const	`iRole`,
		`iSelection`)

Changes one input.
Role:This method replaces the input whose role is iRole by the new one.

Parameters:

iRole: The role of the input.
The role of an input, is the NLS String which appears in the instantiate or in the edit dialog box.
iSelection: A CATPathElement with the new object, this path must contains the full selection path for a valid import mechanism in multidocument context.

Returns:

classic HRESULT

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