TimeOverview (SAP S/4HANA Cloud SDK - Parent POM 1.11.0 API)

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
Original entity name from the Odata EDM: TimeOverview

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TimeOverview.TimeOverviewBuilder

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

All Methods Static Methods Instance Methods Concrete Methods
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 Original property name from the Odata EDM: Absencehours
`BigDecimal`	`getAttendancehours()` Constraints: Not nullable, Precision: 5, Scale: 2 Original property name from the Odata EDM: Attendancehours
`Calendar`	`getCalendardate()` (Key Field) Constraints: Not nullable, Precision: 7 Original property name from the Odata EDM: Calendardate
`String`	`getCompanycode()` (Key Field) Constraints: Not nullable, Maximum length: 4 Original property name from the Odata EDM: Companycode
`ErpConfigContext`	`getErpConfigContext()` Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
`Boolean`	`getIsnonworkingday()` Constraints: noneOriginal property name from the Odata EDM: IsnonworkingdayCalendar 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 Original property name from the Odata EDM: Overtimehours
`String`	`getPersonworkagreement()` Constraints: Not nullable, Maximum length: 8 Original property name from the Odata EDM: PersonworkagreementWhen 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 Original property name from the Odata EDM: Personworkagreementexternalid
`Calendar`	`getPlannedendtime()` Constraints: Not nullable, Precision: 0 Original property name from the Odata EDM: Plannedendtime
`Calendar`	`getPlannedstarttime()` Constraints: Not nullable, Precision: 0 Original property name from the Odata EDM: Plannedstarttime
`BigDecimal`	`getPlannedworkinghours()` Constraints: Not nullable, Precision: 5, Scale: 2 Original property name from the Odata EDM: Plannedworkinghours
`String`	`getPublicholidayclass()` Constraints: Not nullable, Maximum length: 1 Original property name from the Odata EDM: PublicholidayclassHoliday classes are only used in Human Resources Management.
`Class<TimeOverview>`	`getType()`
`int`	`hashCode()`
`void`	`setAbsencehours(BigDecimal absencehours)` Constraints: Not nullable, Precision: 5, Scale: 2 Original property name from the Odata EDM: Absencehours
`void`	`setAttendancehours(BigDecimal attendancehours)` Constraints: Not nullable, Precision: 5, Scale: 2 Original property name from the Odata EDM: Attendancehours
`void`	`setCalendardate(Calendar calendardate)` (Key Field) Constraints: Not nullable, Precision: 7 Original property name from the Odata EDM: Calendardate
`void`	`setCompanycode(String companycode)` (Key Field) Constraints: Not nullable, Maximum length: 4 Original property name from the Odata EDM: Companycode
`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: noneOriginal property name from the Odata EDM: IsnonworkingdayCalendar 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 Original property name from the Odata EDM: Overtimehours
`void`	`setPersonworkagreement(String personworkagreement)` Constraints: Not nullable, Maximum length: 8 Original property name from the Odata EDM: PersonworkagreementWhen 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 Original property name from the Odata EDM: Personworkagreementexternalid
`void`	`setPlannedendtime(Calendar plannedendtime)` Constraints: Not nullable, Precision: 0 Original property name from the Odata EDM: Plannedendtime
`void`	`setPlannedstarttime(Calendar plannedstarttime)` Constraints: Not nullable, Precision: 0 Original property name from the Odata EDM: Plannedstarttime
`void`	`setPlannedworkinghours(BigDecimal plannedworkinghours)` Constraints: Not nullable, Precision: 5, Scale: 2 Original property name from the Odata EDM: Plannedworkinghours
`void`	`setPublicholidayclass(String publicholidayclass)` Constraints: Not nullable, Maximum length: 1 Original property name from the Odata EDM: PublicholidayclassHoliday classes are only used in Human Resources Management.
`String`	`toString()`

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmEntity
getVersionIdentifier, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject
getChangedFields, 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.
  - setPersonworkagreementexternalid
```
public void setPersonworkagreementexternalid(@Nullable
                                             String personworkagreementexternalid)
```
    (Key Field) Constraints: Not nullable, Maximum length: 20
    Original property name from the Odata EDM: Personworkagreementexternalid
    
    Parameters:
    
    personworkagreementexternalid - Work Agreement External ID
  - setCompanycode
```
public void setCompanycode(@Nullable
                           String companycode)
```
    (Key Field) Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: Companycode
    
    Parameters:
    
    companycode - The company code is an organizational unit within financial accounting.
  - setPersonworkagreement
```
public void setPersonworkagreement(@Nullable
                                   String personworkagreement)
```
    Constraints: Not nullable, Maximum length: 8
    Original property name from the Odata EDM: Personworkagreement
    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 - Contains a unique eight-digit numerical code, that represents a specific object (for example, an organizational unit, qualification or business event).
  - setCalendardate
```
public void setCalendardate(@Nullable
                            Calendar calendardate)
