org.mule.modules.successfactors

Class SuccessFactorsConnector

java.lang.Object

org.mule.modules.successfactors.SuccessFactorsConnector

@Connector(name="successfactors",
           schemaVersion="1.1.4",
           friendlyName="Success Factors",
           minMuleVersion="3.7")
@ReconnectOn(exceptions=SuccessFactorsSessionExpiredException.class)
@RequiresEnterpriseLicense
public class SuccessFactorsConnector
extends Object

Success Factors Connector This connector allows to integrate the Success Factor service. It covers all the service provided by SF. This is a generic service that enforces the use of Entities in all the major operations and query consults in SFQL (Success Factors Query Language). Also has a separate set of operations to work with asynchronous jobs.

Author:

MuleSoft, Inc.

Constructor Summary

Constructors

Constructor and Description
SuccessFactorsConnector()

Method Summary

Methods

Modifier and Type	Method and Description
TaskStatus	cancelJob(String taskId) Download the result of submitted asynchronous query job.
DeleteResult	delete(String type, Map<String,Object> input) Deletes the SFObjects specified by the type and the objects.
List<DescribeResult>	describeEntities(List<String> types) Returns metadata about the list of entities specified in the type parameter (both field and entity information).
Config	getConfig()
DataHandler	getJobResult(GetJobResult params) Download the result of submitted asynchronous query job.
TaskStatus	getJobStatus(String taskId) Get the execution status of the submitted asynchronous job.
InsertResult	insert(String type, Map<String,Object> input) Inserts the objects of the specified entity type.
List<String>	listEntities() List all the entities in your company instance.
List<TaskStatus>	listJobs() List all Jobs which are in running or waiting to run.
org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,SuccessFactorsConnector>	query(String queryString, org.mule.streaming.PagingConfiguration pagingConfiguration) Queries the SuccessFactors platform with the given query string in SFQL (SuccessFactors Query Language).
void	setConfig(Config config)
TaskStatus	submitQueryJob(String queryString, List<SFParameter> params) Submit the asynchronous query job to the SuccessFactors platform with the given query string in SFQL (SuccessFactors Query Language).
String	translate(org.mule.common.query.DsqlQuery queryToTranslate)
UpdateResult	update(String type, Map<String,Object> input) Updates the objects of the specified entity type.
UpsertResult	upsert(String type, Map<String,Object> input) Inserts or updates the objects of the specified entity type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SuccessFactorsConnector

public SuccessFactorsConnector()

Method Detail

listEntities

@Processor
@NotNull
public List<String> listEntities()
                          throws SuccessFactorsException

List all the entities in your company instance.

Returns:

A list of String that contains the names of the entities

Throws:

SuccessFactorsException - If any error occurs throw this exception with a personalized code and message for each case.

describeEntities

@Processor
@NotNull
public List<DescribeResult> describeEntities(@Default(value="#[payload]")@NotNull
                                                      List<String> types)
                                      throws SuccessFactorsException

Returns metadata about the list of entities specified in the type parameter (both field and entity information).

Parameters:

types - The list of entities from which you want to obtain detailed information

Returns:

A list of DescribeResult that has detailed information of each entity

Throws:

SuccessFactorsException - If any error occurs throw this exception with a personalized code and message for each case.

insert

@Processor
@MetaDataScope(value=InsertMetadata.class)
@NotNull
public InsertResult insert(@MetaDataKeyParam(affects=INPUT)@NotNull
                                                                      String type,
                                                                      @Default(value="#[payload]")@NotNull
                                                                      Map<String,Object> input)
                    throws SuccessFactorsException

Inserts the objects of the specified entity type. The operation will resume if one row has failed to insert.

Parameters:

type - The entity type to be inserted.

input - The processor's input, containing the list of entities to be inserted and extra parameters for configuration.

Returns:

The result of the operation

Throws:

SuccessFactorsException - If any error occurs throw this exception with a personalized code and message for each case.

update

@Processor
@MetaDataScope(value=UpdateMetadata.class)
@NotNull
public UpdateResult update(@MetaDataKeyParam(affects=INPUT)@NotNull
                                                                      String type,
                                                                      @Default(value="#[payload]")@NotNull
                                                                      Map<String,Object> input)
                    throws SuccessFactorsException

Updates the objects of the specified entity type. The operation will resume if one row has failed to update.

Parameters:

type - The entity type to be updated.

input - The processor's input, containing the list of entities to be updated and extra parameters for configuration.

Returns:

The result of the operation

Throws:

SuccessFactorsException - If any error occurs throw this exception with a personalized code and message for each case.

upsert

