DELPPRAuthFoundationInterfaces Interface DELIPPRUIServices

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

interface DELIPPRUIServices

Interface to access to PPR UI services

Method Index

o AddPPRRootToCurrentEditor(CATBaseUnknown_var&): Add a Root to the current Editor.
o GetPPRRootsFromCurrentEditor(CATListValCATBaseUnknown_var&,DELIPPRUIServices::PPRRootType&): Returns the list of roots from a given PPR root type.

Methods

o AddPPRRootToCurrentEditor

public virtual AddPPRRootToCurrentEditor( const ispRootReference)

Add a Root to the current Editor. To be explicit, this method allows adding a Root under the PPRContext available in current PPR Editor The root object is supposed to be already typed and to be a reference (that is to say : a Product Reference or a Resource Reference or a System Reference or a Process Reference).

Parameters:

ispRoot: The Root reference to add. It can be a Resource, a Product, a System or a Process.

Returns:

Legal values:

S_OK: if the method succeeds
S_FALSE: if the root given as input argument of the method is already a Root of the PPR Context
E_INVALIDARG: if the method does not recognize the input argument as an object which would be able to be a Root.
E_FAIL: if the method fails for any other reason

o GetPPRRootsFromCurrentEditor

public virtual GetPPRRootsFromCurrentEditor(		`iospRoots`,
		`iRootType`)

Returns the list of roots from a given PPR root type.

Parameters:

iospRoots: The list of roots
iRootType: PPR Root type

Returns:

Legal values:

S_OK: if the method succeeds
S_FALSE: if the method succeeds but the list of roots is empty
E_FAIL: if the method fails for any other reason

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