getPayPeriodClassData() Method

Table of Contents

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

Function

• Returns details about a selected pay period class

Syntax

• AePayPeriodInfo = AeXMLBridge.getPayPeriodClassData(PayPeriodClassNum);

Parameters

• Integer - pay period class number

Return Value

• Returns a TAePayPeriodInfo structure

Sample Code

C#

TAePayPeriodInfo[] payPeriods = ws.getPayPeriodClasses();                  
// retrieve a list of pay period classes
  
try
{
   TAePayPeriodInfo ppi = ws.getPayPeriodClassData(payPeriods[0].PayPeriodClassNum);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

VB.Net

Dim payPeriods As TAePayPeriodInfo() = ws.getPayPeriodClasses()
' retrieve a list of pay period classes
  
Try
    Dim ppi As TAePayPeriodInfo = ws.getPayPeriodClassData(payPeriods(0).PayPeriodClassNum)
Catch ex As Exception
    MessageBox.Show(ex.Message)
End Try

Remarks

• You can use the getPayPeriodClasses method to retrieve a list of Pay Period Class values

Possible Errors

• Invalid Pay Period Class Number

Related Methods

ClientServerDateTime
extractNewDBElements
getActiveStatusConditions
getBaseClientData
getBrowserProfilesSimple
getClockGroupsSimple
getClockGroupStationsSimple
getClustersSimple
getClusterStationsSimple
getCompanyName
getCurrentBrowserProfileMenuItems
getHourlyStatusTypesSimple
getInactiveStatusConditions
getManuallySelectedSetupData
getPayClassesSimple
getPayDesignationsSimple
getPayPeriodClasses
getPayTypes
getReasonCodesSimple
getSiteEnvironment
ServerUTCDateTime
setBaseClientData
updateNewDBElement

Back to Top