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

Class DefaultWorkforceAvailabilityService

java.lang.Object

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

All Implemented Interfaces:

BatchService<WorkforceAvailabilityServiceBatch>, WorkforceAvailabilityService

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

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 inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.WorkforceAvailabilityService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultWorkforceAvailabilityService() Creates a service using WorkforceAvailabilityService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultWorkforceAvailabilityServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultWorkforceAvailabilityService	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

DefaultWorkforceAvailabilityService

public DefaultWorkforceAvailabilityService()

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

Method Detail

withServicePath

@Nonnull
public DefaultWorkforceAvailabilityService withServicePath(@Nonnull
                                                                    String servicePath)

Description copied from interface: WorkforceAvailabilityService

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 WorkforceAvailabilityService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultWorkforceAvailabilityServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<WorkforceAvailabilityServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllTimeOverview

@Nonnull
public TimeOverviewFluentHelper getAllTimeOverview()

Description copied from interface: WorkforceAvailabilityService

Fetch multiple TimeOverview entities.

Specified by:

getAllTimeOverview in interface WorkforceAvailabilityService

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
public TimeOverviewByKeyFluentHelper getTimeOverviewByKey(String personworkagreementexternalid,
                                                                   String companycode,
                                                                   LocalDateTime calendardate)

Description copied from interface: WorkforceAvailabilityService

Fetch a single TimeOverview entity using key fields.

Specified by:

getTimeOverviewByKey in interface WorkforceAvailabilityService

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
public TimeOverviewCreateFluentHelper createTimeOverview(@Nonnull
                                                                  TimeOverview timeOverview)

Description copied from interface: WorkforceAvailabilityService

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

Specified by:

createTimeOverview in interface WorkforceAvailabilityService

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
public TimeOverviewUpdateFluentHelper updateTimeOverview(@Nonnull
                                                                  TimeOverview timeOverview)

Description copied from interface: WorkforceAvailabilityService

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

Specified by:

updateTimeOverview in interface WorkforceAvailabilityService

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
public TimeOverviewDeleteFluentHelper deleteTimeOverview(@Nonnull
                                                                  TimeOverview timeOverview)

Description copied from interface: WorkforceAvailabilityService

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

Specified by:

deleteTimeOverview in interface WorkforceAvailabilityService

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.