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 StaffingPort client The client, mainly for mocking purposes.
private String username The Workday account's username
Public Constructors
StaffingModule()
Public Methods
AddAdditionalJobEventResponseType addAdditionalJob(AddAdditionalJobRequestType additionalJob)
Adds an additional job for an existing employee.
AddRetireeStatusResponseType addRetireeStatus(AddRetireeStatusRequestType retireeStatus)
Changes the status of a previously terminated worker to retiree.
AssignOrganizationResponseType assignOrganization(AssignOrganizationRequestType organization)
Assigns company, cost center, region, fund, grant, business unit, program, and custom organizations configured for staffing usage to a staffing position.
AssignOrganizationRolesResponseType assignOrganizationRoles(AssignOrganizationRolesRequestType organizationRoles)
Assigns organization roles to one or more workers.
ChangeJobResponseType changeJob(ChangeJobRequestType job)
Perform a job change on an employee or contingent worker.
ClosePositionOrHeadcountRestrictionResponseType closePositionOrHeadcountRestriction(ClosePositionOrHeadcountRestrictionRequestType closePositionOrHeadcountRestrictionRequest)
This operation will invoke the Business Process to Close a Position or Headcount Restriction.
void connect(String staffingUser, String staffingPassword, String staffingEndpoint, String staffingWsdlLocation)
Connects to Workday
ContractContingentWorkerResponseType contractContingentWorker(ContractContingentWorkerRequestType contingentWorker)
Contracts an existing applicant into a contingent worker position, headcount, or job.
CreatePositionResponseType createPositionStaffing(CreatePositionRequestType position)
Creates/opens a position for a supervisory organization using the position management staffing model.
void disconnect()
Disconnects
EditPositionEventResponseType editPosition(EditPositionRequestType position)
Edits a filled position.
EditPositonRestrictionResponseType editPositionRestrictionsStaffing(EditPositionRestrictionsRequestType positionRestrictions)
Edits an existing position restriction.
EditServiceDatesResponseType editServiceDates(EditServiceDatesRequestType serviceDates)
Sets a worker's service dates.
EndAdditionalEmployeeJobEventResponseType endAdditionalJob(EndAdditionalJobRequestType additionalJob)
Ends an employee's additional job.
EndContingentWorkerContractResponseType endContingentWorkerContract(EndContingentWorkerContractRequestType contingentWorkerContract)
Ends a contingent worker's contract.
GetApplicantsResponseType getApplicantsStaffing(GetApplicantsRequestType applicantsRequest)
Returns information for applicants specified in the request.
GetCitizenshipStatusesResponseType getCitizenshipStatuses(GetCitizenshipStatusesRequestType citizenshipStatusesRequest)
Returns citizenship status details for the requested status.
StaffingPort getClient()
String getConnectionIdentifier()
Connection identifier
GetHeadcountsResponseType getHeadcountsStaffing(GetHeadcountsRequestType headcountsRequest)
Returns headcount information along with the identification of the workers filling headcount positions.
GetJobClassificationGroupsResponseType getJobClassificationGroupsStaffing(GetJobClassificationGroupsRequestType getJobClassificationGroupsRequest)
Returns job classification group data.
GetJobFamiliesResponseType getJobFamiliesStaffing(GetJobFamiliesRequestType getJobFamiliesRequest)
Returns job family data.
GetJobFamilyGroupsResponseType getJobFamilyGroupsStaffing(GetJobFamilyGroupsRequestType getJobFamilyGroupsRequest)
Returns job family and job family group data.
GetOrganizationsResponseType getOrganizationsStaffing(GetOrganizationsRequestType getOrganizationsRequest)
Returns organization information for a type of organization.
GetPositionsResponseType getPositionsStaffing(GetPositionsRequestType positionsRequest)
Returns information for position management positions.
String getUsername()
GetWorkerDocumentsResponseType getWorkerDocuments(GetWorkerDocumentsRequestType workerDocumentsRequest)
Returns worker document data.
GetWorkersResponseType getWorkersStaffing(GetWorkersRequestType getWorkersRequest)
Returns information for specified workers.
HireEmployeeEventResponseType hireEmployee(HireEmployeeRequestType employee)
Hires an applicant (new or existing) into an employee position, headcount, or job.
MaintainEmployeeContractsResponseType maintainEmployeeContracts(MaintainEmployeeContractsRequestType employeeContractsRequest)
Adds or updates employee contracts.
PutApplicantResponseType putApplicantStaffing(PutApplicantRequestType applicant)
Adds a new applicant (or updates an existing applicant) with the information supplied in the request.
PutCitizenshipStatusResponseType putCitizenshipStatus(PutCitizenshipStatusRequestType citizenshipStatus)
Adds or updates citizenship status.
PutJobClassificationGroupResponseType putJobClassificationGroupStaffing(PutJobClassificationGroupRequestType putJobClassificationGroupRequest)
Adds or updates a job classification group and/or job classifications.
PutJobFamilyGroupResponseType putJobFamilyGroupStaffing(PutJobFamilyGroupRequestType putJobFamilyGroupRequest)
Adds or updates a job family group.
PutJobFamilyResponseType putJobFamilyStaffing(PutJobFamilyRequestType putJobFamilyRequest)
Adds or updates a job family.
PutWorkerDocumentResponseType putWorkerDocument(PutWorkerDocumentRequestType workerDocument)
Adds or updates a worker document.
RemoveRetireeStatusResponseType removeRetireeStatus(RemoveRetireeStatusRequestType retireeStatus)
Removes the retirement status from a retired employee.
void setClient(Object client)
void setClient(StaffingPort client)
void setUsername(String username)
SwitchPrimaryJobEventResponseType switchPrimaryJob(SwitchPrimaryJobRequestType switchPrimaryJobRequest)
This operation will invoke the business process to switch a workers primary job with one of their additional jobs.
TerminateEmployeeEventResponseType terminateEmployee(TerminateEmployeeRequestType employee)
Terminates an employee.
boolean validateConnection()
Validate connection
[Expand]
Inherited Methods
From class org.mule.modules.workday.AbstractWorkdayModule
From class java.lang.Object

