public class

BenefitsModule

extends AbstractWorkdayModule
java.lang.Object
   ↳ org.mule.modules.workday.AbstractWorkdayModule
     ↳ org.mule.modules.workday.benefits.BenefitsModule
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

The Benefits Administration Web Service contains operations that expose Workday Human Capital Management Business Services benefits-related data.

Summary

Fields
private BenefitsAdministrationPort client The client, mainly for mocking purposes.
private String username The Workday account's username
Public Constructors
BenefitsModule()
Public Methods
AddDependentResponseType addDependent(AddDependentRequestType dependent)
Adds a Dependent.
ChangeBenefitJobsResponseType changeBenefitJobs(ChangeBenefitJobsRequestType benefitJobs)
Specifies the benefit jobs for a worker.
ChangeBenefitsResponseType changeBenefits(ChangeBenefitsRequestType benefits)
Initiates the "Change Benefits for Life Event" business process allowing changes to benefit elections for an employee.
void connect(String benefitsUser, String benefitsPassword, String benefitsEndpoint, String benefitsWsdlLocation)
Connects to Workday
void disconnect()
Disconnects
EditDependentResponseType editDependent(EditDependentRequestType dependent)
Updates a dependent.
EnrollInRetirementSavingsPlansResponseType enrollInRetirementSavingsPlans(EnrollInRetirementSavingsPlansRequestType retirementSavingsPlans)
Allows for enrollment into Retirement Savings Plans.
GetBenefitAnnualCreditsResponseType getBenefitAnnualCredits(GetBenefitAnnualCreditsRequestType getBenefitAnnualCreditsRequest)
This service operation retrieves Benefits Annual Credits for one or more employees.
GetBenefitAnnualRatesResponseType getBenefitAnnualRates(GetBenefitAnnualRatesRequestType benefitAnnualRatesRequest)
Retrieves Benefits Annual Rates for one or more employees.
GetBenefitIndividualRatesResponseType getBenefitIndividualRates(GetBenefitIndividualRatesRequestType benefitIndividualRatesRequest)
Retrieves Benefits Individual Rates for one or more employees..
BenefitsAdministrationPort getClient()
String getConnectionIdentifier()
Connection identifier
String getUsername()
GrantCOBRAEligibilityResponseType grantCobraEligibility(GrantCOBRAEligibilityRequestType grantCobraElegibilityRequest)
A transaction to modify existing COBRA Eligibility or add new COBRA Eligibility Entries
PutBenefitAnnualCreditResponseType putBenefitAnnualCredit(PutBenefitAnnualCreditRequestType putBenefitAnnualCreditRequest)
This service operation creates a Benefit Annual Credit for one or more employees.
PutBenefitAnnualRateResponseType putBenefitAnnualRate(PutBenefitAnnualRateRequestType benefitAnnualRateRequest)
Creates a Benefit Annual Rate for one or more employees.
PutBenefitIndividualRateResponseType putBenefitIndividualRate(PutBenefitIndividualRateRequestType putBenefitIndividualRateRequest)
This service operation updates Benefits Individual Rates for one or more employees.
PutPostalCodeSetResponseType putPostalCodeSet(PutPostalCodeSetRequestType postalCodeSetRequest)
Adds new postal codes to an existing postal code set, or to create a new postal code set.
PutWorkerWellnessDataResponseType putWorkerWellnessData(PutWorkerWellnessDataRequestType putWorkerWellnessDataRequest)
This service operation creates/updates Wellness Data for a given worker.
void setClient(Object client)
void setClient(BenefitsAdministrationPort client)
void setUsername(String username)
boolean validateConnection()
Validate connection
[Expand]
Inherited Methods
From class org.mule.modules.workday.AbstractWorkdayModule
From class java.lang.Object

Fields

private BenefitsAdministrationPort client

The client, mainly for mocking purposes. *

private String username

The Workday account's username

Public Constructors

public BenefitsModule ()

Public Methods

public AddDependentResponseType addDependent (AddDependentRequestType dependent)

Adds a Dependent.

Parameters
dependent Wrapper Element for the Add Dependent web service operation. The earliest effective date provided for an address will apply to all addresses, emails, web addresses, instant messengers and phone numbers.
Returns
  • Wrapper element for the response to an Add Dependent web service operation request.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public ChangeBenefitJobsResponseType changeBenefitJobs (ChangeBenefitJobsRequestType benefitJobs)

Specifies the benefit jobs for a worker.

Parameters
benefitJobs Contains the request to change a worker's benefit jobs. Changing a worker's benefit jobs changes how the CRFs for benefit eligibility behave. If a worker has benefit jobs specified, then only the specified jobs will be used in the CRF calculations used to evaluate their benefit eligibility. If benefit jobs are not specified, then the HR Primary job is used for those CRFs.
Returns
  • Response to the Add Worker Benefit Jobs web service.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public ChangeBenefitsResponseType changeBenefits (ChangeBenefitsRequestType benefits)

