--- title: clsEmployeeData summary: API reference for clsEmployeeData. status: draft owner: SAIF last_reviewed: 2026-07-24 library: SAIF.Business reference_type: package --- # clsEmployeeData Employee data business object used for retrieval and validation of employee profile details. Represents an employee profile business object populated from ADP and WCIS employee data sources. ## Purpose - Represents an employee profile business object populated from ADP and WCIS employee data sources. ## Context - Namespace: `SAIF.Business` - Assembly/package: `SAIF.Business` ## Public members | Member | Signature | Purpose | | --- | --- | --- | | `City` | `Public ReadOnly Property City() As String` | The City of the employment location. | | `DepartmentID` | `Public ReadOnly Property DepartmentID() As String` | The ID of the Department for which the employee works. | | `PhoneExtension` | `Public ReadOnly Property PhoneExtension() As String` | The phone extension. | | `ReportsTO` | `Public ReadOnly Property ReportsTO() As String` | The Position Number for which this position reports. | | `ReportingManager` | ` Public ReadOnly Property ReportingManager() As String` | The Name of the Reporting Manager. | | `ReportingManagerID` | ` Public ReadOnly Property ReportingManagerID() As String` | The employee ID of the Reporting Manager | | `State` | `Public ReadOnly Property State() As String` | The State Code for the employment location. | | `Street1` | `Public ReadOnly Property Street1() As String` | Line 1 of the employment location. | | `Zip` | `Public ReadOnly Property Zip() As String` | The Zip code of the employment location. | | `Address` | ` Public ReadOnly Property Address() As clsAddress` | Returns the SAIF Address. | | `DataSource` | `Public ReadOnly Property DataSource() As String` | Returns the Source of the Employee Data. (ADP or WCIS) | | `Department` | ` Public ReadOnly Property Department() As String` | Returns the Department Name the Employee is assigned to. | | `Division` | ` Public ReadOnly Property Division() As String` | Returns the Employee's Division. | | `EmailAddress` | ` Public ReadOnly Property EmailAddress() As String` | A formatted email address. | | `Fax` | ` Public ReadOnly Property Fax() As String` | A String representation of the Employee's work phone number. | | `FaxNumber` | ` Public ReadOnly Property FaxNumber() As clsPhone` | an object of type clsPhone which represents the employee's Fax number. | | `MobilePhone` | `Public ReadOnly Property MobilePhone As clsPhone` | Lazily loads and returns the employee's mobile phone from ADP employee phone data. | | `FormattedName` | ` Public ReadOnly Property FormattedName() As String` | Returns the employee name in employee display format. | | `Gender` | ` Public ReadOnly Property Gender() As String` | Returns the employee gender stored on the name object. | | `ID` | ` Public ReadOnly Property ID() As String` | The Employee's ID Number. | | `IsPseudoUser` | `Public ReadOnly Property IsPseudoUser() As Boolean` | Returns True if the Object contains only a MailID and Phone. | | `JobTitle` | ` Public ReadOnly Property JobTitle() As String` | The Description of the Employee's Job Title. | | `Location` | ` Public ReadOnly Property Location() As String` | A Description of the SAIF Building or Remote Site where the employee is assigned. | | `MailID` | ` Public ReadOnly Property MailID() As String` | The MailID of the Employee. This is the same as the UserID. | | `Name` | `Public ReadOnly Property Name() As clsName` | Returns a Name object for the Employee. The First, Last, Middle and Preferred fields contain Employee Name information. The Description field contains the Employee's Job Title. All other Name fields are blank. | | `Phone` | ` Public ReadOnly Property Phone() As String` | A String representation of the Employee's work phone number. | | `PhoneNumber` | ` Public ReadOnly Property PhoneNumber() As clsPhone` | an object of type clsPhone which represents the employee's phone number. The StoredFormat is ADPEmployee. | | `SectionCode` | ` Public ReadOnly Property SectionCode() As String` | Returns the employee's section code from the retrieved employment data. | | `DeskLocation` | `Public ReadOnly Property DeskLocation As String` | Lazily retrieves and returns the employee's desk location by MailID. | | `Status` | `Public ReadOnly Property Status() As String` | The Code which represents the employee's Status. | | `IsActive` | `Public ReadOnly Property IsActive() As Boolean` | Returns True when the employee status code is A. | | `IsTerminated` | `Public ReadOnly Property IsTerminated() As Boolean` | Returns True when the employee status code is T. | | `SupervisorMailID` | ` Public ReadOnly Property SupervisorMailID() As String` | Returns the supervisor mail ID associated with the employee. | | `Supervisor` | ` Public ReadOnly Property Supervisor() As clsEmployeeData` | Lazily retrieves the supervisor's clsEmployeeData record by SupervisorMailID, or returns the shared empty object when none is available. | | `User2` | `Public ReadOnly Property User2() As String` | USER2 Field from the ADP Repository. | | `UserID` | ` Public ReadOnly Property UserID() As String` | The System UserID for the Employee | | `Empty` | `Public ReadOnly Property Empty() As clsEmployeeData` | Returns the shared empty clsEmployeeData instance. | | `EmptyObject` | `Public Shared ReadOnly Property EmptyObject() As clsEmployeeData` | Returns the shared empty clsEmployeeData instance. | | `ProcessRequests` | `Public Sub ProcessRequests(ByRef inPR As IPortalRequest, ByRef inDR As IDataRequest)` | Used by the Business Object Framework to initialize the object. | | `Equals` | `Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean` | Used by the BusinessObject Framework for post retrieval operations. | | `Equals` | `Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean` | Returns True when the supplied object is a clsEmployeeData instance with the same UserID. | | `Equals` | `Public Overloads Function Equals(ByVal inObject As clsEmployeeData) As Boolean` | Returns True when the supplied employee has the same UserID as this employee. | | `GetHashCode` | `Public Overrides Function GetHashCode() As Integer` | Returns the Hash Code of the Emplolyee's ID Number. | | `ValidObject` | `Public Function ValidObject(ByVal target As Object, ByVal e As clsRuleArgs) As Boolean` | This Business Rule Validates that data was retrieved for this object. | | `ToString` | `Public Overrides Function ToString() As String` | Returns the Employee's MAILID | | `NewPseudoEmployee` | `Public Shared Function NewPseudoEmployee(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inPseudoUser As String, ByVal inPseudoPhone As String) As clsEmployeeData` | Used to instantiate an Empty Pseudo Employee Object. | | `GetDataByMailID` | `Public Shared Function GetDataByMailID(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inUserID As String, Optional ByVal inByPassPrincipal As Boolean = False, Optional ByVal includeVirtual As Boolean = False) As clsEmployeeData` | Used to instantiate an Employee Object when the MailID or System UserID is known. | | `GetDataByEmployeeID` | `Public Shared Function GetDataByEmployeeID(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inEmployeeID As String, Optional ByVal inByPassPrincipal As Boolean = False, Optional ByVal includeVirtual As Boolean = False) As clsEmployeeData` | Used to instantiate an Employee Object when the Employee ID is known. | | `New` | `Public Sub New()` | The SQL Required to fill an instantiated Employee Object's internal data variables. | | `New` | `Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inEmployeeID As String, ByVal inUserID As String)` | Initializes employee retrieval criteria with the data portal, employee ID, and user ID used for lookups. | | `AddCriteria` | `Public Sub AddCriteria(ByRef inDataRequest As IDataRequest)` | Used by the BusinessObject framework to add the appropriate criteria when retrieving internal data from the Data Access Layer. | ## Behavioral notes - The type exposes business-object properties that are populated from Oracle-backed retrieval criteria. - Employee adjunct fields such as phone, location, and manager data are surfaced directly on the object for UI and workflow use. ## Constraints and usage notes - Property values depend on the retrieval criteria and Oracle result-set columns used by the containing BOF object. - Validation and persistence behavior is mediated through the underlying BOF base classes. ## Sources - `Business\SAIF.Business\clsEmployeeData.vb`