Namespace: Consultingwerk
Class 
LoginStateEnum Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object

File:LoginStateEnum
Purpose:Enum for the values of the Client-Principal LOGIN-STATE attribute
Description:Reduce risk of typos when verifying the LOGIN-STATE
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Mon Jul 15 06:53:29 CEST 2013
Notes:This Enum type is purposely implemented using CHARACTER
static properties.



Top Method Summary
Options Name Purpose
+ LOGICAL IsValid (character) Verifies if the specified login-state value is valid

Top Constructor Summary
Options Name Purpose
- LoginStateEnum () Private constructor for the LoginStateEnum class

Top Property Summary
Options Name Purpose
+ CHARACTER Expired After executing the SEAL() method, SET-CLIENT() method, SET-DB-CLIENT function, or IMPORT-PRINCIPAL() method, or VALIDATE-SEAL() method, and the date and time set for the LOGIN-EXPIRATION-TIMESTAMP attribute has expired
+ CHARACTER Failed After executing the AUTHENTICATION-FAILED() method on an unsealed client-principal object or after a user authentication operation fails on an unsealed client-principal object when calling the SET-CLIENT() method or SET-DB-CLIENT function.
+ CHARACTER Initial From the creation of an unsealed client-principal object using the CREATE CLIENT-PRINCIPAL statement until the object is sealed, and after calling the INITIALIZE() method on a sealed or unsealed client-principal object in any state
+ CHARACTER Login After the user identity represented by an unsealed client-principal object is successfully authenticated and the object is sealed using the SEAL() method, SECURITY-POLICY:SET-CLIENT() method, or the SET-DB-CLIENT function
+ CHARACTER Logout After executing the LOGOUT() method on a sealed client-principal object in the LOGIN state


Method Detail
Top

PUBLIC LOGICAL IsValid (character)

Purpose: Verifies if the specified login-state value is valid
Notes:

Parameters:
pcValue CHARACTER
The value to verify
Returns LOGICAL
Logical value indicating if the value is valid


Constructor Detail
Top

PRIVATE LoginStateEnum ()

Purpose: Private constructor for the LoginStateEnum class
Notes: Disallow instance creation



Property Detail
Top

PUBLIC CHARACTER Expired

Purpose: After executing the SEAL() method, SET-CLIENT() method, SET-DB-CLIENT
function, or IMPORT-PRINCIPAL() method, or VALIDATE-SEAL() method,
and the date and time set for the LOGIN-EXPIRATION-TIMESTAMP attribute
has expired
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER Failed

Purpose: After executing the AUTHENTICATION-FAILED() method on an unsealed
client-principal object or after a user authentication operation
fails on an unsealed client-principal object when calling the
SET-CLIENT() method or SET-DB-CLIENT function.
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER Initial

Purpose: From the creation of an unsealed client-principal object using the
CREATE CLIENT-PRINCIPAL statement until the object is sealed, and
after calling the INITIALIZE() method on a sealed or unsealed
client-principal object in any state
Notes: Default value

Returns CHARACTER
Top

PUBLIC CHARACTER Login

Purpose: After the user identity represented by an unsealed client-principal
object is successfully authenticated and the object is sealed using
the SEAL() method, SECURITY-POLICY:SET-CLIENT() method, or the
SET-DB-CLIENT function
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER Logout

Purpose: After executing the LOGOUT() method on a sealed client-principal
object in the LOGIN state
Notes:

Returns CHARACTER


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:29:27