@Processor
@MetaDataScope(value=UpsertMetadata.class)
@NotNull
public UpsertResult upsert(@MetaDataKeyParam(affects=INPUT)@NotNull
                                                                      String type,
                                                                      @Default(value="#[payload]")@NotNull
                                                                      Map<String,Object> input)
                    throws SuccessFactorsException

Inserts or updates the objects of the specified entity type. If the row doesn't exist, perform the insert operation, if the row exists, perform the update operation. The operation will resume if one row has failed to upsert.

Parameters:

type - The entity type to be upserted.

input - The processor's input, containing the list of entities to be updated/inserted and extra parameters for configuration.

Returns:

The result of the operation

Throws:

SuccessFactorsException - If any error occurs throw this exception with a personalized code and message for each case.

delete

@Processor
@MetaDataScope(value=DeleteMetadata.class)
@NotNull
public DeleteResult delete(@MetaDataKeyParam(affects=INPUT)@NotNull
                                                                      String type,
                                                                      @Default(value="#[payload]")@NotNull
                                                                      Map<String,Object> input)
                    throws SuccessFactorsException

Deletes the SFObjects specified by the type and the objects. The operation will resume if one row has failed to delete.

Parameters:

type - The entity type to be deleted.

input - The processor's input, containing the list of entities to be deleted and extra parameters for configuration.

Returns:

The result of the operation

Throws:

SuccessFactorsException - If any error occurs throw this exception with a personalized code and message for each case.

query

@Processor
@Paged
@MetaDataScope(value=QueryMetadata.class)
@NotNull
public org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,SuccessFactorsConnector> query(@Default(value="#[payload]")@Query@NotNull
                                                                                                                                                        String queryString,
                                                                                                                                                        @RefOnly@NotNull
                                                                                                                                                        org.mule.streaming.PagingConfiguration pagingConfiguration)

Queries the SuccessFactors platform with the given query string in SFQL (SuccessFactors Query Language). For a detailed grammar description, please check the related section in this reference guide.

Parameters:

queryString - The query in SFQL format

pagingConfiguration - The PagingConfiguration object with the needed parameters for paged queries.

Returns:

The QueryPagingDelegate that handles the calls to SuccessFactors to run the query.

translate

@QueryTranslator
@NotNull
public String translate(@NotNull
                                       org.mule.common.query.DsqlQuery queryToTranslate)

submitQueryJob

@Processor
@NotNull
public TaskStatus submitQueryJob(@Default(value="#[payload]")@NotNull
                                          String queryString,
                                          @RefOnly@Optional@Nullable
                                          List<SFParameter> params)
                          throws SuccessFactorsException

Submit the asynchronous query job to the SuccessFactors platform with the given query string in SFQL (SuccessFactors Query Language). TaskStatus includes “taskId” which is used to identify a submitted job.

Parameters:

queryString - The query in SFQL format

params - Extra parameters for configuration

Returns:

The status of the task created

Throws:

SuccessFactorsException - If any error occurs throw this exception with a personalized code and message for each case.

getJobStatus

@Processor
@NotNull
public TaskStatus getJobStatus(@Default(value="#[payload]")@NotNull
                                        String taskId)
                        throws SuccessFactorsException

Get the execution status of the submitted asynchronous job.

Parameters:

taskId - The id of the task to obtain the status information

Returns:

The status of the task requested

Throws:

SuccessFactorsException - If any error occurs throw this exception with a personalized code and message for each case.

getJobResult

@Processor
@NotNull
public DataHandler getJobResult(@Default(value="#[payload]")@RefOnly@NotNull
                                         GetJobResult params)
                         throws SuccessFactorsException

Download the result of submitted asynchronous query job.

Parameters:

params - Extra parameters for configuration

Returns:

A DataHandler to obtain the information generated by the task

Throws:

SuccessFactorsException - If any error occurs throw this exception with a personalized code and message for each case.

listJobs

@Processor
@NotNull
public List<TaskStatus> listJobs()
                          throws SuccessFactorsException

List all Jobs which are in running or waiting to run.

Returns:

A list with the status of all the Jobs

Throws:

SuccessFactorsException - If any error occurs throw this exception with a personalized code and message for each case.

cancelJob

@Processor
@NotNull
public TaskStatus cancelJob(@Default(value="#[payload]")@NotNull
                                     String taskId)
                     throws SuccessFactorsException

Download the result of submitted asynchronous query job.

Parameters:

taskId - The id of the task to cancel the execution

Returns:

The status of the task stopped

Throws:

SuccessFactorsException - If any error occurs throw this exception with a personalized code and message for each case.

getConfig

@NotNull
public Config getConfig()

setConfig

public void setConfig(@NotNull
             Config config)