Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "TimeOverviewSet" of service "SHCM.API_MANAGE_WF_AVAILABILITY". This service is part of the following communication scenarios: Employee Integration (SAP_COM_0001), External HR Workforce Integration (SAP_COM_0301). See https://api.sap.com/api/API_MANAGE_WF_AVAILABILITY for more information.

Hierarchy

  • Entity
    • TimeOverviewSet

Implements

Index

Constructors

constructor

  • Returns TimeOverviewSet

Properties

Protected _customFields

_customFields: MapType<any>

A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.

Protected _versionIdentifier

_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

Optional absencehours

absencehours: BigNumber

Absence hours of an employee on one day. 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.

nullable

Optional attendancehours

attendancehours: BigNumber

Attendance hours of an employee on one day. 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.

nullable

calendardate

calendardate: Moment

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

companycode

companycode: string

Company Code. The company code is an organizational unit within financial accounting. Maximum length: 4.

Optional isnonworkingday

isnonworkingday: undefined | false | true

Indicator: Employee does not need to work. This indicator is activated if an employee does not have to work on a given calendar day, for one of the following reasons: 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).

nullable

Optional overtimehours

overtimehours: BigNumber

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

nullable

Optional personworkagreement

personworkagreement: undefined | string

Object ID. Contains a unique eight-digit numerical code, that represents a specific object (for example, an organizational unit, qualification or business event). 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. Maximum length: 8.

nullable

personworkagreementexternalid

personworkagreementexternalid: string

Work Agreement External ID. Maximum length: 20.

Optional plannedendtime

plannedendtime: Time

Normal End of an Employee's Working Time. 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.

nullable

Optional plannedstarttime

plannedstarttime: Time

Normal start of employee's working time. 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.

nullable

Optional plannedworkinghours

plannedworkinghours: BigNumber

Normal working hours of an employee on one day. 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.

nullable

Optional publicholidayclass

publicholidayclass: undefined | string

Holiday class. The holiday class specifies the holiday type (optional). 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. Maximum length: 1.

nullable

Protected remoteState

remoteState: object

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.

Type declaration

  • [keys: string]: any

Static ABSENCEHOURS

ABSENCEHOURS: BigNumberField<TimeOverviewSet> = new BigNumberField('Absencehours', TimeOverviewSet, 'Edm.Decimal')

Static representation of the absencehours property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static ALL_FIELDS

ALL_FIELDS: AllFields<TimeOverviewSet> = new AllFields('*', TimeOverviewSet)

All fields selector.

Static ATTENDANCEHOURS

ATTENDANCEHOURS: BigNumberField<TimeOverviewSet> = new BigNumberField('Attendancehours', TimeOverviewSet, 'Edm.Decimal')

Static representation of the attendancehours property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CALENDARDATE

CALENDARDATE: DateField<TimeOverviewSet> = new DateField('Calendardate', TimeOverviewSet, 'Edm.DateTime')

Static representation of the calendardate property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static COMPANYCODE

COMPANYCODE: StringField<TimeOverviewSet> = new StringField('Companycode', TimeOverviewSet, 'Edm.String')

Static representation of the companycode property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static ISNONWORKINGDAY

ISNONWORKINGDAY: BooleanField<TimeOverviewSet> = new BooleanField('Isnonworkingday', TimeOverviewSet, 'Edm.Boolean')

Static representation of the isnonworkingday property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static OVERTIMEHOURS

OVERTIMEHOURS: BigNumberField<TimeOverviewSet> = new BigNumberField('Overtimehours', TimeOverviewSet, 'Edm.Decimal')

Static representation of the overtimehours property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PERSONWORKAGREEMENT

PERSONWORKAGREEMENT: StringField<TimeOverviewSet> = new StringField('Personworkagreement', TimeOverviewSet, 'Edm.String')

Static representation of the personworkagreement property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PERSONWORKAGREEMENTEXTERNALID

PERSONWORKAGREEMENTEXTERNALID: StringField<TimeOverviewSet> = new StringField('Personworkagreementexternalid', TimeOverviewSet, 'Edm.String')

Static representation of the personworkagreementexternalid property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PLANNEDENDTIME

PLANNEDENDTIME: TimeField<TimeOverviewSet> = new TimeField('Plannedendtime', TimeOverviewSet, 'Edm.Time')

Static representation of the plannedendtime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PLANNEDSTARTTIME

PLANNEDSTARTTIME: TimeField<TimeOverviewSet> = new TimeField('Plannedstarttime', TimeOverviewSet, 'Edm.Time')

Static representation of the plannedstarttime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PLANNEDWORKINGHOURS

PLANNEDWORKINGHOURS: BigNumberField<TimeOverviewSet> = new BigNumberField('Plannedworkinghours', TimeOverviewSet, 'Edm.Decimal')

Static representation of the plannedworkinghours property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PUBLICHOLIDAYCLASS

PUBLICHOLIDAYCLASS: StringField<TimeOverviewSet> = new StringField('Publicholidayclass', TimeOverviewSet, 'Edm.String')

Static representation of the publicholidayclass property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static _allFields