Initiates the "Change Benefits for Life Event" business process allowing changes to benefit elections for an employee. This service does not support incremental updates or defaults.

Parameters
benefits Change benefits request
Returns
  • response object
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public void connect (String benefitsUser, String benefitsPassword, String benefitsEndpoint, String benefitsWsdlLocation)

Connects to Workday

Parameters
benefitsUser Workday user
benefitsPassword Workday password
benefitsEndpoint Workday endpoint
benefitsWsdlLocation Workday WSDL location
Throws
ConnectionException

public void disconnect ()

Disconnects

public EditDependentResponseType editDependent (EditDependentRequestType dependent)

Updates a dependent.

Parameters
dependent Wrapper element for the Edit Dependent web service operation.
Returns
  • Wrapper element for the response to an Edit Dependent web service operation request.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public EnrollInRetirementSavingsPlansResponseType enrollInRetirementSavingsPlans (EnrollInRetirementSavingsPlansRequestType retirementSavingsPlans)

Allows for enrollment into Retirement Savings Plans. It updates incrementally from existing elections and carries forward prior elections unless they are explicitly changed or waived.

Parameters
retirementSavingsPlans Enroll in Retirement Savings Plans Request
Returns
  • Enroll in Retirement Savings Plans Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetBenefitAnnualCreditsResponseType getBenefitAnnualCredits (GetBenefitAnnualCreditsRequestType getBenefitAnnualCreditsRequest)

This service operation retrieves Benefits Annual Credits for one or more employees.

Parameters
getBenefitAnnualCreditsRequest Wrapped element for the Get Benefit Annual Credits Request information
Returns
  • Wrapped element for the Get Benefit Annual Credits Response information
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetBenefitAnnualRatesResponseType getBenefitAnnualRates (GetBenefitAnnualRatesRequestType benefitAnnualRatesRequest)

Retrieves Benefits Annual Rates for one or more employees.

Parameters
benefitAnnualRatesRequest Wrapper element for Get Benefit Annual Rates Request.
Returns
  • Wrapper element for Get Benefit Annual Rates Response.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetBenefitIndividualRatesResponseType getBenefitIndividualRates (GetBenefitIndividualRatesRequestType benefitIndividualRatesRequest)

Retrieves Benefits Individual Rates for one or more employees..

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

public BenefitsAdministrationPort getClient ()

public String getConnectionIdentifier ()

Connection identifier

Returns
  • connection identifier

public String getUsername ()

public GrantCOBRAEligibilityResponseType grantCobraEligibility (GrantCOBRAEligibilityRequestType grantCobraElegibilityRequest)

A transaction to modify existing COBRA Eligibility or add new COBRA Eligibility Entries

Parameters
grantCobraElegibilityRequest Grant COBRA Eligibility request
Returns
  • response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutBenefitAnnualCreditResponseType putBenefitAnnualCredit (PutBenefitAnnualCreditRequestType putBenefitAnnualCreditRequest)

This service operation creates a Benefit Annual Credit for one or more employees.

Parameters
putBenefitAnnualCreditRequest Wrapped element for the Put Benefit Annual Credit Request information
Returns
  • Wrapped element for the Put Benefit Annual Credit Response information
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutBenefitAnnualRateResponseType putBenefitAnnualRate (PutBenefitAnnualRateRequestType benefitAnnualRateRequest)

Creates a Benefit Annual Rate for one or more employees.

Parameters
benefitAnnualRateRequest Wrapper element for the Put Benefit Annual Rate Request information.
Returns
  • Wrapper element for the Put Benefit Annual Rate Response information.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutBenefitIndividualRateResponseType putBenefitIndividualRate (PutBenefitIndividualRateRequestType putBenefitIndividualRateRequest)

This service operation updates Benefits Individual Rates for one or more employees.

Parameters
putBenefitIndividualRateRequest Wrapped element for the Put Benefit Individual Rate Request information
Returns
  • Wrapped element for the Put Benefit Individual Rate Response information
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutPostalCodeSetResponseType putPostalCodeSet (PutPostalCodeSetRequestType postalCodeSetRequest)

Adds new postal codes to an existing postal code set, or to create a new postal code set.

Parameters
postalCodeSetRequest Wrapper element for the Put Postal Code Set request.
Returns
  • Wrapper element for the Put Postal Code Set Returned data.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutWorkerWellnessDataResponseType putWorkerWellnessData (PutWorkerWellnessDataRequestType putWorkerWellnessDataRequest)

This service operation creates/updates Wellness Data for a given worker.

Parameters
putWorkerWellnessDataRequest Wrapped element for the Put Worker Wellness Data Request information
Returns
  • Wrapped element for the Put Worker Wellness Data Response information
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public void setClient (Object client)

Parameters
client

public void setClient (BenefitsAdministrationPort client)

Parameters
client

public void setUsername (String username)

Parameters
username

public boolean validateConnection ()

Validate connection

Returns
  • true if the connector is connected