Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_DocumentInfoRecordDesc" of service "API_DMS_PROCESS_SRV". This service is part of the following communication scenarios: Product Lifecycle Management - Master Data Integration (SAP_COM_0105). See https://api.sap.com/api/API_DMS_PROCESS_SRV for more information.

Hierarchy

  • Entity
    • DocumentInfoRecordDesc

Implements

Index

Constructors

constructor

  • Returns DocumentInfoRecordDesc

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 changedDateTime

changedDateTime: Moment

Time last change was made.

nullable

Optional docInfoRecdShortText

docInfoRecdShortText: string

DMS: Short Texts in Capital Letters. Maximum length: 40.

nullable

Optional documentDescription

documentDescription: string

Document Description. Short text describing the document. If you enter a long text describing the document (Edit -> Long text), the first 40 characters of the two texts are kept consistent.If this field is defined as a required field for a document type, this only applies to the logon language. If you change the language while creating the document, the field becomes an optional field. Maximum length: 40.

nullable

documentInfoRecordDocNumber

documentInfoRecordDocNumber: string

Document number. This number is the main part of the document key, which is used to identify the document. Maximum length: 25.

documentInfoRecordDocPart

documentInfoRecordDocPart: string

Document Part. Section of a document which is maintained as an independent document. Design departments, for example, can use document parts to divide up large documents such as design drawings into pages. Maximum length: 3.

documentInfoRecordDocType

documentInfoRecordDocType: string

Document Type. Part of the document key, which categorizes documents according to their distinguishing features and the organizational procedures which result from them. Maximum length: 3.

documentInfoRecordDocVersion

documentInfoRecordDocVersion: string

Document Version. Number which identifies the version of a document. A new version is assigned after the original files have been edited in the following processing situations:The new processing status varies from the original in a certain way (for example, text change sin a text file).You want the original processing status to remain the same (for example, documentation of project progress). Maximum length: 2.

language

language: string

Language. Key for the language in which you want to maintain the text. During processing, you can switch to all languages allowed in the SAP System. You can even make an entry in this field when displaying a document.The default is always the language key of the logon language.If the field Description has been defined as a required field via Customizing (Document management), this only applies to your logon language. If you change to another language, the field Description becomes an optional field. Maximum length: 2.

Optional longTextExists

longTextExists: string

Long Text Exists. Indicator: there is a long text describing the document in the language entered in field Language. If you change the processing language, the system checks whether a long text exists in the language you chose. If not, the system removes the indicator. 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

toDocInfoRecord

toDocInfoRecord: DocumentInfoRecord

One-to-one navigation property to the DocumentInfoRecord entity.

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<DocumentInfoRecordDesc> = new AllFields('*', DocumentInfoRecordDesc)

All fields selector.

Static CHANGED_DATE_TIME

CHANGED_DATE_TIME: DateField<DocumentInfoRecordDesc> = new DateField('ChangedDateTime', DocumentInfoRecordDesc, 'Edm.DateTimeOffset')

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

Static DOCUMENT_DESCRIPTION

DOCUMENT_DESCRIPTION: StringField<DocumentInfoRecordDesc> = new StringField('DocumentDescription', DocumentInfoRecordDesc, 'Edm.String')

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

Static DOCUMENT_INFO_RECORD_DOC_NUMBER

DOCUMENT_INFO_RECORD_DOC_NUMBER: StringField<DocumentInfoRecordDesc> = new StringField('DocumentInfoRecordDocNumber', DocumentInfoRecordDesc, 'Edm.String')

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

Static DOCUMENT_INFO_RECORD_DOC_PART

DOCUMENT_INFO_RECORD_DOC_PART: StringField<DocumentInfoRecordDesc> = new StringField('DocumentInfoRecordDocPart', DocumentInfoRecordDesc, 'Edm.String')

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

Static DOCUMENT_INFO_RECORD_DOC_TYPE

DOCUMENT_INFO_RECORD_DOC_TYPE: StringField<DocumentInfoRecordDesc> = new StringField('DocumentInfoRecordDocType', DocumentInfoRecordDesc, 'Edm.String')

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

Static DOCUMENT_INFO_RECORD_DOC_VERSION

DOCUMENT_INFO_RECORD_DOC_VERSION: StringField<DocumentInfoRecordDesc> = new StringField('DocumentInfoRecordDocVersion', DocumentInfoRecordDesc, 'Edm.String')

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

Static DOC_INFO_RECD_SHORT_TEXT

DOC_INFO_RECD_SHORT_TEXT: StringField<DocumentInfoRecordDesc> = new StringField('DocInfoRecdShortText', DocumentInfoRecordDesc, 'Edm.String')

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

Static LANGUAGE

LANGUAGE: StringField<DocumentInfoRecordDesc> = new StringField('Language', DocumentInfoRecordDesc, 'Edm.String')

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

Static LONG_TEXT_EXISTS

LONG_TEXT_EXISTS: StringField<DocumentInfoRecordDesc> = new StringField('LongTextExists', DocumentInfoRecordDesc, 'Edm.String')

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

Static TO_DOC_INFO_RECORD

TO_DOC_INFO_RECORD: OneToOneLink<DocumentInfoRecordDesc, DocumentInfoRecord> = new OneToOneLink('to_DocInfoRecord', DocumentInfoRecordDesc, DocumentInfoRecord)

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

Static _allFields

_allFields: Array<StringField<DocumentInfoRecordDesc> | DateField<DocumentInfoRecordDesc> | OneToOneLink<DocumentInfoRecordDesc, DocumentInfoRecord>> = [DocumentInfoRecordDesc.DOCUMENT_INFO_RECORD_DOC_TYPE,DocumentInfoRecordDesc.DOCUMENT_INFO_RECORD_DOC_NUMBER,DocumentInfoRecordDesc.DOCUMENT_INFO_RECORD_DOC_VERSION,DocumentInfoRecordDesc.DOCUMENT_INFO_RECORD_DOC_PART,DocumentInfoRecordDesc.LANGUAGE,DocumentInfoRecordDesc.DOCUMENT_DESCRIPTION,DocumentInfoRecordDesc.LONG_TEXT_EXISTS,DocumentInfoRecordDesc.DOC_INFO_RECD_SHORT_TEXT,DocumentInfoRecordDesc.CHANGED_DATE_TIME,DocumentInfoRecordDesc.TO_DOC_INFO_RECORD]

All fields of the DocumentInfoRecordDesc entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_DocumentInfoRecordDesc"

Technical entity name for DocumentInfoRecordDesc.

Static _keyFields

_keyFields: Array<Selectable<DocumentInfoRecordDesc>> = [DocumentInfoRecordDesc.DOCUMENT_INFO_RECORD_DOC_TYPE, DocumentInfoRecordDesc.DOCUMENT_INFO_RECORD_DOC_NUMBER, DocumentInfoRecordDesc.DOCUMENT_INFO_RECORD_DOC_VERSION, DocumentInfoRecordDesc.DOCUMENT_INFO_RECORD_DOC_PART, DocumentInfoRecordDesc.LANGUAGE]

All key fields of the DocumentInfoRecordDesc entity.

Static _keys

_keys: any = DocumentInfoRecordDesc._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

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

Static _serviceName

_serviceName: string = "API_DMS_PROCESS_SRV"
deprecated

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

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.

    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): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<DocumentInfoRecordDesc>

    A builder that constructs instances of entity type DocumentInfoRecordDesc.

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, JsonT>(entityConstructor: Constructable<EntityT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns DocumentInfoRecordDescRequestBuilder

    A DocumentInfoRecordDesc request builder.