public class

CxfIntegrationsClient

extends AbstractCxfWorkdayClient<A>
implements IntegrationsPort
java.lang.Object
   ↳ org.mule.modules.workday.api.AbstractCxfWorkdayClient<A>
     ↳ org.mule.modules.workday.integrations.CxfIntegrationsClient

Class Overview

CxfWorkdayClient Implementation of Workday client that uses CXF

Summary

[Expand]
Inherited Fields
From class org.mule.modules.workday.api.AbstractCxfWorkdayClient
Public Constructors
CxfIntegrationsClient(String username, String password, String endpoint, String wsdlLocation)
Public Methods
ApproveBusinessProcessResponseType approveBusinessProcess(ApproveBusinessProcessRequestType body)
This operation approves a business process, if approvable, by the user
CancelBusinessProcessResponseType cancelBusinessProcess(CancelBusinessProcessRequestType body)
This operation cancels a business process, if cancelable, by the user
DenyBusinessProcessResponseType denyBusinessProcess(DenyBusinessProcessRequestType body)
This operation denies a business process, if deniable, by the user
GetEIBDefinitionsResponseType getEIBDefinitions(GetEIBDefinitionsRequestType body)
This operation will retrieve data related to an EIB definition.
GetEventDetailsResponseType getEventDetail(GetEventDetailsRequestType body)
This operation will retrieve data (e.g.
GetEventDocumentsResponseType getEventDocuments(GetEventDocumentsRequestType body)
This operation will retrieve data related to any Documents that may be available to an Integration Event.
GetIntegrationEventsResponseType getIntegrationEvents(GetIntegrationEventsRequestType body)
This operation will retrieve data related to an execution of an Integration Event.
GetIntegrationSystemUsersResponseType getIntegrationSystemUsers(GetIntegrationSystemUsersRequestType body)
This operation will retrieve data related to Workday Accounts associated to an Integration System.
GetIntegrationSystemsResponseType getIntegrationSystems(GetIntegrationSystemsRequestType body)
This operation will retrieve data related to an Integration System.
GetReferencesResponseType getReferences(GetReferencesRequestType body)
This operation provide a list of values for a business object in Workday given its "Reference ID Type".
GetSequenceGeneratorsResponseType getSequenceGenerators(GetSequenceGeneratorsRequestType body)
This operation will retrieve data related to a Sequence Generator (e.g ID Definition).
GetSubscriptionsResponseType getSubscriptions(GetSubscriptionsRequestType body)
This operation will retrieve data related to Subscriptions, both for an Integration System and for Transaction Log service configuration.
IncrementSequenceGeneratorResponseType incrementSequenceGenerator(IncrementSequenceGeneratorRequestType body)
This operation will increments a Sequence Generator and persists the data within Workday.
LaunchEIBResponseType launchEIB(LaunchEIBRequestType body)
This operation will Launch an EIB Integration.
LaunchIntegrationEventResponseType launchIntegration(LaunchIntegrationEventRequestType body)
This operation will Launch an Integration.
PutIntegrationEventResponseType putIntegrationEvent(PutIntegrationEventRequestType body)
This operation will create and/or update data related to an Integration Event.
PutIntegrationMessageResponseType putIntegrationMessage(PutIntegrationMessageRequestType body)
This operation adds a message to either an Integration System or Integration Event which allows for status, information and error details to be communicated back to Workday.
PutIntegrationSystemResponseType putIntegrationSystem(PutIntegrationSystemRequestType body)
This operation will create and/or update data related to an Integration System.
PutIntegrationSystemUserResponseType putIntegrationSystemUser(PutIntegrationSystemUserRequestType body)
This operation will create and/or update data related to Workday Accounts associated to an Integration System.
PutReferenceResponseType putReference(PutReferenceRequestType body)
This operation updates the Reference IDs on a business object for a Reference ID Type.
PutSequenceGeneratorResponseType putSequenceGenerator(PutSequenceGeneratorRequestType body)
This operation will create and/or update data related to a Sequence Generator (e.g ID Definition).
PutSubscriptionResponseType putSubscription(PutSubscriptionRequestType body)
This operation will create and/or update data related to Subscriptions, both for an Integration System and for Transaction Log service configuration.
RescindBusinessProcessResponseType rescindBusinessProcess(RescindBusinessProcessRequestType body)
This operation rescinds a business process, if rescindable by the user
Protected Methods
Class<IntegrationsPort> portType()
Class<? extends Service> serviceType()
[Expand]
Inherited Methods
From class org.mule.modules.workday.api.AbstractCxfWorkdayClient
From class java.lang.Object
From interface com.workday.integrations.IntegrationsPort

Public Constructors

public CxfIntegrationsClient (String username, String password, String endpoint, String wsdlLocation)

Parameters
username
password
endpoint
wsdlLocation

Public Methods

public ApproveBusinessProcessResponseType approveBusinessProcess (ApproveBusinessProcessRequestType body)

This operation approves a business process, if approvable, by the user

Parameters
body

public CancelBusinessProcessResponseType cancelBusinessProcess (CancelBusinessProcessRequestType body)

This operation cancels a business process, if cancelable, by the user

Parameters
body

public DenyBusinessProcessResponseType denyBusinessProcess (DenyBusinessProcessRequestType body)

This operation denies a business process, if deniable, by the user

Parameters
body

public GetEIBDefinitionsResponseType getEIBDefinitions (GetEIBDefinitionsRequestType body)

This operation will retrieve data related to an EIB definition. An EIB definition will include the Integration System and a Data Source, Transformation and Transport Protocol definition.

Parameters
body

public GetEventDetailsResponseType getEventDetail (GetEventDetailsRequestType body)

This operation will retrieve data (e.g. Creation Date, Event State, Event Target, etc..) related to Workday Business Process Event (e.g. Hire Employee, Enter Time Off, etc...)

Parameters
body

public GetEventDocumentsResponseType getEventDocuments (GetEventDocumentsRequestType body)

This operation will retrieve data related to any Documents that may be available to an Integration Event.

Parameters
body

public GetIntegrationEventsResponseType getIntegrationEvents (GetIntegrationEventsRequestType body)

This operation will retrieve data related to an execution of an Integration Event. Data included will be Integration System, Launch datetime, Triggering User, Status and Runtime Parameters.

Parameters
body

public GetIntegrationSystemUsersResponseType getIntegrationSystemUsers (GetIntegrationSystemUsersRequestType body)

This operation will retrieve data related to Workday Accounts associated to an Integration System.

Parameters
body

public GetIntegrationSystemsResponseType getIntegrationSystems (GetIntegrationSystemsRequestType body)

This operation will retrieve data related to an Integration System. Data returned within the response includes Services associated and enabled, Attribute/Map values, Service configurations and Custom Services Attributes, Maps and Launch Parameters.

Parameters
body

public GetReferencesResponseType getReferences (GetReferencesRequestType body)

This operation provide a list of values for a business object in Workday given its "Reference ID Type". The "Reference ID Type" for each referenced business object can be retrieved within our API Documentation. For example, the "Reference ID Type" for a Location reference is "Location_ID". So, if we call "Get References" with "Location_ID" you will get back the list of all locations (and their Workday and Reference IDs).

Parameters
body

public GetSequenceGeneratorsResponseType getSequenceGenerators (GetSequenceGeneratorsRequestType body)

This operation will retrieve data related to a Sequence Generator (e.g ID Definition). Data associated to a Sequence Generator includes the formatting, syntax, last date used, increment value, etc. Sequence Generators are typically associated with Integrations utilizing a Sequence Generator Service.

Parameters
body

public GetSubscriptionsResponseType getSubscriptions (GetSubscriptionsRequestType body)

This operation will retrieve data related to Subscriptions, both for an Integration System and for Transaction Log service configuration. A Subscription includes an association with 1 or more Transaction/Business Process Types.

Parameters
body

public IncrementSequenceGeneratorResponseType incrementSequenceGenerator (IncrementSequenceGeneratorRequestType body)

This operation will increments a Sequence Generator and persists the data within Workday. The response is the fully formatted value of the Sequence Generator after the increment.

Parameters
body

public LaunchEIBResponseType launchEIB (LaunchEIBRequestType body)

This operation will Launch an EIB Integration. The request has the ability to accept override Runtime Parameters that should be used within the integration processing. If no override is provided within the request, the System Default, which has been defined on the EIB Definition, will be used. The result of this operation will be the creation of an Integration Event along with the processing of the integration itself.

Parameters
body

public LaunchIntegrationEventResponseType launchIntegration (LaunchIntegrationEventRequestType body)

This operation will Launch an Integration. The request has the ability to accept Runtime Parameters and the Workday Account that should be used within the integration processing. The result of this operation will be the creation of an Integration Event along with the processing of the integration itself.

Parameters
body

public PutIntegrationEventResponseType putIntegrationEvent (PutIntegrationEventRequestType body)

This operation will create and/or update data related to an Integration Event. Data included will be Integration System, Launch datetime, Triggering User, Status and Runtime Parameters.

Parameters
body

public PutIntegrationMessageResponseType putIntegrationMessage (PutIntegrationMessageRequestType body)

This operation adds a message to either an Integration System or Integration Event which allows for status, information and error details to be communicated back to Workday.

Parameters
body

public PutIntegrationSystemResponseType putIntegrationSystem (PutIntegrationSystemRequestType body)

This operation will create and/or update data related to an Integration System. Data returned within the response includes Services associated and enabled, Attribute/Map values, Service configurations and Custom Services Attributes, Maps and Launch Parameters.

Parameters
body

public PutIntegrationSystemUserResponseType putIntegrationSystemUser (PutIntegrationSystemUserRequestType body)

This operation will create and/or update data related to Workday Accounts associated to an Integration System.

Parameters
body

public PutReferenceResponseType putReference (PutReferenceRequestType body)

This operation updates the Reference IDs on a business object for a Reference ID Type. Currently, updating Reference IDs for most, but not all Reference ID Types is supported.

Parameters
body

public PutSequenceGeneratorResponseType putSequenceGenerator (PutSequenceGeneratorRequestType body)

This operation will create and/or update data related to a Sequence Generator (e.g ID Definition). Data associated to a Sequence Generator includes the formatting, syntax, last date used, increment value, etc. Sequence Generators are typically associated with Integrations utilizing a Sequence Generator Service.

Parameters
body

public PutSubscriptionResponseType putSubscription (PutSubscriptionRequestType body)

This operation will create and/or update data related to Subscriptions, both for an Integration System and for Transaction Log service configuration. A Subscription includes an association with 1 or more Transaction/Business Process Types.

Parameters
body

public RescindBusinessProcessResponseType rescindBusinessProcess (RescindBusinessProcessRequestType body)

This operation rescinds a business process, if rescindable by the user

Parameters
body

Protected Methods

protected Class<IntegrationsPort> portType ()

protected Class<? extends Service> serviceType ()