Fields

private StaffingPort client

The client, mainly for mocking purposes. *

private String username

The Workday account's username

Public Constructors

public StaffingModule ()

Public Methods

public AddAdditionalJobEventResponseType addAdditionalJob (AddAdditionalJobRequestType additionalJob)

Adds an additional job for an existing employee. Uses the Add Additional Job business process.

Parameters
additionalJob Wrapper for additionalJobRequest
Returns
  • Responds with the Event ID for the Add Additional Employee Job Event and the job reference.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public AddRetireeStatusResponseType addRetireeStatus (AddRetireeStatusRequestType retireeStatus)

Changes the status of a previously terminated worker to retiree. Uses the Add Retiree Status business process.

Parameters
retireeStatus Wrapper for AddRetireeStatusRequestType
Returns
  • element with information in Add Retiree Status event
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public AssignOrganizationResponseType assignOrganization (AssignOrganizationRequestType organization)

Assigns company, cost center, region, fund, grant, business unit, program, and custom organizations configured for staffing usage to a staffing position. Uses the Change Organization Assignments for Worker business process.

Parameters
organization Wrapper for AssignOrganizationRequestType
Returns
  • Responds with the Event ID for the Assign Organization Event.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public AssignOrganizationRolesResponseType assignOrganizationRoles (AssignOrganizationRolesRequestType organizationRoles)

Assigns organization roles to one or more workers. Uses the Assign Organization Roles for Worker business process.

Parameters
organizationRoles Wrapper for AssignOrganizationRolesRequestType
Returns
  • element with the Event ID for the Assign Organization Roles business process event.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public ChangeJobResponseType changeJob (ChangeJobRequestType job)

Perform a job change on an employee or contingent worker. Uses the Change Job business process. The types of changes include transfer, promotion, demotion, lateral moves and any other change of data on the job.

Parameters
job Job request object
Returns
  • element with the Event ID of the Change Job and any exceptions.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public ClosePositionOrHeadcountRestrictionResponseType closePositionOrHeadcountRestriction (ClosePositionOrHeadcountRestrictionRequestType closePositionOrHeadcountRestrictionRequest)

This operation will invoke the Business Process to Close a Position or Headcount Restriction.

Parameters
closePositionOrHeadcountRestrictionRequest The request object for the operation
Returns
  • The response from the operation
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public void connect (String staffingUser, String staffingPassword, String staffingEndpoint, String staffingWsdlLocation)

Connects to Workday

Parameters
staffingUser Workday user
staffingPassword Workday password
staffingEndpoint Workday endpoint
staffingWsdlLocation Workday WSDL location
Throws
ConnectionException

public ContractContingentWorkerResponseType contractContingentWorker (ContractContingentWorkerRequestType contingentWorker)

Contracts an existing applicant into a contingent worker position, headcount, or job. Uses the Contract Contingent Worker business process

