Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_DocumentInfoRecord" 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
    • DocumentInfoRecord

Implements

Index

Constructors

constructor

  • Returns DocumentInfoRecord

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 authorizationGroup

authorizationGroup: undefined | string

Authorization Group. The authorization group enables you protect access to certain objects. In order to carry out a specific activity, the user must have authorization for the combination of the activity and the authorization group. Maximum length: 4.

nullable

Optional changeNumber

changeNumber: undefined | string

Change Number. Number of the change master record which groups together logically linked documents and any other SAP objects (such as bill of material, routing, material). The system determines the valid-from date from the header of the change master record.If you want to create a document:Once you save the document info record, you can no longer change the change number.If you want to process the document with another change number, you have to create a new version.The change master record must support processing of documents (Indicator: object type active for change number must be set in the change master). Maximum length: 12.

nullable

Optional changedDateTime

changedDateTime: Moment

Time last change was made.

nullable

Optional createdByUser

createdByUser: undefined | string

Document Creator's Name. Maximum length: 12.

nullable

Optional creationDateTime

creationDateTime: Moment

Time Document Was Created.

nullable

Optional docInfoRecdIsMarkedForDeletion

docInfoRecdIsMarkedForDeletion: undefined | false | true

Deletion Indicator. Indicator: the document will be deleted during the next reorganization run.

nullable

Optional documentInfoRecord

documentInfoRecord: undefined | string

Document Info Record key in concatenated form. Maximum length: 70.

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.

Optional internalDocumentStatus

internalDocumentStatus: undefined | string

Document Status. Key which represents the current document status. For each document type, you can define a status network in which one or more previous statuses are defined for a status. You can display the current possible entries (language-dependent) in any processing situation.When you set a new status, the system checks whether the current status is one of the possible previous statuses.When you set a status, the system checks your authorization. Maximum length: 2.

nullable

Optional isDocInfoRecdCreatedFromCad

isDocInfoRecdCreatedFromCad: undefined | false | true

CAD Indicator. This indicator shows that the object (such as BOM or document) was created or changed in a CAD system. Data transfer in the SAP system via CAD interface. This indicator is only for information.However you can use it as search criteria for a document search. You can restrict the document search as follows:Entry DescriptionX find documents with a CAD indicatorfind documents without a CAD indicator* find documents with or without a CAD indicatorThis indicator is set using the CAD interface.

nullable

Optional isDocInfoRecdStructure

isDocInfoRecdStructure: undefined | string

Is Doc Info Recd Structure. Maximum length: 1.

nullable

Optional laboratoryOrDesignOffice

laboratoryOrDesignOffice: undefined | string

Laboratory/design office. Key for the design office, laboratory, or laboratory worker responsible. You define the keys in Customizing (for the Material Master). Maximum length: 3.

nullable

Optional lastChangedByUser

lastChangedByUser: undefined | string

Last Changed By. Maximum length: 12.

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

Optional responsiblePersonName

responsiblePersonName: undefined | string

Name of Person Responsible. Name of the user who is responsible for the document info record. When you Create or Change a document info record:When you create a document info record, the system sets your user name as a default. You can overwrite this name using any user name defined in the SAP System. If you do not know the exact user name, you can select a user generically.To do this, enter the characters you know. Replace the sections you do not know with the special character "*".Example:Enter: WIEHit list: WIDDELWIDERSKIIf you do not know any characters, enter the special character "*" at the beginning of the field. Please note that this will put a heavy load on the system.If the department of the responsible user is maintained in user maintenance (Address), this is displayed after the name. Maximum length: 12.

nullable

toBomObj

One-to-many navigation property to the DocInfoRecdObjLinkBom entity.

toCharacteristics

toCharacteristics: DocumentInfoRecordCharc[]

One-to-many navigation property to the DocumentInfoRecordCharc entity.

toChgRecdObj

One-to-many navigation property to the DocInfoRecdObjLinkChgRecd entity.

toClassification

toClassification: DocumentInfoRecordClass[]

One-to-many navigation property to the DocumentInfoRecordClass entity.

toDocDesc

One-to-many navigation property to the DocumentInfoRecordDesc entity.

toDocStatusVh

One-to-many navigation property to the DocumentInfoRecordDocStsVh entity.

