All Categories Class Hierarchy This Category Previous Indexes
People_and_Organisation Class CATVpmSCUsrManager
CATVpmSCUsrManager
public class CATVpmSCUsrManager
Security management class.
Role: This class provides services to access security data concerning
the current session.
Method Index
- o
CheckAccess(char*,char*,char*)
- Checks the access to a process.
- o
CheckDataAccess(char*,char*,char*,char*,char*,char*)
- Checks the data access to a process.
- o
GetLoginRoleName()
- Gets login role name.
- o
GetLoginRoleOrganizationId()
- Gets login role organization ID.
- o
GetLoginSiteId()
- Gets login site ID.
- o
GetLoginUserId()
- Gets login user ID.
Methods
o CheckAccess
| public static int CheckAccess( | const char* | iApplication, |
| const char* | iFunction, |
| const char* | iCommand) |
-
Checks the access to a process.
Role: Use this method to check the access to a particular
security process.
- Parameters:
-
- iApplication
- Security process application name.
- iFunction
- Security process function name.
- iCommand
- Security process command name.
- Returns:
- 0< if access is granted,
0 if access is not granted (undefined),
-1 if access is revoked,
-2 if access is not licensed.
o CheckDataAccess
| public static int CheckDataAccess( | const char* | iApplication, |
| const char* | iFunction, |
| const char* | iCommand, |
| const char* | iUserID, |
| const char* | iOrganizationID, |
| const char* | iSiteID | ="") |
-
Checks the data access to a process.
Role: Use this method to check the access to a particular
security process on data belonging to a given user, organization or site
responsible.
- Parameters:
-
- iApplication
- Security process application name.
- iFunction
- Security process function name.
- iCommand
- Security process command name.
- iUserID
- Data owning user ID.
- iOrganization
- Data owning organization ID.
- iSiteID
- Data owning site ID.
This parameter is only relevant in a multi-site environment,
otherwise it is ignored.
- Returns:
- 0< if access is granted,
0 if access is not granted (undefined),
-1 if access is revoked,
-2 if access is not licensed.
o GetLoginRoleName
| public static const char* GetLoginRoleName( | ) |
-
Gets login role name.
Role: Use this method to retrieve the name of the role used to
log in to the application.
- Returns:
- Name of the VPM role (NULL if not found).
Memory de-allocation (using the delete[] operator) is the
responsibility of the calling method.
o GetLoginRoleOrganizationId
| public static const char* GetLoginRoleOrganizationId( | ) |
-
Gets login role organization ID.
Role: Use this method to retrieve the ID of the organization the
login role is attached to.
- Returns:
- ID of the VPM role organization (NULL if not found).
Memory de-allocation (using the delete[] operator) is the
responsibility of the calling method.
o GetLoginSiteId
| public static const char* GetLoginSiteId( | ) |
-
Gets login site ID.
Role: Use this method to retrieve the ID of the login (or
current) site.
This method is only useful in a multi-site environment, otherwise the
site is not set.
- Returns:
- ID of the VPM site (NULL if not found).
Memory de-allocation (using the delete[] operator) is the
responsibility of the calling method.
o GetLoginUserId
| public static const char* GetLoginUserId( | ) |
-
Gets login user ID.
Role: Use this method to retrieve the ID of the user currently
logged in to the application.
- Returns:
- ID of the VPM user (NULL if not found).
Memory de-allocation (using the delete[] operator) is the
responsibility of the calling method.
This object is included in the file: CATVpmSCUsrManager.h
If needed, your Imakefile.mk should include the module: VPMVX0PEMNG