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

Interface WorkforceAvailabilityService

All Superinterfaces:

BatchService<WorkforceAvailabilityServiceBatch>

All Known Implementing Classes:

DefaultWorkforceAvailabilityService

public interface WorkforceAvailabilityService
extends BatchService<WorkforceAvailabilityServiceBatch>

This service enables you to create, read, update, and delete the (CRUD) daily availability information into the S/4HANA system from your external HR system when you are not using the SAP SuccessFactors Employee Central system.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_MANAGE_WF_AVAILABILITY
API Version:	1
Communication Scenario:	Employee Integration (SAP_COM_0001), External HR Workforce Integration (SAP_COM_0301), Employee Central via SAP CPI Integration (SAP_COM_0535)
Scope Items:	Core HR with SAP SuccessFactors Employee Central (JB1), Employee Integration - SAP S/4HANA Enablement (1FD), Financial Master Data for SAP SuccessFactors Employee Central (4AJ)
Authentication Methods:	x509

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
TimeOverviewCreateFluentHelper	createTimeOverview(TimeOverview timeOverview) Create a new TimeOverview entity and save it to the S/4HANA system.
TimeOverviewDeleteFluentHelper	deleteTimeOverview(TimeOverview timeOverview) Deletes an existing TimeOverview entity in the S/4HANA system.
TimeOverviewFluentHelper	getAllTimeOverview() Fetch multiple TimeOverview entities.
TimeOverviewByKeyFluentHelper	getTimeOverviewByKey(String personworkagreementexternalid, String companycode, LocalDateTime calendardate) Fetch a single TimeOverview entity using key fields.
TimeOverviewUpdateFluentHelper	updateTimeOverview(TimeOverview timeOverview) Update an existing TimeOverview entity and save it to the S/4HANA system.
WorkforceAvailabilityService	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.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
WorkforceAvailabilityService 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.

getAllTimeOverview

@Nonnull
TimeOverviewFluentHelper getAllTimeOverview()

Fetch multiple TimeOverview entities.

Returns:

A fluent helper to fetch multiple TimeOverview 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.

getTimeOverviewByKey

@Nonnull
TimeOverviewByKeyFluentHelper getTimeOverviewByKey(String personworkagreementexternalid,
                                                            String companycode,
                                                            LocalDateTime calendardate)

Fetch a single TimeOverview entity using key fields.

Parameters:

personworkagreementexternalid - Work Agreement External ID

Constraints: Not nullable, Maximum length: 20

companycode - The company code is an organizational unit within financial accounting.

Constraints: Not nullable, Maximum length: 4

calendardate - This field contains the date on which the corresponding data record is valid.

Constraints: Not nullable, Precision: 7

Returns:

A fluent helper to fetch a single TimeOverview 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.

createTimeOverview

@Nonnull
TimeOverviewCreateFluentHelper createTimeOverview(@Nonnull
                                                           TimeOverview timeOverview)

Create a new TimeOverview entity and save it to the S/4HANA system.

Parameters:

timeOverview - TimeOverview entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new TimeOverview entity. To perform execution, call the execute method on the fluent helper object.

updateTimeOverview

@Nonnull
TimeOverviewUpdateFluentHelper updateTimeOverview(@Nonnull
                                                           TimeOverview timeOverview)

Update an existing TimeOverview entity and save it to the S/4HANA system.

Parameters:

timeOverview - TimeOverview entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing TimeOverview entity. To perform execution, call the execute method on the fluent helper object.

deleteTimeOverview

@Nonnull
TimeOverviewDeleteFluentHelper deleteTimeOverview(@Nonnull
                                                           TimeOverview timeOverview)

Deletes an existing TimeOverview entity in the S/4HANA system.

Parameters:

timeOverview - TimeOverview entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing TimeOverview entity. To perform execution, call the execute method on the fluent helper object.