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

Class DefaultWorkforceTimesheetService

java.lang.Object

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

All Implemented Interfaces:

BatchService<WorkforceTimesheetServiceBatch>, WorkforceTimesheetService

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

This service enables you to create, read, update, and delete (CRUD) data related to timesheet of a workforce (Employees or Contingent Workers) with the data provided in a payload, in an API call. This service also supports automatic posting of timesheet data to the controlling module synchronously.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_MANAGE_WORKFORCE_TIMESHEET
API Version:	1
Communication Scenario:	Workforce Timesheet Integration (SAP_COM_0027)
Scope Items:	Time Recording (1Q4), Time Recording - Project-Based Services (J12)
Authentication Methods:	Basic, x509

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultWorkforceTimesheetService() Creates a service using WorkforceTimesheetService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultWorkforceTimesheetServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
TimeSheetEntryCreateFluentHelper	createTimeSheetEntry(TimeSheetEntry timeSheetEntry) Create a new TimeSheetEntry entity and save it to the S/4HANA system.
TimeSheetEntryFluentHelper	getAllTimeSheetEntry() Fetch multiple TimeSheetEntry entities.
TimeSheetEntryByKeyFluentHelper	getTimeSheetEntryByKey(String personWorkAgreementExternalID, String companyCode, String timeSheetRecord) Fetch a single TimeSheetEntry entity using key fields.
DefaultWorkforceTimesheetService	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

DefaultWorkforceTimesheetService

public DefaultWorkforceTimesheetService()

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

Method Detail

withServicePath

@Nonnull
public DefaultWorkforceTimesheetService withServicePath(@Nonnull
                                                                 String servicePath)

Description copied from interface: WorkforceTimesheetService

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 WorkforceTimesheetService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultWorkforceTimesheetServiceBatch batch()

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

Specified by:

batch in interface BatchService<WorkforceTimesheetServiceBatch>

Returns:

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

getAllTimeSheetEntry

@Nonnull
public TimeSheetEntryFluentHelper getAllTimeSheetEntry()

Description copied from interface: WorkforceTimesheetService

Fetch multiple TimeSheetEntry entities.

Specified by:

getAllTimeSheetEntry in interface WorkforceTimesheetService

Returns:

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

getTimeSheetEntryByKey

@Nonnull
public TimeSheetEntryByKeyFluentHelper getTimeSheetEntryByKey(String personWorkAgreementExternalID,
                                                                       String companyCode,
                                                                       String timeSheetRecord)

Description copied from interface: WorkforceTimesheetService

Fetch a single TimeSheetEntry entity using key fields.

Specified by:

getTimeSheetEntryByKey in interface WorkforceTimesheetService

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

timeSheetRecord - The system assigns time sheet records a counter. The counter represents a record's unique database ID.

Constraints: Not nullable, Maximum length: 12

Returns:

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

createTimeSheetEntry

@Nonnull
public TimeSheetEntryCreateFluentHelper createTimeSheetEntry(@Nonnull
                                                                      TimeSheetEntry timeSheetEntry)

Description copied from interface: WorkforceTimesheetService

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

Specified by:

createTimeSheetEntry in interface WorkforceTimesheetService

Parameters:

timeSheetEntry - TimeSheetEntry entity object that will be created in the S/4HANA system.

Returns:

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