com.sap.cloud.sdk.s4hana.datamodel.odata.services.ExternalJobSchedulerIntegrationService Maven / Gradle / Ivy
/*
* Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
*/
package com.sap.cloud.sdk.s4hana.datamodel.odata.services;
import javax.annotation.Nonnull;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobAbortFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobCancelFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobScheduleFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobStatusGetFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobTemplateByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobTemplateFluentHelper;
/**
*
* 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)
*
*
*
*/
public interface ExternalJobSchedulerIntegrationService
{
/**
* If no other path was provided via the {@link #withServicePath(String)} method, this is the default service path
* used to access the endpoint.
*
*/
String DEFAULT_SERVICE_PATH = "/sap/opu/odata/sap/BC_EXT_APPJOB_MANAGEMENT;v=0002";
/**
* Overrides the default service path and returns a new service instance with the specified service path. Also
* adjusts the respective entity URLs.
*
* @param servicePath
* Service path that will override the default.
* @return A new service instance with the specified service path.
*/
@Nonnull
ExternalJobSchedulerIntegrationService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobTemplate
* JobTemplate} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobTemplate
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobTemplateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
JobTemplateFluentHelper getAllJobTemplate();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobTemplate
* JobTemplate} entity using key fields.
*
* @param jobTemplateName
*
* @param jobTemplateVersion
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobTemplate
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobTemplateByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
JobTemplateByKeyFluentHelper getJobTemplateByKey( final String jobTemplateName, final String jobTemplateVersion );
/**
*
* Creates a fluent helper for the JobSchedule OData function import.
*
*
* @param testModeInd
* Indicator
*
*
*
* Constraints: Nullable
*
*
* Original parameter name from the Odata EDM: TestModeInd
*
* @param jobText
* Constraints: Not nullable, Maximum length: 120
*
* Original parameter name from the Odata EDM: JobText
*
* @param jobUserName
* Constraints: Nullable, Maximum length: 12
*
* Original parameter name from the Odata EDM: JobUserName
*
* @param jobParameterValues
* Constraints: Nullable
*
* Original parameter name from the Odata EDM: JobParameterValues
*
* @param jobUser
* Constraints: Nullable, Maximum length: 40
*
* Original parameter name from the Odata EDM: JobUser
*
* @param jobUserID
* Constraints: Nullable, Maximum length: 40
*
* Original parameter name from the Odata EDM: JobUserID
*
* @param jobTemplateName
* Constraints: Not nullable, Maximum length: 40
*
* Original parameter name from the Odata EDM: JobTemplateName
*
* @return A fluent helper object that will execute the JobSchedule OData function import with the provided
* parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobScheduleFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
JobScheduleFluentHelper jobSchedule(
final String jobUserID,
final String jobUserName,
final String jobText,
final String jobTemplateName,
final String jobParameterValues,
final Boolean testModeInd,
final String jobUser );
/**
*
* Creates a fluent helper for the JobCancel OData function import.
*
*
* @param jobName
* Constraints: Not nullable, Maximum length: 32
*
* Original parameter name from the Odata EDM: JobName
*
* @param jobRunCount
* Constraints: Not nullable, Maximum length: 14
*
* Original parameter name from the Odata EDM: JobRunCount
*
* @return A fluent helper object that will execute the JobCancel OData function import with the provided
* parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobCancelFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
JobCancelFluentHelper jobCancel( final String jobRunCount, final String jobName );
/**
*
* Creates a fluent helper for the JobAbort OData function import.
*
*
* @param jobName
* Constraints: Not nullable, Maximum length: 32
*
* Original parameter name from the Odata EDM: JobName
*
* @param jobRunCount
* Constraints: Not nullable, Maximum length: 14
*
* Original parameter name from the Odata EDM: JobRunCount
*
* @return A fluent helper object that will execute the JobAbort OData function import with the provided
* parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobAbortFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
JobAbortFluentHelper jobAbort( final String jobRunCount, final String jobName );
/**
*
* Creates a fluent helper for the JobStatusGet OData function import.
*
*
* @param jobName
* Constraints: none
*
* Original parameter name from the Odata EDM: JobName
*
* @param jobRunCount
* Constraints: none
*
* Original parameter name from the Odata EDM: JobRunCount
*
* @return A fluent helper object that will execute the JobStatusGet OData function import with the provided
* parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobStatusGetFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
JobStatusGetFluentHelper jobStatusGet( final String jobName, final String jobRunCount );
}