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

Interface ExternalJobSchedulerIntegrationService

All Superinterfaces:

BatchService<ExternalJobSchedulerIntegrationServiceBatch>

All Known Implementing Classes:

DefaultExternalJobSchedulerIntegrationService

public interface ExternalJobSchedulerIntegrationService
extends BatchService<ExternalJobSchedulerIntegrationServiceBatch>

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

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

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.
ExternalJobSchedulerIntegrationService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
ExternalJobSchedulerIntegrationService withServicePath(@Nonnull
                                                                String servicePath)

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

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

getAllJobTemplate

@Nonnull
JobTemplateFluentHelper getAllJobTemplate()

Fetch multiple JobTemplate entities.

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
JobTemplateByKeyFluentHelper getJobTemplateByKey(String jobTemplateName,
                                                          String jobTemplateVersion)

Fetch a single JobTemplate entity using key fields.

Parameters:

jobTemplateName -

jobTemplateVersion -

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
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.

Parameters:

testModeInd - Indicator

Constraints: Nullable

Original parameter name from the Odata EDM: TestModeInd

jobText - Constraints: Not nullable, Maximum length: 120

Original parameter name from the Odata EDM: JobText

jobUserName - Constraints: Nullable, Maximum length: 12

Original parameter name from the Odata EDM: JobUserName

jobParameterValues - Constraints: Nullable

Original parameter name from the Odata EDM: JobParameterValues

jobUser - Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: JobUser

jobUserID - Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: JobUserID

jobTemplateName - Constraints: Not nullable, Maximum length: 40

Original parameter name from the Odata EDM: JobTemplateName

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
JobCancelFluentHelper jobCancel(String jobRunCount,
                                         String jobName)

Creates a fluent helper for the JobCancel OData function import.

Parameters:

jobName - Constraints: Not nullable, Maximum length: 32

Original parameter name from the Odata EDM: JobName

jobRunCount - Constraints: Not nullable, Maximum length: 14

Original parameter name from the Odata EDM: JobRunCount

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
JobAbortFluentHelper jobAbort(String jobRunCount,
                                       String jobName)

Creates a fluent helper for the JobAbort OData function import.

Parameters:

jobName - Constraints: Not nullable, Maximum length: 32

Original parameter name from the Odata EDM: JobName

jobRunCount - Constraints: Not nullable, Maximum length: 14

Original parameter name from the Odata EDM: JobRunCount

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
JobStatusGetFluentHelper jobStatusGet(String jobName,
                                               String jobRunCount)

Creates a fluent helper for the JobStatusGet OData function import.

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.