Package org.apache.fineract.client.services

Interface BusinessStepConfigurationApi

public interface BusinessStepConfigurationApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<JobBusinessStepDetail>	retrieveAllAvailableBusinessStep(String jobName)	List Business Step Configurations for a Job Returns the available Business Steps for a job
retrofit2.Call<JobBusinessStepDetail>	retrieveAllAvailableBusinessStep(String jobName, Map<String,String> headers)	List Business Step Configurations for a Job Returns the available Business Steps for a job
retrofit2.Call<ConfiguredJobNamesDTO>	retrieveAllConfiguredBusinessJobs()	List Business Jobs Returns the configured Business Jobs
retrofit2.Call<ConfiguredJobNamesDTO>	retrieveAllConfiguredBusinessJobs(Map<String,String> headers)	List Business Jobs Returns the configured Business Jobs
retrofit2.Call<JobBusinessStepConfigData>	retrieveAllConfiguredBusinessStep(String jobName)	List Business Step Configurations for a Job Returns the configured Business Steps for a job
retrofit2.Call<JobBusinessStepConfigData>	retrieveAllConfiguredBusinessStep(String jobName, Map<String,String> headers)	List Business Step Configurations for a Job Returns the configured Business Steps for a job
retrofit2.Call<Void>	updateJobBusinessStepConfig(String jobName)	List Business Step Configurations for a Job Updates the Business steps execution order for a job
retrofit2.Call<Void>	updateJobBusinessStepConfig(String jobName, Map<String,String> headers)	List Business Step Configurations for a Job Updates the Business steps execution order for a job
retrofit2.Call<Void>	updateJobBusinessStepConfig(String jobName, BusinessStepRequest businessStepRequest)	List Business Step Configurations for a Job Updates the Business steps execution order for a job
retrofit2.Call<Void>	updateJobBusinessStepConfig(String jobName, BusinessStepRequest businessStepRequest, Map<String,String> headers)	List Business Step Configurations for a Job Updates the Business steps execution order for a job

Method Details

retrieveAllAvailableBusinessStep

@GET("v1/jobs/{jobName}/available-steps")
retrofit2.Call<JobBusinessStepDetail> retrieveAllAvailableBusinessStep(@Path("jobName")
 String jobName)

List Business Step Configurations for a Job Returns the available Business Steps for a job

Parameters:

jobName - jobName (required)

Returns:

Call<JobBusinessStepDetail>

retrieveAllConfiguredBusinessJobs

@GET("v1/jobs/names")
retrofit2.Call<ConfiguredJobNamesDTO> retrieveAllConfiguredBusinessJobs()

List Business Jobs Returns the configured Business Jobs

Returns:

Call<ConfiguredJobNamesDTO>

retrieveAllConfiguredBusinessStep

@GET("v1/jobs/{jobName}/steps")
retrofit2.Call<JobBusinessStepConfigData> retrieveAllConfiguredBusinessStep(@Path("jobName")
 String jobName)

List Business Step Configurations for a Job Returns the configured Business Steps for a job

Parameters:

jobName - jobName (required)

Returns:

Call<JobBusinessStepConfigData>

updateJobBusinessStepConfig

@Headers("Content-Type:application/json")
@PUT("v1/jobs/{jobName}/steps")
retrofit2.Call<Void> updateJobBusinessStepConfig(@Path("jobName")
 String jobName,
 @Body
 BusinessStepRequest businessStepRequest)

List Business Step Configurations for a Job Updates the Business steps execution order for a job

Parameters:

jobName - jobName (required)

businessStepRequest - (optional)

Returns:

Call<Void>

updateJobBusinessStepConfig

@Headers("Content-Type:application/json")
@PUT("v1/jobs/{jobName}/steps")
retrofit2.Call<Void> updateJobBusinessStepConfig(@Path("jobName")
 String jobName)

List Business Step Configurations for a Job Updates the Business steps execution order for a job

Parameters:

jobName - jobName (required)

businessStepRequest - (optional)

Returns:

Call<Void>

retrieveAllAvailableBusinessStep

@GET("v1/jobs/{jobName}/available-steps")
retrofit2.Call<JobBusinessStepDetail> retrieveAllAvailableBusinessStep(@Path("jobName")
 String jobName,
 @HeaderMap
 Map<String,String> headers)

List Business Step Configurations for a Job Returns the available Business Steps for a job

Parameters:

jobName - jobName (required)

Returns:

Call<JobBusinessStepDetail>

retrieveAllConfiguredBusinessJobs

@GET("v1/jobs/names")
retrofit2.Call<ConfiguredJobNamesDTO> retrieveAllConfiguredBusinessJobs(@HeaderMap
 Map<String,String> headers)

List Business Jobs Returns the configured Business Jobs

Returns:

Call<ConfiguredJobNamesDTO>

retrieveAllConfiguredBusinessStep

@GET("v1/jobs/{jobName}/steps")
retrofit2.Call<JobBusinessStepConfigData> retrieveAllConfiguredBusinessStep(@Path("jobName")
 String jobName,
 @HeaderMap
 Map<String,String> headers)

List Business Step Configurations for a Job Returns the configured Business Steps for a job

Parameters:

jobName - jobName (required)

Returns:

Call<JobBusinessStepConfigData>

updateJobBusinessStepConfig

@Headers("Content-Type:application/json")
@PUT("v1/jobs/{jobName}/steps")
retrofit2.Call<Void> updateJobBusinessStepConfig(@Path("jobName")
 String jobName,
 @Body
 BusinessStepRequest businessStepRequest,
 @HeaderMap
 Map<String,String> headers)

List Business Step Configurations for a Job Updates the Business steps execution order for a job

Parameters:

jobName - jobName (required)

businessStepRequest - (optional)

Returns:

Call<Void>

updateJobBusinessStepConfig

@Headers("Content-Type:application/json")
@PUT("v1/jobs/{jobName}/steps")
retrofit2.Call<Void> updateJobBusinessStepConfig(@Path("jobName")
 String jobName,
 @HeaderMap
 Map<String,String> headers)

List Business Step Configurations for a Job Updates the Business steps execution order for a job

Parameters:

jobName - jobName (required)

businessStepRequest - (optional)

Returns:

Call<Void>