CATPLMIntegrationAccess  CATAdpPublicSecurityServices
Usage: you must use this class as is. You should never derive it.
 public class CATAdpPublicSecurityServices
 Class to manage Security services on client.
 Role: This class provides services
 
   - to retrieve login information, such as current user, projet, etc.
 
   - to check access to PLM functions, such as object creation
       and global functions (e.g. Import, Export, etc.)
 
 
 Method Index
 
 -  o 
    CheckAccess(char*,CATString&)
 -   Checks the security access to a global function.
 
 -  o 
    GetSecurityParameters(char*,CATString&,CATString&,CATString&,CATString&)
 -   Retrieves current login information of the specified repository.
 
 Methods
 
  o CheckAccess
  |   public static   CheckAccess( |  const   | iRepository, | 
 |  const   | iFunctionName)   | 
  - 
 Checks the security access to a global function.
 
Role:
          Checks the access to the specified global function of the specified repository.
          
A global function is a function that is not relative to a PLM Type object.
          
Example:
            Import, checks whether the interactive Import function
            can be used by the user.
 
 
  -  Parameters:
  
 - 
    
    -  iRepository
   
 -           The repository name.
          
Legal value: This parameter cannot be null;
          if the empty string ("") is specified, the first open repository is used.
  
    -  iFunctionName
   
 -           The global function name (e.g. 
Import, Export, Myfunction1, etc.).
          
Note: the function name is case insensitive.
  
   -  Returns: 
  
 -            The method execution status.
          
Possible values are:
          
              - S_OK
     - When the access to the function is granted.
 
              - E_FAIL
  - When the access to the function is denied (or does not exist), and in any other error case.
 
          
 
 
  o GetSecurityParameters
  |   public static   GetSecurityParameters( |  const   | iRepository, | 
 |   | oUserId, | 
 |   | oOrganisationId, | 
 |   | oProjectId, | 
 |   | oRoleId)   | 
  - 
 Retrieves current login information of the specified repository.
 
Role:
          Retrieves repository's current user, project, role and organization
 
 
  -  Parameters:
  
 - 
    
    -  iRepository
   
 -           The repository name.
          
Legal value: This parameter cannot be null;
          if the empty string ("") is specified, the first open repository is used.
  
    -  oUserId
   
 -           Identifier of the user currently logged in.
 
 
    -  oOrganisationId
   
 -           Current Organisation Identifier.
 
 
    -  oProjectId
   
 -           Current Project Identifier.
 
 
    -  oRoleId
   
 -           Current Role Identifier.
 
 
   -  Returns: 
  
 -            The method execution status.
          
Possible values are:
          
              - S_OK
     - When information was successfully retrieved.
 
              - E_FAIL
   - In any other error case.
 
          
 
 
 This object is included in the file: CATAdpPublicSecurityServices.h
If needed, your Imakefile.mk should include the module: CATPLMIntegrationAccess
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.