public class

StaffingModule

extends AbstractWorkdayModule
java.lang.Object
   ↳ org.mule.modules.workday.AbstractWorkdayModule
     ↳ org.mule.modules.workday.staffing.StaffingModule
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

The Staffing Module exposes operations over Workday Human Capital Management Business Services data, including Employee, Contingent Worker and Organization information. This Web Service can be used for integration with enterprise systems including corporate directories, data analysis tools, email or other provisioning sub-systems, or any other systems needing Worker and/or Organization data.

Summary

Fields
private StaffingClient client The client, mainly for mocking purposes.
private String endpoint The Staffing endpoint.
private String password The Workday account's password
private String username The Workday account's username
[Expand]
Inherited Fields
From class org.mule.modules.workday.AbstractWorkdayModule
Public Constructors
StaffingModule()
Public Methods
GetApplicantsResponseType getApplicants(Map<String, Object> employeeReference, List<Map<String, Object>> references, Map<String, Object> filter, Map<String, Object> group)
Gets information for applicants specified in the request or information for all applicants if no criteria or applicant is specified in the request.
GetMaintainEmployeeContractsResponseType getMantainEmployeeContracts(List<Map<String, Object>> employeeReference, Map<String, Object> responseFilterType)
This operation will get employee contract information for employees.
GetPositionsResponseType getPositions(Map<String, Object> criteria, List<Map<String, Object>> references, Map<String, Object> responseFilter, Map<String, Object> responseGroup)
This operations answers the available positions
GetWorkersResponseType getWorkers(Map<String, Object> criteria, List<Map<String, Object>> references, Map<String, Object> responseFilter, Map<String, Object> responseGroup)
Answers the available workers
HireEmployeeEventResponseType hireEmployee(Map<String, Object> hireEmployeeData, boolean autoComplete, boolean runNow, Map<String, Object> commentData)
This operation will hire an existing applicant or a new applicant into an employee position, headcount, or job using the Hire Employee business process event and its relevant sub business processes.
void init()
ApplicantObjectType putApplicant(String applicantId, String workdayId, Map<String, Object> applicant)
This operation adds a new Applicant (or updates an existing Applicant) with the supplied information.
void setClient(Object client)
void setEndpoint(String endpoint)
void setPassword(String password)
void setUsername(String username)
[Expand]
Inherited Methods
From class org.mule.modules.workday.AbstractWorkdayModule
From class java.lang.Object

Fields

private StaffingClient client

The client, mainly for mocking purposes. *

private String endpoint

The Staffing endpoint. For example: https://impl-cc.workday.com/ccx/service/developer/Staffing/v15

private String password

The Workday account's password

private String username

The Workday account's username

Public Constructors

public StaffingModule ()

Public Methods

public GetApplicantsResponseType getApplicants (Map<String, Object> employeeReference, List<Map<String, Object>> references, Map<String, Object> filter, Map<String, Object> group)

Gets information for applicants specified in the request or information for all applicants if no criteria or applicant is specified in the request.

Parameters
employeeReference A string-object map of employee references
references The list of string-object maps of references
filter The get-applicants result filter, as an string-object map
group The group of applicants, as a string-object map
Returns
  • the get-applicants result
Throws
if operation fails
Exception

public GetMaintainEmployeeContractsResponseType getMantainEmployeeContracts (List<Map<String, Object>> employeeReference, Map<String, Object> responseFilterType)

This operation will get employee contract information for employees.

Parameters
employeeReference A list of string-object maps
responseFilterType A filter type
Returns
  • the response
Throws
if operation fails
Exception

public GetPositionsResponseType getPositions (Map<String, Object> criteria, List<Map<String, Object>> references, Map<String, Object> responseFilter, Map<String, Object> responseGroup)

This operations answers the available positions

Parameters
criteria Utilize the Request Criteria element to search the transaction log for specific instance(s) of a Position.
references Utilize the Request References element to retrieve a specific instance(s) of Position and its associated data.
responseFilter The "Response_Filter" element contains common WWS information that allows you control the response data that you will be provided including As_Of_Date, As_Of_Entry_Moment, and Page attributes.
responseGroup The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request the only the following elements will be returned: Reference and Position Definition Data
Returns
  • the GetPositions response
Throws
if operation fails
Exception

public GetWorkersResponseType getWorkers (Map<String, Object> criteria, List<Map<String, Object>> references, Map<String, Object> responseFilter, Map<String, Object> responseGroup)

Answers the available workers

Parameters
criteria Utilize the Request Criteria element to search the transaction log for specific instance(s) of a Worker.
references Utilize the Request References element to retrieve a specific instance(s) of Worker and its associated data.
responseFilter The "Response_Filter" element contains common WWS information that allows you control the response data that you will be provided including As_Of_Date, As_Of_Entry_Moment, and Page attributes.
responseGroup The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request the only the following elements will be returned: Reference, Personal Data, Employment Data, Compensation Data, Organization Data, and Role Data.
Returns
  • the GetWorkers response
Throws
if operation fails
Exception

public HireEmployeeEventResponseType hireEmployee (Map<String, Object> hireEmployeeData, boolean autoComplete, boolean runNow, Map<String, Object> commentData)

This operation will hire an existing applicant or a new applicant into an employee position, headcount, or job using the Hire Employee business process event and its relevant sub business processes.

Parameters
hireEmployeeData The hire employed request payload
autoComplete If autocomplete is enabled. Default is false.
runNow If process should be run now. Defaults is false
commentData An optional comment
Returns
  • the hire employee operation result
Throws
if operation fails
Exception

public void init ()

public ApplicantObjectType putApplicant (String applicantId, String workdayId, Map<String, Object> applicant)

This operation adds a new Applicant (or updates an existing Applicant) with the supplied information.

Parameters
applicantId The optional applicant id. Must be specified if attempting to update an existing applicant and Workday id is not specified
workdayId The optional Workday id. Must be specified if attempting to update an existing applicant and applicant id is not specified
applicant The new applicant information
Returns
  • the new or updated applicant reference
Throws
if the operation failed.
if operation fails
Exception

public void setClient (Object client)

Parameters
client

public void setEndpoint (String endpoint)

Parameters
endpoint

public void setPassword (String password)

Parameters
password

public void setUsername (String username)

Parameters
username