com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.workforceavailability

Class TimeOverview

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject<EntityT>

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmEntity<TimeOverview>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.workforceavailability.TimeOverview

public class TimeOverview
extends VdmEntity<TimeOverview>

Time Overview

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeOverview.TimeOverviewBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static TimeOverviewField<BigDecimal>	ABSENCEHOURS Use with available fluent helpers to apply the Absencehours field to query operations.
static TimeOverviewSelectable	ALL_FIELDS Selector for all available fields of TimeOverview.
static TimeOverviewField<BigDecimal>	ATTENDANCEHOURS Use with available fluent helpers to apply the Attendancehours field to query operations.
static TimeOverviewField<Calendar>	CALENDARDATE Use with available fluent helpers to apply the Calendardate field to query operations.
static TimeOverviewField<String>	COMPANYCODE Use with available fluent helpers to apply the Companycode field to query operations.
static TimeOverviewField<Boolean>	ISNONWORKINGDAY Use with available fluent helpers to apply the Isnonworkingday field to query operations.
static TimeOverviewField<BigDecimal>	OVERTIMEHOURS Use with available fluent helpers to apply the Overtimehours field to query operations.
static TimeOverviewField<String>	PERSONWORKAGREEMENT Use with available fluent helpers to apply the Personworkagreement field to query operations.
static TimeOverviewField<String>	PERSONWORKAGREEMENTEXTERNALID Use with available fluent helpers to apply the Personworkagreementexternalid field to query operations.
static TimeOverviewField<Calendar>	PLANNEDENDTIME Use with available fluent helpers to apply the Plannedendtime field to query operations.
static TimeOverviewField<Calendar>	PLANNEDSTARTTIME Use with available fluent helpers to apply the Plannedstarttime field to query operations.
static TimeOverviewField<BigDecimal>	PLANNEDWORKINGHOURS Use with available fluent helpers to apply the Plannedworkinghours field to query operations.
static TimeOverviewField<String>	PUBLICHOLIDAYCLASS Use with available fluent helpers to apply the Publicholidayclass field to query operations.

Constructor Summary

Constructors

Constructor and Description
TimeOverview()
TimeOverview(String personworkagreementexternalid, String companycode, String personworkagreement, Calendar calendardate, BigDecimal plannedworkinghours, Calendar plannedstarttime, Calendar plannedendtime, String publicholidayclass, Boolean isnonworkingday, BigDecimal absencehours, BigDecimal attendancehours, BigDecimal overtimehours, ErpConfigContext erpConfigContext)

Method Summary