Parameters
contingentWorker Wrapper for ContractContingentWorkerRequestType
Returns
  • Responds with the event id of the contract contingent worker event.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public CreatePositionResponseType createPositionStaffing (CreatePositionRequestType position)

Creates/opens a position for a supervisory organization using the position management staffing model. Uses the Create Position business process. There are several sub-operations within this operation. Existing positions cannot be re-loaded into the system. You must use the Edit Position Restrictions operation to change a created position.

Parameters
position Wrapper for Create Open Position Web Service.
Returns
  • Responds with the event id for the Position Request Event and the Position Opening Reference (if the event was completed).
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public void disconnect ()

Disconnects

public EditPositionEventResponseType editPosition (EditPositionRequestType position)

Edits a filled position. Uses the Edit Position business process.

Parameters
position Wrapper for EditPositionRequestType
Returns
  • Responds with the Event ID for the Edit Position Event.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public EditPositonRestrictionResponseType editPositionRestrictionsStaffing (EditPositionRestrictionsRequestType positionRestrictions)

Edits an existing position restriction. Uses the Edit Position Restrictions business process.

Parameters
positionRestrictions Wrapper element for Edit Position Restrictions Web Service.
Returns
  • element with the event ID of the Position Restrictions Edit Event, the Position Restriction being edited and the workflow state of the event.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public EditServiceDatesResponseType editServiceDates (EditServiceDatesRequestType serviceDates)

Sets a worker's service dates. Uses the Edit Service Dates business process

Parameters
serviceDates Wrapper for EditServiceDatesRequestType
Returns
  • Responds with the Event ID for the Service Dates Change Event.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public EndAdditionalEmployeeJobEventResponseType endAdditionalJob (EndAdditionalJobRequestType additionalJob)

Ends an employee's additional job. Uses the End Additional Job business process

Parameters
additionalJob Wrapper for End Additional Job Web Service.
Returns
  • element with the Event ID for the End Additional Job Event.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public EndContingentWorkerContractResponseType endContingentWorkerContract (EndContingentWorkerContractRequestType contingentWorkerContract)

Ends a contingent worker's contract. Uses the End Contingent Worker Contract Business Process

Parameters
contingentWorkerContract Wrapper for End Contingent Worker Contract web service and its sub-processes.
Returns
  • element with the event id for the End Contract Event.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetApplicantsResponseType getApplicantsStaffing (GetApplicantsRequestType applicantsRequest)

Returns information for applicants specified in the request. If the request does not specify an applicant, this operation returns information for all applicants..

Parameters
applicantsRequest Wrapper element for Applicant Request.
Returns
  • Wrapper element for the Applicant Information returned as a result of a Get Applicant request.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetCitizenshipStatusesResponseType getCitizenshipStatuses (GetCitizenshipStatusesRequestType citizenshipStatusesRequest)

Returns citizenship status details for the requested status. If the request does not specify a citizenship status, the operations returns details for all citizenship statuses.

Parameters
citizenshipStatusesRequest Element containing the references of the Citizenship Statuses requested.
Returns
  • Response Element for Get Citizenship Statuses.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public StaffingPort getClient ()

public String getConnectionIdentifier ()

Connection identifier

Returns
  • connection identifier

public GetHeadcountsResponseType getHeadcountsStaffing (GetHeadcountsRequestType headcountsRequest)

Returns headcount information along with the identification of the workers filling headcount positions.

Parameters
headcountsRequest Request element to get Headcounts and their associated data.
Returns
  • Response element containing instances of headcounts and their associated data.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetJobClassificationGroupsResponseType getJobClassificationGroupsStaffing (GetJobClassificationGroupsRequestType getJobClassificationGroupsRequest)

Returns job classification group data.

Parameters
getJobClassificationGroupsRequest The request object for the operation
Returns
  • The response from the operation
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetJobFamiliesResponseType getJobFamiliesStaffing (GetJobFamiliesRequestType getJobFamiliesRequest)

Returns job family data.

Parameters
getJobFamiliesRequest The request object for the operation
Returns
  • The response from the operation
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetJobFamilyGroupsResponseType getJobFamilyGroupsStaffing (GetJobFamilyGroupsRequestType getJobFamilyGroupsRequest)

Returns job family and job family group data.

Parameters
getJobFamilyGroupsRequest The request object for the operation
Returns
  • The response from the operation
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetOrganizationsResponseType getOrganizationsStaffing (GetOrganizationsRequestType getOrganizationsRequest)

Returns organization information for a type of organization. If the request does not specify an organization, the operation returns information for all organizations.

