FeatureModelerExt CATFmCredentials
Usage: you must use this class as is. You should never derive it.
public class CATFmCredentials
Class representing an Accreditations Set.
Role: Applications must provide Accreditations to be allowed to interact with Feature Modeler entities.
Accreditations are obtained through and stored within this ( ) class.
Accreditations are used to determine what operations are allowed for each object type: Feature, Feature Definition (StartUp) or Container.
The registration methods can be called several times. An application with several catalogs will want to claim the ownership for each of them.
An application can also be based on several infrastructures (when applicable only) and want to declare itself accordingly.
- See also:
- , , ,
Constructor and Destructor Index
- o
CATFmCredentials()
- Constructs an empty Set of Accreditations.
- o
CATFmCredentials(CATFmCredentials&)
- Copy constructor.
- o
~CATFmCredentials()
- Destructor.
Method Index
- o
RegisterAsApplicationBasedOn(CATFmInfrastructureID&,CATUnicodeString&)
- Registers oneself as an Application based on a given infrastructure.
- o
RegisterAsCatalogOwner(CATUnicodeString&,CATUnicodeString&)
- Registers oneself as the owner of a Feature Catalog.
- o
operator+=(CATFmCredentials&)
- Addition assignment operator.
- o
operator=(CATFmCredentials&)
- Assignment operator.
Constructor and Destructor
o CATFmCredentials
| public CATFmCredentials( | ) |
-
Constructs an empty Set of Accreditations.
o CATFmCredentials
| public CATFmCredentials( | const | iCredentials) |
-
Copy constructor.
Role: This method creates an exact copy of a Credentials object.
- Parameters:
-
- iCredentials
- [in] The Credentials object to copy.
o ~CATFmCredentials
| public ~CATFmCredentials( | ) |
-
Destructor.
Methods
o RegisterAsApplicationBasedOn
| public RegisterAsApplicationBasedOn( | const | iInfrastructureId, |
| const | iPartnerId) |
-
Registers oneself as an Application based on a given infrastructure.
Role: This method allows the caller to be known as being based on a given infrastructure.
The scope of actions that will be allowed after a successfull registration will depend on each infrastructure.
FeatureModeler infrastructure.
Being known as a client of Feature Modeler infrastructure grants some rights to access containers.
Allowed actions are then:
- Registering as the owner of a Feature Catalog (
).
- Instantiation of Features (the ownership of which has been successfully claimed) in any container that has no specific access control.
- Scanning any container that has no specific access control for Features (the ownership of which has been successfully claimed).
Other infrastructures.
Refer to each application CAA documentation.
- Parameters:
-
- iInfrastructure
- [in] The Infrastructure Id. The Infrastructure Id of Feature Modeler is defined in CATFmFeatureModelerID.h.
Whether other Infrastructure Ids exist or not will depend on the level and choosen configuration.
- iPartnerId
- [in] The Partner Id. To be valid, it must be a non-empty string containing only (ASCII-7) letters and digits,
and must also not start with a digit.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The operation completed successfully.
- E_INVALIDARG
- iPartnerId is not valid.
- E_UNEXPECTED
- The application has already successfully been register with another PartnerId.
- Other
- Another failure has occured.
- See also:
-
o RegisterAsCatalogOwner
| public RegisterAsCatalogOwner( | const | iCatalogName, |
| const | iCatalogClientId) |
-
Registers oneself as the owner of a Feature Catalog.
Role: This method allows the caller to be known as the owner of a given Feature Catalog.
Being known by Feature Modeler as the owner of a catalog grants full control rights to the Feature instances.
A successful registration as an application based on Feature Modeler (RegisterAsApplicationBasedOn(CATFmFeatureModelerID, ...) is required,
any attempt to register as a catalog owner would otherwise necessarily fail.
- Parameters:
-
- iCatalogName
- [in] The catalog name (without its ".CATfct" extension).
- iCatalogClientId
- [in] Authentication of the request. This is the value of the "-client-id" argument used with the CATFctEditorAssistant.
If iCatalogClientId is null, the Partner Id provided to register as an application based on Feature Modeler is used.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The operation completed successfully.
- E_FMOPERATIONNOTALLOWED
- The operation can succeed only when registered as an application based on Feature Modeler (see
).
- E_INVALIDARG
- iCatalogName is not the name of a valid catalog.
- E_ACCESSDENIED
- iCatalogClientId is not correct.
- E_FMNOPLMSESSION
- No PLM session has been sucessfully opened.
- Other
- Another failure has occured.
- See also:
- ,
o operator+=
| public operator+=( | const | iCredentials) |
-
Addition assignment operator.
Role: This method adds the Accrediations of another Credentials object to this Credentials object.
- Parameters:
-
- iCredentials
- [in] The Credentials object to incorporate.
o operator=
| public operator=( | const | iCredentials) |
-
Assignment operator.
Role: This method transforms this Credentials object an exact copy of another Credentials object.
- Parameters:
-
- iCredentials
- [in] The Credentials object to copy.
This object is included in the file: CATFmCredentials.h
If needed, your Imakefile.mk should include the module: FeatureModelerExt
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.