public class

AbsenceModule

extends AbstractWorkdayModule
java.lang.Object
   ↳ org.mule.modules.workday.AbstractWorkdayModule
     ↳ org.mule.modules.workday.absence.AbsenceModule
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

The Absence Management Web Service contains operations that expose absence-related data, including Employee Time Off and Absence Inputs for time off and accrual adjustments and overrides, and Leave Requests, in Workday Human Capital Management Business Services.

Summary

Fields
private AbsenceManagementPort client The client, mainly for mocking purposes.
private String username The Workday account's username
Public Constructors
AbsenceModule()
Public Methods
TimeOffEventResponseType adjustTimeOff(AdjustTimeOffRequestType timeOffRequest)
Adjusts an existing time off entry.
void connect(String absenceUser, String absencePassword, String absenceEndpoint, String absenceWsdlLocation)
Connects to Workday
void disconnect()
Disconnects
TimeOffEventResponseType enterTimeOff(EnterTimeOffRequestType timeOffRequest)
Adds new time off entries.
GetAbsenceInputsResponseType getAbsenceInputs(GetAbsenceInputsRequestType absenceInputsRequest)
Gets information for Accrual or Time Off Adjustments/Overrides for employees and/or batch id's specified in the request or information for all if no criteria is specified in the request.
AbsenceManagementPort getClient()
String getConnectionIdentifier()
Connection identifier
GetOverrideBalancesResponseType getOverrideBalances(GetOverrideBalancesRequestType overrideBalancesRequest)
Gets Time Off Plan Override Balances for an Employee and Time Off Plan with the supplied information.
GetTimeOffPlanBalancesResponseType getTimeOffPlanBalances(GetTimeOffPlanBalancesRequestType timeOffBalancesRequest)
Retrieves the dynamic Time Off Plan Balances by Worker and Time Off Plan.
String getUsername()
PutAbsenceInputResponseType putAbsenceInput(PutAbsenceInputRequestType absenceInput)
Adds a new Accrual or Time Off Adjustment/Override for an Employee (or updates an existing Adjustment/Override) with the supplied information.
PutOverrideBalanceResponseType putOverrideBalance(PutOverrideBalanceRequestType overrideBalance)
Adds or update a new Time Off Plan Override Balance record for a given Employee and Time Off Plan.
RequestLeaveOfAbsenceResponseType requestLeaveOfAbsence(RequestLeaveOfAbsenceRequestType leaveOfAbsenceRequest)
Adds new leave of absence requests.
RequestReturnFromLeaveOfAbsenceResponseType requestReturnFromLeaveOfAbsence(RequestReturnFromLeaveOfAbsenceRequestType returnFromLeaveOfAbsenceRequest)
Adds new return from leave of absence requests.
void setClient(AbsenceManagementPort client)
void setUsername(String username)
boolean validateConnection()
Validate connection
Protected Methods
void setClient(Object client)
[Expand]
Inherited Methods
From class org.mule.modules.workday.AbstractWorkdayModule
From class java.lang.Object

Fields

private AbsenceManagementPort client

The client, mainly for mocking purposes. *

private String username

The Workday account's username

Public Constructors

public AbsenceModule ()

Public Methods

public TimeOffEventResponseType adjustTimeOff (AdjustTimeOffRequestType timeOffRequest)

Adjusts an existing time off entry. The adjusted units must be passed in (and not the corrected units). This operation uses the Correct Time Off business process event.

Parameters
timeOffRequest Request object
Returns
  • response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public void connect (String absenceUser, String absencePassword, String absenceEndpoint, String absenceWsdlLocation)

Connects to Workday

Parameters
absenceUser Workday user
absencePassword Workday password
absenceEndpoint Workday endpoint
absenceWsdlLocation Workday WSDL location
Throws
ConnectionException

public void disconnect ()

Disconnects

public TimeOffEventResponseType enterTimeOff (EnterTimeOffRequestType timeOffRequest)

Adds new time off entries. It uses the Request Time Off business process event.

Parameters
timeOffRequest Request element
Returns
  • response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetAbsenceInputsResponseType getAbsenceInputs (GetAbsenceInputsRequestType absenceInputsRequest)

Gets information for Accrual or Time Off Adjustments/Overrides for employees and/or batch id's specified in the request or information for all if no criteria is specified in the request.

Parameters
absenceInputsRequest Request element
Returns
  • response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public AbsenceManagementPort getClient ()

public String getConnectionIdentifier ()

Connection identifier

Returns
  • connection identifier

public GetOverrideBalancesResponseType getOverrideBalances (GetOverrideBalancesRequestType overrideBalancesRequest)

Gets Time Off Plan Override Balances for an Employee and Time Off Plan with the supplied information.

Parameters
overrideBalancesRequest Request element
Returns
  • response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetTimeOffPlanBalancesResponseType getTimeOffPlanBalances (GetTimeOffPlanBalancesRequestType timeOffBalancesRequest)

Retrieves the dynamic Time Off Plan Balances by Worker and Time Off Plan.

Parameters
timeOffBalancesRequest Request element
Returns
  • response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public String getUsername ()

public PutAbsenceInputResponseType putAbsenceInput (PutAbsenceInputRequestType absenceInput)

Adds a new Accrual or Time Off Adjustment/Override for an Employee (or updates an existing Adjustment/Override) with the supplied information. NOTE : This web service went through a breaking change for Workday 16. In Workday 14 and 15, unbounded Absence_Input_Line_Data elements were allowed within an Absence_Input_Data element. Going forward, Workday 16 does use Absence_Input_Line_Data elements and the data has been moved to the Absence_Input_Data parent element. If the older Workday schema is submitted, the first Absence_Input_Line_Data element is used and transformed internally to the updated schema. All nested Absence_Input_Line_Data elements beyond the first are ignored.

Parameters
absenceInput Request
Returns
  • response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutOverrideBalanceResponseType putOverrideBalance (PutOverrideBalanceRequestType overrideBalance)

Adds or update a new Time Off Plan Override Balance record for a given Employee and Time Off Plan.

Parameters
overrideBalance Request element
Returns
  • response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public RequestLeaveOfAbsenceResponseType requestLeaveOfAbsence (RequestLeaveOfAbsenceRequestType leaveOfAbsenceRequest)

Adds new leave of absence requests. It uses the Request Leave of Absence business process event and its sub business processes.

Parameters
leaveOfAbsenceRequest Request element
Returns
  • response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public RequestReturnFromLeaveOfAbsenceResponseType requestReturnFromLeaveOfAbsence (RequestReturnFromLeaveOfAbsenceRequestType returnFromLeaveOfAbsenceRequest)

Adds new return from leave of absence requests. It uses the Request Return from Leave of Absence business process event and its sub business processes.

Parameters
returnFromLeaveOfAbsenceRequest Request element
Returns
  • response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public void setClient (AbsenceManagementPort client)

Parameters
client

public void setUsername (String username)

Parameters
username

public boolean validateConnection ()

Validate connection

Returns
  • true if the connector is connected

Protected Methods

protected void setClient (Object client)

Parameters
client