Modifier and Type	Method and Description
static TimeOverview.TimeOverviewBuilder	builder()
boolean	equals(Object o)
static <T> TimeOverviewField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
BigDecimal	getAbsencehours() Constraints: Not nullable, Precision: 5, Scale: 2
BigDecimal	getAttendancehours() Constraints: Not nullable, Precision: 5, Scale: 2
Calendar	getCalendardate() (Key Field) Constraints: Not nullable, Precision: 7
String	getCompanycode() (Key Field) Constraints: Not nullable, Maximum length: 4
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
Boolean	getIsnonworkingday() Constraints: noneCalendar day is a weekend day,Calendar day is a public holiday,Calendar day is defined in the employee's shift plan as a non-working shift (day off).
BigDecimal	getOvertimehours() Constraints: Not nullable, Precision: 5, Scale: 2
String	getPersonworkagreement() Constraints: Not nullable, Maximum length: 8 When you work with infotype records, this field allows you to use the Fast entry feature.
String	getPersonworkagreementexternalid() (Key Field) Constraints: Not nullable, Maximum length: 20
Calendar	getPlannedendtime() Constraints: Not nullable, Precision: 0
Calendar	getPlannedstarttime() Constraints: Not nullable, Precision: 0
BigDecimal	getPlannedworkinghours() Constraints: Not nullable, Precision: 5, Scale: 2
String	getPublicholidayclass() Constraints: Not nullable, Maximum length: 1 Holiday classes are only used in Human Resources Management.
Class<TimeOverview>	getType()
int	hashCode()
void	setAbsencehours(BigDecimal absencehours) Constraints: Not nullable, Precision: 5, Scale: 2
void	setAttendancehours(BigDecimal attendancehours) Constraints: Not nullable, Precision: 5, Scale: 2
void	setCalendardate(Calendar calendardate) (Key Field) Constraints: Not nullable, Precision: 7
void	setCompanycode(String companycode) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
void	setIsnonworkingday(Boolean isnonworkingday) Constraints: noneCalendar day is a weekend day,Calendar day is a public holiday,Calendar day is defined in the employee's shift plan as a non-working shift (day off).
void	setOvertimehours(BigDecimal overtimehours) Constraints: Not nullable, Precision: 5, Scale: 2
void	setPersonworkagreement(String personworkagreement) Constraints: Not nullable, Maximum length: 8 When you work with infotype records, this field allows you to use the Fast entry feature.
void	setPersonworkagreementexternalid(String personworkagreementexternalid) (Key Field) Constraints: Not nullable, Maximum length: 20
void	setPlannedendtime(Calendar plannedendtime) Constraints: Not nullable, Precision: 0
void	setPlannedstarttime(Calendar plannedstarttime) Constraints: Not nullable, Precision: 0
void	setPlannedworkinghours(BigDecimal plannedworkinghours) Constraints: Not nullable, Precision: 5, Scale: 2
void	setPublicholidayclass(String publicholidayclass) Constraints: Not nullable, Maximum length: 1 Holiday classes are only used in Human Resources Management.
String	toString()

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject

getCustomField, getCustomField, getCustomFieldNames, getCustomFields, hasCustomField, hasCustomField, setCustomField, setCustomField

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final TimeOverviewSelectable ALL_FIELDS

Selector for all available fields of TimeOverview.

PERSONWORKAGREEMENTEXTERNALID

public static final TimeOverviewField<String> PERSONWORKAGREEMENTEXTERNALID

Use with available fluent helpers to apply the Personworkagreementexternalid field to query operations.

COMPANYCODE

public static final TimeOverviewField<String> COMPANYCODE

Use with available fluent helpers to apply the Companycode field to query operations.

PERSONWORKAGREEMENT

public static final TimeOverviewField<String> PERSONWORKAGREEMENT

Use with available fluent helpers to apply the Personworkagreement field to query operations.

CALENDARDATE

public static final TimeOverviewField<Calendar> CALENDARDATE

Use with available fluent helpers to apply the Calendardate field to query operations.

PLANNEDWORKINGHOURS

public static final TimeOverviewField<BigDecimal> PLANNEDWORKINGHOURS

Use with available fluent helpers to apply the Plannedworkinghours field to query operations.

PLANNEDSTARTTIME

public static final TimeOverviewField<Calendar> PLANNEDSTARTTIME

Use with available fluent helpers to apply the Plannedstarttime field to query operations.

PLANNEDENDTIME

public static final TimeOverviewField<Calendar> PLANNEDENDTIME

Use with available fluent helpers to apply the Plannedendtime field to query operations.

PUBLICHOLIDAYCLASS

public static final TimeOverviewField<String> PUBLICHOLIDAYCLASS

Use with available fluent helpers to apply the Publicholidayclass field to query operations.

ISNONWORKINGDAY

public static final TimeOverviewField<Boolean> ISNONWORKINGDAY

Use with available fluent helpers to apply the Isnonworkingday field to query operations.

ABSENCEHOURS

public static final TimeOverviewField<BigDecimal> ABSENCEHOURS

Use with available fluent helpers to apply the Absencehours field to query operations.

ATTENDANCEHOURS

public static final TimeOverviewField<BigDecimal> ATTENDANCEHOURS

Use with available fluent helpers to apply the Attendancehours field to query operations.

OVERTIMEHOURS

public static final TimeOverviewField<BigDecimal> OVERTIMEHOURS

Use with available fluent helpers to apply the Overtimehours field to query operations.

