Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "TimeSheetEntryCollection" of service "API_MANAGE_WORKFORCE_TIMESHEET". This service is part of the following communication scenarios: Workforce Timesheet Integration (SAP_COM_0027). See https://api.sap.com/api/API_MANAGE_WORKFORCE_TIMESHEET for more information.

Hierarchy

  • Entity
    • TimeSheetEntry

Implements

Index

Constructors

constructor

  • Returns TimeSheetEntry

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 "*".

companyCode

companyCode: string

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

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.

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

timeSheetDataFields

timeSheetDataFields: TimeSheetDataFields

Time Sheet Data Fields.

Optional timeSheetDate

timeSheetDate: Moment

Date.

nullable

Optional timeSheetIsExecutedInTestRun

timeSheetIsExecutedInTestRun: undefined | false | true

Yes/No Switch with Values 'SPACE' and 'X'.

nullable

Optional timeSheetIsReleasedOnSave

timeSheetIsReleasedOnSave: undefined | false | true

Release Records on Saving. Determines that the system releases changed data records immediately when you save them. You do not have to release them manually.

nullable

Optional timeSheetOperation

timeSheetOperation: undefined | string

CATS Operations : 'C' , 'U' , 'D'. Maximum length: 1.

nullable

Optional timeSheetPredecessorRecord

timeSheetPredecessorRecord: undefined | string

Reference Counter for Record to be Changed. The reference counter is assigned to a record that was created when an existing record was changed. The new record is assigned a new counter and, as a reference counter, the ID of the original record. The reference counter provides a link between the new and original record. Maximum length: 12.

nullable

timeSheetRecord

timeSheetRecord: string

Counter for Records in Time Recording. The system assigns time sheet records a counter. The counter represents a record's unique database ID. If you change a record that has already been approved, the original record retains this ID; the changed record is assigned another unique ID. Maximum length: 12.

Optional timeSheetStatus

timeSheetStatus: undefined | string

Processing Status. Each time sheet record is assigned a status. This status indicates the processing status of the selected record. Status IndicatorIn process 10Released for approval 20Approved 30Approval rejected 40Changed after approval 50Cancelled 60. Maximum length: 2.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ALL_FIELDS

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

All fields selector.

Static COMPANY_CODE

COMPANY_CODE: StringField<TimeSheetEntry> = new StringField('CompanyCode', TimeSheetEntry, '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 PERSON_WORK_AGREEMENT

PERSON_WORK_AGREEMENT: StringField<TimeSheetEntry> = new StringField('PersonWorkAgreement', TimeSheetEntry, '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 PERSON_WORK_AGREEMENT_EXTERNAL_ID

PERSON_WORK_AGREEMENT_EXTERNAL_ID: StringField<TimeSheetEntry> = new StringField('PersonWorkAgreementExternalID', TimeSheetEntry, '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 TIME_SHEET_DATA_FIELDS

TIME_SHEET_DATA_FIELDS: TimeSheetDataFieldsField<TimeSheetEntry> = new TimeSheetDataFieldsField('TimeSheetDataFields', TimeSheetEntry, 'TimeSheetDataFields')

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

Static TIME_SHEET_DATE

TIME_SHEET_DATE: DateField<TimeSheetEntry> = new DateField('TimeSheetDate', TimeSheetEntry, 'Edm.DateTime')

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

Static TIME_SHEET_IS_EXECUTED_IN_TEST_RUN

TIME_SHEET_IS_EXECUTED_IN_TEST_RUN: BooleanField<TimeSheetEntry> = new BooleanField('TimeSheetIsExecutedInTestRun', TimeSheetEntry, 'Edm.Boolean')

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

Static TIME_SHEET_IS_RELEASED_ON_SAVE

TIME_SHEET_IS_RELEASED_ON_SAVE: BooleanField<TimeSheetEntry> = new BooleanField('TimeSheetIsReleasedOnSave', TimeSheetEntry, 'Edm.Boolean')

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

Static TIME_SHEET_OPERATION

TIME_SHEET_OPERATION: StringField<TimeSheetEntry> = new StringField('TimeSheetOperation', TimeSheetEntry, 'Edm.String')

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

Static TIME_SHEET_PREDECESSOR_RECORD

TIME_SHEET_PREDECESSOR_RECORD: StringField<TimeSheetEntry> = new StringField('TimeSheetPredecessorRecord', TimeSheetEntry, 'Edm.String')

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

Static TIME_SHEET_RECORD

TIME_SHEET_RECORD: StringField<TimeSheetEntry> = new StringField('TimeSheetRecord', TimeSheetEntry, 'Edm.String')

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

Static TIME_SHEET_STATUS

TIME_SHEET_STATUS: StringField<TimeSheetEntry> = new StringField('TimeSheetStatus', TimeSheetEntry, 'Edm.String')

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

Static _allFields

_allFields: Array<TimeSheetDataFieldsField<TimeSheetEntry> | StringField<TimeSheetEntry> | DateField<TimeSheetEntry> | BooleanField<TimeSheetEntry>> = [TimeSheetEntry.TIME_SHEET_DATA_FIELDS,TimeSheetEntry.PERSON_WORK_AGREEMENT_EXTERNAL_ID,TimeSheetEntry.COMPANY_CODE,TimeSheetEntry.TIME_SHEET_RECORD,TimeSheetEntry.PERSON_WORK_AGREEMENT,TimeSheetEntry.TIME_SHEET_DATE,TimeSheetEntry.TIME_SHEET_IS_RELEASED_ON_SAVE,TimeSheetEntry.TIME_SHEET_PREDECESSOR_RECORD,TimeSheetEntry.TIME_SHEET_STATUS,TimeSheetEntry.TIME_SHEET_IS_EXECUTED_IN_TEST_RUN,TimeSheetEntry.TIME_SHEET_OPERATION]

All fields of the TimeSheetEntry entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_MANAGE_WORKFORCE_TIMESHEET"

Default url path for the according service.

Static _entityName

_entityName: string = "TimeSheetEntryCollection"

Technical entity name for TimeSheetEntry.

Static _keyFields

_keyFields: Array<Selectable<TimeSheetEntry>> = [TimeSheetEntry.PERSON_WORK_AGREEMENT_EXTERNAL_ID, TimeSheetEntry.COMPANY_CODE, TimeSheetEntry.TIME_SHEET_RECORD]

All key fields of the TimeSheetEntry entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_MANAGE_WORKFORCE_TIMESHEET"
deprecated

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

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 TimeSheetEntry.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<TimeSheetEntry>

    A builder that constructs instances of entity type TimeSheetEntry.

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 TimeSheetEntry entity type.

    Returns TimeSheetEntryRequestBuilder

    A TimeSheetEntry request builder.