com.sap.cloud.sdk.s4hana.datamodel.odata.services

Class DefaultExternalJobSchedulerIntegrationService

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultExternalJobSchedulerIntegrationService

All Implemented Interfaces:

ExternalJobSchedulerIntegrationService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultExternalJobSchedulerIntegrationService")
public class DefaultExternalJobSchedulerIntegrationService
extends Object
implements ExternalJobSchedulerIntegrationService

This service enables external job schedulers to connect to the SAP back-end and perform the following operations on application jobs: get a list of application job templates, instantiate a job from a job template without parameters and with start condition ‘immediate start’, read the status of a job, and cancel or deschedule a job.

Reference: SAP API Business Hub

Details:

OData Service:	BC_EXT_APPJOB_MANAGEMENT
API Version:	2
Communication Scenario:	External Scheduler Integration (SAP_COM_0064)

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.ExternalJobSchedulerIntegrationService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultExternalJobSchedulerIntegrationService() Creates a service using ExternalJobSchedulerIntegrationService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
JobTemplateFluentHelper	getAllJobTemplate() Fetch multiple JobTemplate entities.
JobTemplateByKeyFluentHelper	getJobTemplateByKey(String jobTemplateName, String jobTemplateVersion) Fetch a single JobTemplate entity using key fields.
JobAbortFluentHelper	jobAbort(String jobRunCount, String jobName) Creates a fluent helper for the JobAbort OData function import.
JobCancelFluentHelper	jobCancel(String jobRunCount, String jobName) Creates a fluent helper for the JobCancel OData function import.
JobScheduleFluentHelper	jobSchedule(String jobUserID, String jobUserName, String jobText, String jobTemplateName, String jobParameterValues, Boolean testModeInd, String jobUser) Creates a fluent helper for the JobSchedule OData function import.
JobStatusGetFluentHelper	jobStatusGet(String jobName, String jobRunCount) Creates a fluent helper for the JobStatusGet OData function import.
DefaultExternalJobSchedulerIntegrationService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultExternalJobSchedulerIntegrationService

public DefaultExternalJobSchedulerIntegrationService()

Creates a service using ExternalJobSchedulerIntegrationService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultExternalJobSchedulerIntegrationService withServicePath(@Nonnull
                                                                              String servicePath)

Description copied from interface: ExternalJobSchedulerIntegrationService

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Specified by:

withServicePath in interface ExternalJobSchedulerIntegrationService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path

getAllJobTemplate

@Nonnull
public JobTemplateFluentHelper getAllJobTemplate()

Description copied from interface: ExternalJobSchedulerIntegrationService

Fetch multiple JobTemplate entities.

Specified by:

getAllJobTemplate in interface ExternalJobSchedulerIntegrationService

Returns:

A fluent helper to fetch multiple JobTemplate entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getJobTemplateByKey

@Nonnull
public JobTemplateByKeyFluentHelper getJobTemplateByKey(String jobTemplateName,
                                                                 String jobTemplateVersion)

Description copied from interface: ExternalJobSchedulerIntegrationService

Fetch a single JobTemplate entity using key fields.

Specified by:

getJobTemplateByKey in interface ExternalJobSchedulerIntegrationService

Returns:

A fluent helper to fetch a single JobTemplate entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

jobSchedule

@Nonnull
public JobScheduleFluentHelper jobSchedule(String jobUserID,
                                                    String jobUserName,
                                                    String jobText,
                                                    String jobTemplateName,
                                                    String jobParameterValues,
                                                    Boolean testModeInd,
                                                    String jobUser)

Description copied from interface: ExternalJobSchedulerIntegrationService

Creates a fluent helper for the JobSchedule OData function import.

Specified by:

jobSchedule in interface ExternalJobSchedulerIntegrationService

Parameters:

jobUserID - Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: JobUserID

jobUserName - Constraints: Nullable, Maximum length: 12

Original parameter name from the Odata EDM: JobUserName

jobText - Constraints: Not nullable, Maximum length: 120

Original parameter name from the Odata EDM: JobText

jobTemplateName - Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: JobTemplateName

jobParameterValues - Constraints: Nullable

Original parameter name from the Odata EDM: JobParameterValues

testModeInd - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: TestModeInd

jobUser - Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: JobUser

Returns:

A fluent helper object that will execute the JobSchedule OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

jobCancel

@Nonnull
public JobCancelFluentHelper jobCancel(String jobRunCount,
                                                String jobName)

Description copied from interface: ExternalJobSchedulerIntegrationService

Creates a fluent helper for the JobCancel OData function import.

Specified by:

jobCancel in interface ExternalJobSchedulerIntegrationService

Parameters:

jobRunCount - Constraints: Not nullable, Maximum length: 14

Original parameter name from the Odata EDM: JobRunCount

jobName - Constraints: Not nullable, Maximum length: 32

Original parameter name from the Odata EDM: JobName

Returns:

A fluent helper object that will execute the JobCancel OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

jobAbort

@Nonnull
public JobAbortFluentHelper jobAbort(String jobRunCount,
                                              String jobName)

Description copied from interface: ExternalJobSchedulerIntegrationService

Creates a fluent helper for the JobAbort OData function import.

Specified by:

jobAbort in interface ExternalJobSchedulerIntegrationService

Parameters:

jobRunCount - Constraints: Not nullable, Maximum length: 14

Original parameter name from the Odata EDM: JobRunCount

jobName - Constraints: Not nullable, Maximum length: 32

Original parameter name from the Odata EDM: JobName

Returns:

A fluent helper object that will execute the JobAbort OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

jobStatusGet

@Nonnull
public JobStatusGetFluentHelper jobStatusGet(String jobName,
                                                      String jobRunCount)

Description copied from interface: ExternalJobSchedulerIntegrationService

Creates a fluent helper for the JobStatusGet OData function import.

Specified by:

jobStatusGet in interface ExternalJobSchedulerIntegrationService

Parameters:

jobName - Constraints: none

Original parameter name from the Odata EDM: JobName

jobRunCount - Constraints: none

Original parameter name from the Odata EDM: JobRunCount

Returns:

A fluent helper object that will execute the JobStatusGet OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.