All Frameworks Class Hierarchy This Framework Indexes Previous Next

PLMSetupDataInterfaces Interface PLMISetupDataFinder

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

interface PLMISetupDataFinder

Interface used to find Setup data contained in the Application Resources Tables specifics to the current P&O Context.
A P&O context is defined by notions like User, Role, Organization, Project, ... This context is set when the user logs in, which gives him access to a defined set of applicative resources. This class manages internally a list of the Resources Tables that are linked to the current P&O Context. The goal of this interface is to ease the usage of each supported resource types for application. Note that the life cycle of the PLM resources loaded with a Setup Data Finder instance is linked to the life cycle of this finder.

Method Index

o FindDocument(CATUnicodeString&,CATICkeObject_var&,CATUnicodeString&): Retrieves the document (Text or XML document) pointed by the item stored in the current managed tables whose identifier is equal to the given one.
o FindPointedResource(CATUnicodeString&,CATICkeObject_var&,CATBaseUnknown_var&): Retrieves the resource pointed by the item stored in the current managed tables whose identifier is equal to the given one and who is fitting the given criteria values.
o FindSheet(CATUnicodeString&,CATICkeObject_var&,CATICkeSheet_var&): Retrieves the sheet pointed by the item stored in the current managed tables whose identifier is equal to the given one.

Methods

o FindDocument

public virtual FindDocument(	const	`iSetupDataUsageID`,
	const	`iCriteriaValues`,
		`oProjectedDocumentPath`)

Retrieves the document (Text or XML document) pointed by the item stored in the current managed tables whose identifier is equal to the given one.

Parameters:

iSetupDataUsageID: The given identifier of the resource item containing the expected pointed resource. The Setup Data Usage ID consists in a couple of strings representing the Resource Set Id and the Resource Id with the following pattern : “AppResourceSetId|ResourceId”.
iCriteriaValues: For the moment, this argument is useless. Simply pass NULL_var.
oProjectedDocumentPath: The path of the retrieved pointed document if successful The document is automatically projected on the local disk by this method.

Returns:

S_OK if a resource item has been found with the given identifier and criteria values, E_FAIL otherwise

o FindPointedResource

public virtual FindPointedResource(	const	`iSetupDataUsageID`,
	const	`iCriteriaValues`,
		`oResource`)

Retrieves the resource pointed by the item stored in the current managed tables whose identifier is equal to the given one and who is fitting the given criteria values.

Parameters:

iSetupDataUsageID: The given identifier of the resource item containing the expected pointed resource. The Setup Data Usage ID consists in a couple of strings representing the Resource Set Id and the Resource Id with the following pattern : “AppResourceSetId|ResourceId”.
iCriteriaValues: For the moment, this argument is useless. Simply pass NULL_var.
oResource: The retrieved pointed resource if successful, NULL_var otherwise

Returns:

S_OK if a resource item has been found with the given identifier and criteria values, E_FAIL otherwise

o FindSheet

public virtual FindSheet(	const	`iSetupDataUsageID`,
	const	`iCriteriaValues`,
		`oSheet`)

Retrieves the sheet pointed by the item stored in the current managed tables whose identifier is equal to the given one.

Parameters:

iSetupDataUsageID: The given identifier of the resource item containing the expected pointed resource. The Setup Data Usage ID consists in a couple of strings representing the Resource Set Id and the Resource Id with the following pattern : “AppResourceSetId|ResourceId”.
iCriteriaValues: For the moment, this argument is useless. Simply pass NULL_var.
oSheet: The retrieved pointed sheet if successful, NULL_var otherwise

Returns:

S_OK if a resource item has been found with the given identifier and criteria values, E_FAIL otherwise

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