Constructor Detail

TimeOverview

public TimeOverview()

TimeOverview

public TimeOverview(@Nullable
                    String personworkagreementexternalid,
                    @Nullable
                    String companycode,
                    @Nullable
                    String personworkagreement,
                    @Nullable
                    Calendar calendardate,
                    @Nullable
                    BigDecimal plannedworkinghours,
                    @Nullable
                    Calendar plannedstarttime,
                    @Nullable
                    Calendar plannedendtime,
                    @Nullable
                    String publicholidayclass,
                    @Nullable
                    Boolean isnonworkingday,
                    @Nullable
                    BigDecimal absencehours,
                    @Nullable
                    BigDecimal attendancehours,
                    @Nullable
                    BigDecimal overtimehours,
                    @Nullable
                    ErpConfigContext erpConfigContext)

Method Detail

getType

public Class<TimeOverview> getType()

Specified by:

getType in class VdmObject<TimeOverview>

Returns:

The class of this object.

field

public static <T> TimeOverviewField<T> field(String fieldName,
                                             Class<T> fieldType)

Use with available fluent helpers to apply an extension field to query operations.

Parameters:

fieldName - The name of the extension field as returned by the OData service.

fieldType - The Java type to use for the extension field when performing value comparisons.

Returns:

A representation of an extension field from this entity.

builder

public static TimeOverview.TimeOverviewBuilder builder()

getPersonworkagreementexternalid

@Nullable
public String getPersonworkagreementexternalid()

(Key Field) Constraints: Not nullable, Maximum length: 20

Returns:

Work Agreement External ID

getCompanycode

@Nullable
public String getCompanycode()

(Key Field) Constraints: Not nullable, Maximum length: 4

Returns:

The company code is an organizational unit within financial accounting.

getPersonworkagreement

@Nullable
public String getPersonworkagreement()

Constraints: Not nullable, Maximum length: 8

When you work with infotype records, this field allows you to use the Fast entry feature. Fast entry enables you to create numerous infotype records without having to exit and re-enter the infotype window.To select the object that the infotype record should belong to, either:Enter the object's eight-digit codeUse the matchcode feature to search for the object

Returns:

Contains a unique eight-digit numerical code, that represents a specific object (for example, an organizational unit, qualification or business event).

getCalendardate

@Nullable
public Calendar getCalendardate()

(Key Field) Constraints: Not nullable, Precision: 7

Returns:

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

getPlannedworkinghours

@Nullable
public BigDecimal getPlannedworkinghours()

Constraints: Not nullable, Precision: 5, Scale: 2

Returns:

The entire number of an employee's working hours on a given calendar day. The number of actual hours worked can differ from the hours entered here, however.

getPlannedstarttime

@Nullable
public Calendar getPlannedstarttime()

Constraints: Not nullable, Precision: 0

Returns:

The starting time of an employee's regular working time on a given calendar day. The actual starting time can differ from the time entered here, however.

getPlannedendtime

@Nullable
public Calendar getPlannedendtime()

Constraints: Not nullable, Precision: 0

Returns:

The end time of an employee's regular working time on any given calendar day. The actual end of working time can differ from the time entered here, however.

getPublicholidayclass

@Nullable
public String getPublicholidayclass()

Constraints: Not nullable, Maximum length: 1

Holiday classes are only used in Human Resources Management. They can be used to determine the time wage type selection, the daily work schedule variants, the absence counting, etc. for groups of holidays and normal days.The entry of a holiday class is optional.You can enter a holiday class according to the rules defined in HR.

Returns:

The holiday class specifies the holiday type (optional).

getIsnonworkingday

@Nullable
public Boolean getIsnonworkingday()

Constraints: none

Calendar day is a weekend day,Calendar day is a public holiday,Calendar day is defined in the employee's shift plan as a non-working shift (day off).

Returns:

This indicator is activated if an employee does not have to work on a given calendar day, for one of the following reasons:

getAbsencehours

@Nullable
public BigDecimal getAbsencehours()