Parameters
getOrganizationsRequest The request object for the operation
Returns
  • The response from the operation
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetPositionsResponseType getPositionsStaffing (GetPositionsRequestType positionsRequest)

Returns information for position management positions. If a position is filled, identifies the worker filling the position.

Parameters
positionsRequest Request element to get position management positions and their associated data.
Returns
  • element containing instances of positions and their associated data.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public String getUsername ()

public GetWorkerDocumentsResponseType getWorkerDocuments (GetWorkerDocumentsRequestType workerDocumentsRequest)

Returns worker document data.

Parameters
workerDocumentsRequest Request element for Get Worker Documents.
Returns
  • Response element for Get Worker Documents.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetWorkersResponseType getWorkersStaffing (GetWorkersRequestType getWorkersRequest)

Returns information for specified workers. If the request does not specify a worker, then the operation returns information for all workers.

Parameters
getWorkersRequest The request object for the operation
Returns
  • The response from the operation
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public HireEmployeeEventResponseType hireEmployee (HireEmployeeRequestType employee)

Hires an applicant (new or existing) into an employee position, headcount, or job. Uses the Hire Employee business process. .

Parameters
employee Request object
Returns
  • element containing the Event ID for the Hire Employee Event.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public MaintainEmployeeContractsResponseType maintainEmployeeContracts (MaintainEmployeeContractsRequestType employeeContractsRequest)

Adds or updates employee contracts. Uses the Maintain Employee Contracts business process.

Parameters
employeeContractsRequest Wrapper element for MaintainEmployeeContractsRequestType
Returns
  • Employee Contract that was added or updated
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutApplicantResponseType putApplicantStaffing (PutApplicantRequestType applicant)

Adds a new applicant (or updates an existing applicant) with the information supplied in the request.

Parameters
applicant Wrapper element for the Put Applicant Request Information.
Returns
  • Wrapper element for the Put Applicant Returned data.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutCitizenshipStatusResponseType putCitizenshipStatus (PutCitizenshipStatusRequestType citizenshipStatus)

Adds or updates citizenship status.

Parameters
citizenshipStatus Request element for the Put Citizenship Status operation
Returns
  • Response element for the Put Citizenship Status operation.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutJobClassificationGroupResponseType putJobClassificationGroupStaffing (PutJobClassificationGroupRequestType putJobClassificationGroupRequest)

Adds or updates a job classification group and/or job classifications.

Parameters
putJobClassificationGroupRequest The request object for the operation
Returns
  • The response from the operation
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutJobFamilyGroupResponseType putJobFamilyGroupStaffing (PutJobFamilyGroupRequestType putJobFamilyGroupRequest)

Adds or updates a job family group. Also adds or removes a group's associated job families.

Parameters
putJobFamilyGroupRequest The request object for the operation
Returns
  • The response from the operation
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutJobFamilyResponseType putJobFamilyStaffing (PutJobFamilyRequestType putJobFamilyRequest)

Adds or updates a job family.

Parameters
putJobFamilyRequest The request object for the operation
Returns
  • The response from the operation
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutWorkerDocumentResponseType putWorkerDocument (PutWorkerDocumentRequestType workerDocument)

Adds or updates a worker document. The operation adds documents not associated with events and those documents are not secured by the events. .

Parameters
workerDocument Request element for Put Worker Document
Returns
  • Response element for Put Worker Document.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public RemoveRetireeStatusResponseType removeRetireeStatus (RemoveRetireeStatusRequestType retireeStatus)

Removes the retirement status from a retired employee. Uses the Remove Retiree Status business process.

Parameters
retireeStatus Wrapper for RemoveRetireeStatusRequestType
Returns
  • element containing information on Remove Retiree Status event.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public void setClient (Object client)

Parameters
client

public void setClient (StaffingPort client)

Parameters
client

public void setUsername (String username)

Parameters
username

public SwitchPrimaryJobEventResponseType switchPrimaryJob (SwitchPrimaryJobRequestType switchPrimaryJobRequest)

This operation will invoke the business process to switch a workers primary job with one of their additional jobs. Uses the Switch Primary Job business process.

Parameters
switchPrimaryJobRequest The request object for the operation
Returns
  • The response from the operation
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public TerminateEmployeeEventResponseType terminateEmployee (TerminateEmployeeRequestType employee)

Terminates an employee.

Parameters
employee Wrapper for Terminate Employee Web Service and its sub-processes.
Returns
  • element with the Event ID for the Terminate Employee Event along with the worker reference.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public boolean validateConnection ()

Validate connection

Returns
  • true if the connector is connected