Namespace: Consultingwerk.Framework
Class 
WaitStateActionEnum Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.Enum

File:WaitStateActionEnum
Purpose:Enum with possible values for the wait-state, used by the
WaitStateManager events
Author(s):Mike Fechner
Created:Sun Jun 17 10:44:06 CEST 2012



Top Method Summary
Options Name Purpose
+ LOGICAL Equals (Object) Compares this Enum member to another member of this Enum by Value
Inherited from Consultingwerk.Enum
+ Consultingwerk.Framework.Collections.CharacterList GetNames () Returns a CharacterList with the names of the Enum members
+ F INT64 GetValue () Returns the Value of the Enum Member
Inherited from Consultingwerk.Enum
+ CHARACTER ToString () Returns a CHARACTER representation (human readable) of the Enum member
Inherited from Consultingwerk.Enum

Top Constructor Summary
Options Name Purpose
- WaitStateActionEnum (integer, character) Constructor for the WaitStateActionEnum members

Top Property Summary
Options Name Purpose
+ Consultingwerk.Framework.WaitStateActionEnum ClearWaitState No active wait-state
# CHARACTER Label Returns the character label associated with an enum member instance
Inherited from Consultingwerk.Enum
+ Consultingwerk.Framework.WaitStateActionEnum SetWaitState The wait-state is active
+ INTEGER Value Returns the integer value associated with an enum member instance
Inherited from Consultingwerk.Enum


Method Detail
Top

PUBLIC LOGICAL Equals (Object)

Inherited from Consultingwerk.Enum
Purpose: Compares this Enum member to another member of this Enum by Value
Notes: Returns FALSE when the passed in object reference is not of this
Enum type

Parameters:
poParam Progress.Lang.Object
The object to compare by value and type with the current enum member
Returns LOGICAL
Logical value indicating if the two compared enum members are euqally
Top

PUBLIC Consultingwerk.Framework.Collections.CharacterList GetNames ()

Purpose: Returns a CharacterList with the names of the Enum members
Notes:

Returns Consultingwerk.Framework.Collections.CharacterList
The CharacterList with the names of the Enum members
Top

PUBLIC INT64 GetValue ()

Inherited from Consultingwerk.Enum
Purpose: Returns the Value of the Enum Member
Notes: Introduced for compability with 11.6 native Enums

Returns INT64
The Enum Memeber value
Top

PUBLIC CHARACTER ToString ()

Inherited from Consultingwerk.Enum
Purpose: Returns a CHARACTER representation (human readable) of the
Enum member
Notes:

Returns CHARACTER
The CHARACTER representation of the enum member, identically to the Label property


Constructor Detail
Top

PRIVATE WaitStateActionEnum (integer, character)

Purpose: Constructor for the WaitStateActionEnum members
Notes:

Parameters:
piValue INTEGER
The internal (numeric) representation of the Enumeration member
pcLabel CHARACTER
The text label of the Enumaration member


Property Detail
Top

PUBLIC Consultingwerk.Framework.WaitStateActionEnum ClearWaitState

Purpose: No active wait-state
Notes:

Returns Consultingwerk.Framework.WaitStateActionEnum
Top

PROTECTED CHARACTER Label

Inherited from Consultingwerk.Enum
Purpose: Returns the character label associated with an enum member instance
Notes: Instance member

Returns CHARACTER
Top

PUBLIC Consultingwerk.Framework.WaitStateActionEnum SetWaitState

Purpose: The wait-state is active
Notes:

Returns Consultingwerk.Framework.WaitStateActionEnum
Top

PUBLIC INTEGER Value

Inherited from Consultingwerk.Enum
Purpose: Returns the integer value associated with an enum member instance
Notes: Instance member

Returns INTEGER


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