toProductObj

One-to-many navigation property to the DocInfoRecdObjLinkProduct 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<DocumentInfoRecord> = new AllFields('*', DocumentInfoRecord)

All fields selector.

Static AUTHORIZATION_GROUP

AUTHORIZATION_GROUP: StringField<DocumentInfoRecord> = new StringField('AuthorizationGroup', DocumentInfoRecord, 'Edm.String')

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

Static CHANGED_DATE_TIME

CHANGED_DATE_TIME: DateField<DocumentInfoRecord> = new DateField('ChangedDateTime', DocumentInfoRecord, '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 CHANGE_NUMBER

CHANGE_NUMBER: StringField<DocumentInfoRecord> = new StringField('ChangeNumber', DocumentInfoRecord, 'Edm.String')

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

Static CREATED_BY_USER

CREATED_BY_USER: StringField<DocumentInfoRecord> = new StringField('CreatedByUser', DocumentInfoRecord, 'Edm.String')

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

Static CREATION_DATE_TIME

CREATION_DATE_TIME: DateField<DocumentInfoRecord> = new DateField('CreationDateTime', DocumentInfoRecord, 'Edm.DateTimeOffset')

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

Static DOCUMENT_INFO_RECORD

DOCUMENT_INFO_RECORD: StringField<DocumentInfoRecord> = new StringField('DocumentInfoRecord', DocumentInfoRecord, 'Edm.String')

Static representation of the documentInfoRecord 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<DocumentInfoRecord> = new StringField('DocumentInfoRecordDocNumber', DocumentInfoRecord, '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<DocumentInfoRecord> = new StringField('DocumentInfoRecordDocPart', DocumentInfoRecord, '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<DocumentInfoRecord> = new StringField('DocumentInfoRecordDocType', DocumentInfoRecord, '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<DocumentInfoRecord> = new StringField('DocumentInfoRecordDocVersion', DocumentInfoRecord, '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_IS_MARKED_FOR_DELETION

DOC_INFO_RECD_IS_MARKED_FOR_DELETION: BooleanField<DocumentInfoRecord> = new BooleanField('DocInfoRecdIsMarkedForDeletion', DocumentInfoRecord, 'Edm.Boolean')

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

Static INTERNAL_DOCUMENT_STATUS

INTERNAL_DOCUMENT_STATUS: StringField<DocumentInfoRecord> = new StringField('InternalDocumentStatus', DocumentInfoRecord, 'Edm.String')

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

Static IS_DOC_INFO_RECD_CREATED_FROM_CAD

IS_DOC_INFO_RECD_CREATED_FROM_CAD: BooleanField<DocumentInfoRecord> = new BooleanField('IsDocInfoRecdCreatedFromCAD', DocumentInfoRecord, 'Edm.Boolean')

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

Static IS_DOC_INFO_RECD_STRUCTURE

IS_DOC_INFO_RECD_STRUCTURE: StringField<DocumentInfoRecord> = new StringField('IsDocInfoRecdStructure', DocumentInfoRecord, 'Edm.String')

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

Static LABORATORY_OR_DESIGN_OFFICE

LABORATORY_OR_DESIGN_OFFICE: StringField<DocumentInfoRecord> = new StringField('LaboratoryOrDesignOffice', DocumentInfoRecord, 'Edm.String')

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

Static LAST_CHANGED_BY_USER

LAST_CHANGED_BY_USER: StringField<DocumentInfoRecord> = new StringField('LastChangedByUser', DocumentInfoRecord, 'Edm.String')

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

Static RESPONSIBLE_PERSON_NAME

RESPONSIBLE_PERSON_NAME: StringField<DocumentInfoRecord> = new StringField('ResponsiblePersonName', DocumentInfoRecord, 'Edm.String')

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

Static TO_BOM_OBJ

TO_BOM_OBJ: Link<DocumentInfoRecord, DocInfoRecdObjLinkBom> = new Link('to_BomObj', DocumentInfoRecord, DocInfoRecdObjLinkBom)

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

Static TO_CHARACTERISTICS

TO_CHARACTERISTICS: Link<DocumentInfoRecord, DocumentInfoRecordCharc> = new Link('to_Characteristics', DocumentInfoRecord, DocumentInfoRecordCharc)

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

Static TO_CHG_RECD_OBJ

TO_CHG_RECD_OBJ: Link<DocumentInfoRecord, DocInfoRecdObjLinkChgRecd> = new Link('to_ChgRecdObj', DocumentInfoRecord, DocInfoRecdObjLinkChgRecd)

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

Static TO_CLASSIFICATION

TO_CLASSIFICATION: Link<DocumentInfoRecord, DocumentInfoRecordClass> = new Link('to_Classification', DocumentInfoRecord, DocumentInfoRecordClass)

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

Static TO_DOC_DESC

TO_DOC_DESC: Link<DocumentInfoRecord, DocumentInfoRecordDesc> = new Link('to_DocDesc', DocumentInfoRecord, DocumentInfoRecordDesc)

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

Static TO_DOC_STATUS_VH

TO_DOC_STATUS_VH: Link<DocumentInfoRecord, DocumentInfoRecordDocStsVh> = new Link('to_DocStatusVH', DocumentInfoRecord, DocumentInfoRecordDocStsVh)

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

Static TO_PRODUCT_OBJ

TO_PRODUCT_OBJ: Link<DocumentInfoRecord, DocInfoRecdObjLinkProduct> = new Link('to_ProductObj', DocumentInfoRecord, DocInfoRecdObjLinkProduct)

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

Static _allFields

_allFields: Array<StringField<DocumentInfoRecord> | BooleanField<DocumentInfoRecord> | DateField<DocumentInfoRecord> | Link<DocumentInfoRecord, DocInfoRecdObjLinkBom> | Link<DocumentInfoRecord, DocumentInfoRecordCharc> | Link<DocumentInfoRecord, DocInfoRecdObjLinkChgRecd> | Link<DocumentInfoRecord, DocumentInfoRecordClass> | Link<DocumentInfoRecord, DocumentInfoRecordDesc> | Link<DocumentInfoRecord, DocumentInfoRecordDocStsVh> | Link<DocumentInfoRecord, DocInfoRecdObjLinkProduct>> = [DocumentInfoRecord.DOCUMENT_INFO_RECORD_DOC_TYPE,DocumentInfoRecord.DOCUMENT_INFO_RECORD_DOC_VERSION,DocumentInfoRecord.DOCUMENT_INFO_RECORD_DOC_NUMBER,DocumentInfoRecord.DOCUMENT_INFO_RECORD_DOC_PART,DocumentInfoRecord.DOCUMENT_INFO_RECORD,DocumentInfoRecord.INTERNAL_DOCUMENT_STATUS,DocumentInfoRecord.LABORATORY_OR_DESIGN_OFFICE,DocumentInfoRecord.AUTHORIZATION_GROUP,DocumentInfoRecord.CHANGE_NUMBER,DocumentInfoRecord.DOC_INFO_RECD_IS_MARKED_FOR_DELETION,DocumentInfoRecord.IS_DOC_INFO_RECD_CREATED_FROM_CAD,DocumentInfoRecord.IS_DOC_INFO_RECD_STRUCTURE,DocumentInfoRecord.RESPONSIBLE_PERSON_NAME,DocumentInfoRecord.CREATION_DATE_TIME,DocumentInfoRecord.CREATED_BY_USER,DocumentInfoRecord.CHANGED_DATE_TIME,DocumentInfoRecord.LAST_CHANGED_BY_USER,DocumentInfoRecord.TO_BOM_OBJ,DocumentInfoRecord.TO_CHARACTERISTICS,DocumentInfoRecord.TO_CHG_RECD_OBJ,DocumentInfoRecord.TO_CLASSIFICATION,DocumentInfoRecord.TO_DOC_DESC,DocumentInfoRecord.TO_DOC_STATUS_VH,DocumentInfoRecord.TO_PRODUCT_OBJ]

All fields of the DocumentInfoRecord 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_DocumentInfoRecord"

Technical entity name for DocumentInfoRecord.

Static _keyFields

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

All key fields of the DocumentInfoRecord entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_DMS_PROCESS_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<DocumentInfoRecord>

    A builder that constructs instances of entity type DocumentInfoRecord.

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

    Returns DocumentInfoRecordRequestBuilder

    A DocumentInfoRecord request builder.