KnowledgeInterfaces Interface CATIObjectRightsManager
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIObjectRightsManager
Interface dedicated to feature protection management.
Role: manages informations to protect in edition, browse or execution or deletion a feature.
It has several types of protection :
Frozen (the protection could never be changed),
CAA (CAA applicative protection),
Setting (setting protection),
The protection can also be protected by a key (like a password it needs to change the protection)
The feature can be protected in exectution depending on a license.
Method Index
- o
GetProtectionType(CATProtectionType&)
- Get the protection type to the current object.
- o
GetRight(CATKweRight&)
- Get the protection rights of the current object.
- o
IsBrowsable(int&,CATUnicodeString*)
- Tests if the object is browsable.
- o
IsEditable(int&,CATUnicodeString*)
- Tests if the object is editable.
- o
IsLicensed(int&)
- Test if the object is runnable depending on licenses.
- o
IsRunnable(int&,CATUnicodeString*)
- Tests if the object is runnable.
- o
SetLicense(CATListOfCATUnicodeString&)
- Allow the object to be runnable only with the defined list of licenses.
- o
SetRight(CATKweRight&,CATProtectionType&,CATUnicodeString&)
- Set the protection level to the current object.
Enumerated Type Index
- o
CATProtectionType
- Type defining the protection of the rights of a feature.
Methods
o GetProtectionType
| public virtual GetProtectionType( | | oProtectionType) |
-
Get the protection type to the current object.
- Parameters:
-
- oProtectionType
- the protection type : NoType,Frozen,Setting or CAA
- Returns:
- E_FAIL if the method fails, S_OK else
o GetRight
| public virtual GetRight( | | oRight) |
-
Get the protection rights of the current object.
- Parameters:
-
- oRight
- The protection rights are either:
- Returns:
- E_FAIL if the method fails, S_OK else
o IsBrowsable
| public virtual IsBrowsable( | | oResult, |
| | oExplain | = NULL) |
-
Tests if the object is browsable.
- Parameters:
-
- oResult
- 0 if the object is not browsable, 1 else
- oExplain
- If oExplain is not NULL when calling method, it contains the reason why the object is not browsable.
- Returns:
- E_FAIL if the method fails, S_OK else
o IsEditable
| public virtual IsEditable( | | oResult, |
| | oExplain | = NULL) |
-
Tests if the object is editable.
- Parameters:
-
- oResult
- 0 if the object is not editable, 1 else
- oExplain
- If oExplain is not NULL when calling method, it contains the reason why the object is not editable.
- Returns:
- E_FAIL if the method fails, S_OK else
o IsLicensed
| public virtual IsLicensed( | | oResult) |
-
Test if the object is runnable depending on licenses.
- Parameters:
-
- oResult
- 0 if the object is not licensed, 1 else.
- Returns:
- E_FAIL if the method fails, S_OK else
o IsRunnable
| public virtual IsRunnable( | | oResult, |
| | oExplain | = NULL) |
-
Tests if the object is runnable.
- Parameters:
-
- oResult
- 0 if the object is not runnable, 1 else
- oExplain
- If oExplain is not NULL when calling method, it contains the reason why the object is not runnable.
- Returns:
- E_FAIL if the method fails, S_OK else
o SetLicense
| public virtual SetLicense( | const | iListLicense) |
-
Allow the object to be runnable only with the defined list of licenses.
- Parameters:
-
- iListLicense
- the list of necessary licenses
- Returns:
- E_FAIL if the method fails, S_OK else
o SetRight
| public virtual SetRight( | const | iRight, |
| const | iProtectionType | = Frozen, |
| const | iKey | = "") |
-
Set the protection level to the current object.
- Parameters:
-
- iRight
- the protection rights are either :
or CATRightKweDelete.
example : CATRightTypeBrowse | CATRightKweDelete
- iProtectionType
- the protection types are either :
Setting means that the right come from a setting,
CAA means that the right is defined by a CAA Application.
- iKey
- a key to allow to change the right
- Returns:
- E_FAIL if the method fails, S_OK else
Enumerated Types
o CATProtectionType
-
enum CATProtectionType {
NoType,
Frozen,
Setting,
CAA
}
Type defining the protection of the rights of a feature.
- Parameters:
-
- NoType
- There is no protection
- Frozen
- The rights can't be changed
- Setting
- The rights can be modified through settings
- CAA
- The rights can be modified through CAA APIs
This object is included in the file: CATIObjectRightsManager.h
If needed, your Imakefile.mk should include the module: KnowledgeItf
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.