_allFields: Array<StringField<TimeOverviewSet> | DateField<TimeOverviewSet> | BigNumberField<TimeOverviewSet> | TimeField<TimeOverviewSet> | BooleanField<TimeOverviewSet>> = [TimeOverviewSet.PERSONWORKAGREEMENTEXTERNALID,TimeOverviewSet.COMPANYCODE,TimeOverviewSet.PERSONWORKAGREEMENT,TimeOverviewSet.CALENDARDATE,TimeOverviewSet.PLANNEDWORKINGHOURS,TimeOverviewSet.PLANNEDSTARTTIME,TimeOverviewSet.PLANNEDENDTIME,TimeOverviewSet.PUBLICHOLIDAYCLASS,TimeOverviewSet.ISNONWORKINGDAY,TimeOverviewSet.ABSENCEHOURS,TimeOverviewSet.ATTENDANCEHOURS,TimeOverviewSet.OVERTIMEHOURS]

All fields of the TimeOverviewSet entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/shcm/API_MANAGE_WF_AVAILABILITY"

Default url path for the according service.

Static _entityName

_entityName: string = "TimeOverviewSet"

Technical entity name for TimeOverviewSet.

Static _keyFields

_keyFields: Array<Selectable<TimeOverviewSet>> = [TimeOverviewSet.PERSONWORKAGREEMENTEXTERNALID, TimeOverviewSet.COMPANYCODE, TimeOverviewSet.CALENDARDATE]

All key fields of the TimeOverviewSet entity.

Static _keys

_keys: object = TimeOverviewSet._keyFields.reduce((acc: { [keys: string]: Selectable<TimeOverviewSet> }, field: Selectable<TimeOverviewSet>) => {acc[field._fieldName] = field;return acc;}, {})

Mapping of all key field names to the respective static field property TimeOverviewSet.

Type declaration

Static _serviceName

_serviceName: string = "SHCM.API_MANAGE_WF_AVAILABILITY"
deprecated

Since v1.0.1 Use _defaultServicePath instead. Technical service name for TimeOverviewSet.

Accessors

versionIdentifier

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    Returns string

    The ETag version identifier of the retrieved entity, returns undefined if not retrieved

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): Entity
  • Returns a map of all defined fields in entity to their current values.

    Returns Entity

    Entity with all defined entity fields

getCustomField

  • getCustomField(fieldName: string): any
  • Custom field value getter.

    Parameters

    • fieldName: string

      The name of the custom field

    Returns any

    The value of the corresponding custom field

getCustomFields

  • getCustomFields(): MapType<any>
  • Returns a map that contains all entity custom fields.

    Returns MapType<any>

    A map of all defined custom fields in the entity

getUpdatedCustomFields

  • getUpdatedCustomFields(): MapType<any>
  • Returns all updated custom field properties compared to the last known remote state.

    Returns MapType<any>

    A map containing all updated custom properties, with their new values

getUpdatedProperties

  • getUpdatedProperties(): Entity
  • Returns all changed properties compared to the last known remote state. The returned properties does not include custom fields. Use getUpdatedCustomFields, if updated custom fields are needed.

    Returns Entity

    Entity with all properties that changed

hasCustomField

  • hasCustomField(fieldName: string): boolean
  • Validates whether a custom field exists in the entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity

initializeCustomFields

  • initializeCustomFields(customFields: MapType<any>): this
  • Sets all retrieved custom fields in entity.

    Parameters

    • customFields: MapType<any>

      Extracted custom fields from a retrieved entity

    Returns this

    A boolean value, that indicates the existence of the field in entity

Protected isConflictingCustomField

  • isConflictingCustomField(customFieldName: string): boolean
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    Parameters

    • customFieldName: string

      Field name to check

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field

setCustomField

  • setCustomField(fieldName: string, value: any): this
  • Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    • value: any

      The value of the field

    Returns this

    The entity itself, to facilitate method chaining

setOrInitializeRemoteState

  • setOrInitializeRemoteState(state?: MapType<any>): this
  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests. This function should be called after initializeCustomFields, if custom fields are defined.

    deprecated

    Since 1.12.0. Will be removed in version 2.0.

    Parameters

    • Optional state: MapType<any>

      State to be set as remote state

    Returns this

    The entity itself, to facilitate method chaining

setVersionIdentifier

  • setVersionIdentifier(etag: string | undefined): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string | undefined

      The returned ETag version of the entity

    Returns this

    The entity itself, to facilitate method chaining

toJSON

  • toJSON(): object
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns object

    An object containing all instance variables + custom fields.

    • [key: string]: any

Static builder

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity TimeOverviewSet.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<TimeOverviewSet>

    A builder that constructs instances of entity type TimeOverviewSet.

Static Protected customFieldSelector

  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
  • Type parameters

    • EntityT: Entity

    Parameters

    • fieldName: string
    • entityConstructor: Constructable<EntityT>

    Returns CustomField<EntityT>

Static Protected entityBuilder

  • entityBuilder<EntityT, EntityTypeForceMandatoryT>(entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>): EntityBuilderType<EntityT, EntityTypeForceMandatoryT>
  • Type parameters

    • EntityT: Entity

    • EntityTypeForceMandatoryT

    Parameters

    • entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>

    Returns EntityBuilderType<EntityT, EntityTypeForceMandatoryT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the TimeOverviewSet entity type.

    Returns TimeOverviewSetRequestBuilder

    A TimeOverviewSet request builder.