```
    (Key Field) Constraints: Not nullable, Precision: 7
    Original property name from the Odata EDM: Calendardate
    
    Parameters:
    
    calendardate - This field contains the date on which the corresponding data record is valid.
  - setPlannedworkinghours
```
public void setPlannedworkinghours(@Nullable
                                   BigDecimal plannedworkinghours)
```
    Constraints: Not nullable, Precision: 5, Scale: 2
    Original property name from the Odata EDM: Plannedworkinghours
    
    Parameters:
    
    plannedworkinghours - 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.
  - setPlannedstarttime
```
public void setPlannedstarttime(@Nullable
                                Calendar plannedstarttime)
```
    Constraints: Not nullable, Precision: 0
    Original property name from the Odata EDM: Plannedstarttime
    
    Parameters:
    
    plannedstarttime - 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.
  - setPlannedendtime
```
public void setPlannedendtime(@Nullable
                              Calendar plannedendtime)
```
    Constraints: Not nullable, Precision: 0
    Original property name from the Odata EDM: Plannedendtime
    
    Parameters:
    
    plannedendtime - 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.
  - setPublicholidayclass
```
public void setPublicholidayclass(@Nullable
                                  String publicholidayclass)
```
    Constraints: Not nullable, Maximum length: 1
    Original property name from the Odata EDM: Publicholidayclass
    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 - The holiday class specifies the holiday type (optional).
  - setIsnonworkingday
```
public void setIsnonworkingday(@Nullable
                               Boolean isnonworkingday)
```
    Constraints: none
    Original property name from the Odata EDM: Isnonworkingday
    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 - This indicator is activated if an employee does not have to work on a given calendar day, for one of the following reasons:
  - setAbsencehours
```
public void setAbsencehours(@Nullable
                            BigDecimal absencehours)
```
    Constraints: Not nullable, Precision: 5, Scale: 2
    Original property name from the Odata EDM: Absencehours
    
    Parameters:
    
    absencehours - 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.
  - setAttendancehours
```
public void setAttendancehours(@Nullable
                               BigDecimal attendancehours)
```
    Constraints: Not nullable, Precision: 5, Scale: 2
    Original property name from the Odata EDM: Attendancehours
    
    Parameters:
    
    attendancehours - 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.
  - setOvertimehours
```
public void setOvertimehours(@Nullable
                             BigDecimal overtimehours)
```
    Constraints: Not nullable, Precision: 5, Scale: 2
    Original property name from the Odata EDM: Overtimehours
    
    Parameters:
    
    overtimehours - An employee's total hours on a given calendar day that have be entered as special overtime.
  - 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
    Original property name from the Odata EDM: Personworkagreementexternalid
    
    Returns:
    
    Work Agreement External ID
  - getCompanycode
```
@Nullable
public String getCompanycode()
```
    (Key Field) Constraints: Not nullable, Maximum length: 4
    Original property name from the Odata EDM: Companycode
    
    Returns:
    
    The company code is an organizational unit within financial accounting.
  - getPersonworkagreement
```
@Nullable
public String getPersonworkagreement()
```
    Constraints: Not nullable, Maximum length: 8
    Original property name from the Odata EDM: Personworkagreement
    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
    Original property name from the Odata EDM: Calendardate
    
    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
    Original property name from the Odata EDM: Plannedworkinghours
    
    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
    Original property name from the Odata EDM: Plannedstarttime
    
    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
    Original property name from the Odata EDM: Plannedendtime
    
    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
    Original property name from the Odata EDM: Publicholidayclass
    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
    Original property name from the Odata EDM: Isnonworkingday
    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
    Original property name from the Odata EDM: Absencehours
    
    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
    Original property name from the Odata EDM: Attendancehours
    
    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
    Original property name from the Odata EDM: Overtimehours
    
    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.
  - 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>

Class TimeOverview

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

ALL_FIELDS

PERSONWORKAGREEMENTEXTERNALID

COMPANYCODE

PERSONWORKAGREEMENT

CALENDARDATE

PLANNEDWORKINGHOURS

PLANNEDSTARTTIME

PLANNEDENDTIME

PUBLICHOLIDAYCLASS

ISNONWORKINGDAY

ABSENCEHOURS

ATTENDANCEHOURS

OVERTIMEHOURS

Constructor Detail

TimeOverview

TimeOverview

Method Detail

getType

setPersonworkagreementexternalid

setCompanycode

setPersonworkagreement

setCalendardate

setPlannedworkinghours

setPlannedstarttime

setPlannedendtime

setPublicholidayclass

setIsnonworkingday

setAbsencehours

setAttendancehours

setOvertimehours

field

builder

getPersonworkagreementexternalid

getCompanycode

getPersonworkagreement

getCalendardate

getPlannedworkinghours

getPlannedstarttime

getPlannedendtime

getPublicholidayclass

getIsnonworkingday

getAbsencehours

getAttendancehours

getOvertimehours

getErpConfigContext

setErpConfigContext

toString

equals

hashCode