Namespace: Consultingwerk
Class 
WeekDayEnum Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Enum
Consultingwerk.WeekDayEnum

Inherits: Consultingwerk.Enum

File:WeekDayEnum
Purpose:Enumeration of WeekDays
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Mar 20 07:21:56 CET 2013

Navigate to: Methods | Constructors | Events | Properties



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.WeekDayEnum FromAblWeekDay (integer) Returns the WeekDayEnum member that matches the value of the ABL weekday function
+ Consultingwerk.WeekDayEnum FromIsoWeekDay (integer) Returns the WeekDayEnum member that matches the value of the ISO weekday number
+ Consultingwerk.WeekDayEnum FromString (character) Returns the WeekDayEnum member that matches the passed in character value
+ 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
+ INTEGER ToAblWeekDay () Returns the Integer number of the day of the week matching the current WeekDayEnum member
+ INTEGER ToIsoWeekDay () Returns the Integer number of the day of the week matching the current WeekDayEnum member
+ CHARACTER ToString () Returns a CHARACTER representation (human readable) of the Enum member
Inherited from Consultingwerk.Enum

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

Top Property Summary
Options Name Purpose
+ Consultingwerk.WeekDayEnum Friday
# CHARACTER Label Returns the character label associated with an enum member instance
Inherited from Consultingwerk.Enum
+ Consultingwerk.WeekDayEnum Monday
+ Consultingwerk.WeekDayEnum Saturday
+ Consultingwerk.WeekDayEnum Sunday
+ Consultingwerk.WeekDayEnum Thursday
+ Consultingwerk.WeekDayEnum Tuesday
+ INTEGER Value Returns the integer value associated with an enum member instance
Inherited from Consultingwerk.Enum
+ Consultingwerk.WeekDayEnum Wednesday


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.WeekDayEnum FromAblWeekDay (integer)
Purpose: Returns the WeekDayEnum member that matches the value of the ABL
weekday function
Notes:

Parameters:
piAblWeekDay INTEGER
The value of the ABL weekday function
Returns Consultingwerk.WeekDayEnum
The WeekDay enum member matching the input value
Top

PUBLIC Consultingwerk.WeekDayEnum FromIsoWeekDay (integer)
Purpose: Returns the WeekDayEnum member that matches the value of the ISO
weekday number
Notes: Following the ISO 8601 norm used in Germany and most European countries
where the week starts with Monday

Parameters:
piIsoWeekDay INTEGER
The number of the ISO weekday
Returns Consultingwerk.WeekDayEnum
The WeekDay enum member matching the input value
Top

PUBLIC Consultingwerk.WeekDayEnum FromString (character)
Purpose: Returns the WeekDayEnum member that matches the passed in character
value
Notes: Only the first one or two characters are used for comparison:
M, TU, W, TH, F, SA, SU

Parameters:
pcWeekDay CHARACTER
The character value to return the weekday for
Returns Consultingwerk.WeekDayEnum
The WeekDay enum member matching the input value
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 INTEGER ToAblWeekDay ()
Purpose: Returns the Integer number of the day of the week matching the
current WeekDayEnum member
Notes: Using US week day norm, compatible to the ABL Weekday function

Returns INTEGER
The Integer number of the day of the week
Top

PUBLIC INTEGER ToIsoWeekDay ()
Purpose: Returns the Integer number of the day of the week matching the
current WeekDayEnum member
Notes: Following the ISO 8601 norm used in Germany and most European countries
where the week starts with Monday

Returns INTEGER
The Integer number of the day of the week
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 WeekDayEnum (integer, character)
Purpose: Constructor for the WeekDayEnum 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.WeekDayEnum Friday

Returns Consultingwerk.WeekDayEnum
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.WeekDayEnum Monday

Returns Consultingwerk.WeekDayEnum
Top

PUBLIC Consultingwerk.WeekDayEnum Saturday

Returns Consultingwerk.WeekDayEnum
Top

PUBLIC Consultingwerk.WeekDayEnum Sunday

Returns Consultingwerk.WeekDayEnum
Top

PUBLIC Consultingwerk.WeekDayEnum Thursday

Returns Consultingwerk.WeekDayEnum
Top

PUBLIC Consultingwerk.WeekDayEnum Tuesday

Returns Consultingwerk.WeekDayEnum
Top

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

Returns INTEGER
Top

PUBLIC Consultingwerk.WeekDayEnum Wednesday

Returns Consultingwerk.WeekDayEnum


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