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.
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 "*".
Name. Maximum length: 255.
Document Status. Maximum length: 2.
LCM Document Source. Maximum length: 3.
Legal Transaction ID. Maximum length: 10.
Changed By User. Maximum length: 12.
Changed UTC Date Time.
Created By. Maximum length: 12.
Created On.
Access Level. Maximum length: 4.
Document Assembly Status. Displays the status of assembly of a legal document in the process of generating a virtual document from Legal Content Assembly Based on this status, you can filter documents to list all the assembled legal content. Maximum length: 20.
Document Content Type. Maximum length: 4.
Document Type. Document type defines the type of legal document. Legal document can be either a physical content or a virtual content. This element classifies the type of content in a legal document. Maximum length: 1.
Document ID. Maximum length: 10.
Data element for domain BOOLE: TRUE (='X') and FALSE (=' ').
UUID Char32.
Linked SAP Object. Database table of the master record that is linked to the document. In the standard system, many links are supported. You can display these using the input help.Additional links can be defined via specific screens and table entries without changing the program.See also: Maintain object link. Maximum length: 10.
Universal Unique Identifier.
Language Key. Maximum length: 2.
Template ID. Maximum length: 10.
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.
One-to-many navigation property to the LglDocStamp entity.
All fields selector.
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 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 representation of the legalDocumentSource property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the legalTransaction property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lglCntntMChangedByUser property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lglCntntMChangedUtcDateTime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lglCntntMCreatedByUser property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lglCntntMCreatedUtcDateTime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lglCntntMDocument property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lglCntntMDocumentIsTopVersion property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lglCntntMDocumentLinkedObject property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lglCntntMDocumentLinkedObjKey property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lglCntntMDocumentUuid property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lglCntntMDocAccessLvl property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lglCntntMDocAssemblyStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lglCntntMDocContentType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lglCntntMDocType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lglCntntMLanguage property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the lglCntntMTmplId property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
Static representation of the one-to-many navigation property toLglDocStamp for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.
All fields of the LegalDocument entity.
Default url path for the according service.
Technical entity name for LegalDocument.
All key fields of the LegalDocument entity.
Mapping of all key field names to the respective static field property LegalDocument.
ETag version identifier accessor.
The ETag version identifier of the retrieved entity, returns undefined if not retrieved
Returns a map of all defined fields in entity to their current values.
Entity with all defined entity fields
Custom field value getter.
The name of the custom field
The value of the corresponding custom field
Returns a map that contains all entity custom fields.
A map of all defined custom fields in the entity
Returns all updated custom field properties compared to the last known remote state.
A map containing all updated custom properties, with their new values
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.
Entity with all properties that changed
Validates whether a custom field exists in the entity.
The name of the custom field to update
A boolean value, that indicates whether a custom field is defined in entity
Sets all retrieved custom fields in entity.
Extracted custom fields from a retrieved entity
A boolean value, that indicates the existence of the field in entity
Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.
Field name to check
Boolean value that describes whether a field name can be defined as custom field
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.
The name of the custom field to update
The value of the field
The entity itself, to facilitate method chaining
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.
State to be set as remote state
The entity itself, to facilitate method chaining
Set the ETag version identifier of the retrieved entity.
The returned ETag version of the entity
The entity itself, to facilitate method chaining
Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.
An object containing all instance variables + custom fields.
Returns an entity builder to construct instances LegalDocument.
A builder that constructs instances of entity type LegalDocument.
Returns a selectable object that allows the selection of custom field in a get request for the entity LegalDocument.
Name of the custom field to select
A builder that constructs instances of entity type LegalDocument.
Returns a request builder to construct requests for operations on the LegalDocument entity type.
A LegalDocument request builder.
This class represents the entity "A_LegalDocument" of service "API_LEGAL_DOCUMENT_SRV". This service is part of the following communication scenarios: Legal Document Integration (SAP_COM_0178). See https://api.sap.com/api/API_LEGAL_DOCUMENT_SRV for more information.