getClusterStationsSimple() 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 a list of Stations assigned to a selected Cluster available within the system

Syntax

  • AeBasicDataItemAry = AeXMLBridge.getClusterStationsSimple(ClusterNum);

Parameters

  • Integer - cluster number

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
TAeBasicDataItem[] clusters = ws.getClustersSimple();
  
if (clusters.Length > 0)  
// since some clients may not have any clusters assigned, we are checking
// to see if there are any to eliminate the array out of bounds error
{                              
   try
   {
      TAeBasicDataItem[] stations = ws.getClusterStationsSimple(clusters[0].Num);
   }
   catch (Exception ex)
   {
      MessageBox.Show(ex.Message);
   }
}

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
Dim clusters As TAeBasicDataItem() = ws.getClustersSimple()
  
If clusters.Length > 0 Then
' since some clients may not have any clusters assigned, we are checking
' to see if there are any to eliminate the array out of bounds error

   Try
      Dim stations As TAeBasicDataItem() = ws.getClusterStationsSimple(clusters(0).Num)
   Catch ex As Exception
      MessageBox.Show(ex.Message)
   End Try
End If

Remarks

  • As noted in the sample code above, not all clients have clusters assigned to them. It is best practice to check using the getClustersSimple call to eliminate the “array index out of bounds error”

Possible Errors

  • Invalid Cluster Number

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

Back to Top