Constraints: Not nullable, Precision: 5, Scale: 2

Returns:

The total of all employee absence hours on a given calendar day. If an external application is entered, then only the absence hours that do not come from this external application are totalled.

getAttendancehours

@Nullable
public BigDecimal getAttendancehours()

Constraints: Not nullable, Precision: 5, Scale: 2

Returns:

The total of all employee attendance hours on a given calendar day. If an external application is entered, then only the attendance hours that do not come from this external application are totalled.

getOvertimehours

@Nullable
public BigDecimal getOvertimehours()

Constraints: Not nullable, Precision: 5, Scale: 2

Returns:

An employee's total hours on a given calendar day that have be entered as special overtime.

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Returns:

The stored ERP system context for executing queries, or null if no such context has been set.

setPersonworkagreementexternalid

public void setPersonworkagreementexternalid(@Nullable
                                             String personworkagreementexternalid)

(Key Field) Constraints: Not nullable, Maximum length: 20

Parameters:

personworkagreementexternalid -

setCompanycode

public void setCompanycode(@Nullable
                           String companycode)

(Key Field) Constraints: Not nullable, Maximum length: 4

Parameters:

companycode -

setPersonworkagreement

public void setPersonworkagreement(@Nullable
                                   String personworkagreement)

Constraints: Not nullable, Maximum length: 8

When you work with infotype records, this field allows you to use the Fast entry feature. Fast entry enables you to create numerous infotype records without having to exit and re-enter the infotype window.To select the object that the infotype record should belong to, either:Enter the object's eight-digit codeUse the matchcode feature to search for the object

Parameters:

personworkagreement -

setCalendardate

public void setCalendardate(@Nullable
                            Calendar calendardate)

(Key Field) Constraints: Not nullable, Precision: 7

Parameters:

calendardate -

setPlannedworkinghours

public void setPlannedworkinghours(@Nullable
                                   BigDecimal plannedworkinghours)

Constraints: Not nullable, Precision: 5, Scale: 2

Parameters:

plannedworkinghours -

setPlannedstarttime

public void setPlannedstarttime(@Nullable
                                Calendar plannedstarttime)

Constraints: Not nullable, Precision: 0

Parameters:

plannedstarttime -

setPlannedendtime

public void setPlannedendtime(@Nullable
                              Calendar plannedendtime)

Constraints: Not nullable, Precision: 0

Parameters:

plannedendtime -

setPublicholidayclass

public void setPublicholidayclass(@Nullable
                                  String publicholidayclass)

Constraints: Not nullable, Maximum length: 1

Holiday classes are only used in Human Resources Management. They can be used to determine the time wage type selection, the daily work schedule variants, the absence counting, etc. for groups of holidays and normal days.The entry of a holiday class is optional.You can enter a holiday class according to the rules defined in HR.

Parameters:

publicholidayclass -

setIsnonworkingday

public void setIsnonworkingday(@Nullable
                               Boolean isnonworkingday)

Constraints: none

Calendar day is a weekend day,Calendar day is a public holiday,Calendar day is defined in the employee's shift plan as a non-working shift (day off).

Parameters:

isnonworkingday -

setAbsencehours

public void setAbsencehours(@Nullable
                            BigDecimal absencehours)

Constraints: Not nullable, Precision: 5, Scale: 2

Parameters:

absencehours -

setAttendancehours

public void setAttendancehours(@Nullable
                               BigDecimal attendancehours)

Constraints: Not nullable, Precision: 5, Scale: 2

Parameters:

attendancehours -

setOvertimehours

public void setOvertimehours(@Nullable
                             BigDecimal overtimehours)

Constraints: Not nullable, Precision: 5, Scale: 2

Parameters:

overtimehours -

setErpConfigContext

public void setErpConfigContext(@Nullable
                                ErpConfigContext erpConfigContext)

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Parameters:

erpConfigContext -

toString

public String toString()

Overrides:

toString in class VdmObject<TimeOverview>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<TimeOverview>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<TimeOverview>