extractRangedSchedulesUsingHyperQuery() Method

Table of Contents

  1. Function
  2. Syntax
  3. Parameters
  4. Return Value
  5. Sample Code
  6. Remarks
  7. Possible Errors
  8. Preferred Method
  9. Related Methods

Function

Extracts a list of employee work schedules in a selected date range from a list of employees defined by the HyperQuery used

Syntax

  • AeScheduleAry = AeXMLBridge.extractRangedSchedules2UsingHyperQuery(HyperQueryName, DateRangeEnum, MinDate, MaxDate);

Parameters

  • String - HyperQuery Name
  • Enumeration - TDateRangeEnum
  • String - begin date (yyyy-mm-dd format)
  • String - end date (yyyy-mm-dd format)

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
string[] queries = ws.getHyperQueriesSimple();                             
// retrieve a list of the available hyper query names
 
TDateRangeEnum dateRange = TDateRangeEnum.drCustom;                       
string beginDate = DateTime.Now.ToString("yyyy-MM-dd");                    
string endDate = DateTime.Now.AddDays(30).ToString("yyyy-MM-dd");
 // when using drCustom you must set the date parameter values otherwise set to empty/null
 
try
{
   TAeSchedule[] scheds = ws.extractRangedSchedulesUsingHyperQuery(queries[0], dateRange, beginDate, endDate);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Dim queries As String() = ws.getHyperQueriesSimple()
' retrieve a list of the available hyper query names
 
Dim dateRange As TDateRangeEnum = TDateRangeEnum.drCustom
' when using drCustom you must set the date parameter values
' otherwise, set to null or empty

Dim beginDate As String = DateTime.Now.ToString("yyyy-MM-dd")
Dim endDate As String = DateTime.Now.AddDays(30).ToString("yyyy-MM-dd")
 
Try
    Dim scheds As TAeSchedule() = ws.extractRangedSchedulesUsingHyperQuery(queries(0), dateRange, beginDate, endDate)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

  • Use the getHyperQueriesSimple method to retrieve a list of accepted HyperQueryName values
  • If using drCustom as the TDateRangeEnum value, you must set the begin and end dates. Otherwise set teh values equal to null or empty

Possible Errors

  • Hyper Query does not exist
  • yyyy-mm-dd is required [Date supplied in invalid format]

Preferred Method

extractRangedSchedules2UsingHyperQuery

appendEmployeeSchedule2ByIDNum
extractEmployeePeriodShiftSchedulesByIDNum
extractEmployeeSchedules2ByIDNum
removeEmployeeScheduleByUniqueID
removeEmployeeSchedulesInRangeByIDNum

Back to Top