Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "AttachmentContentSet" of service "API_CV_ATTACHMENT_SRV". This service is part of the following communication scenarios: Distributed Manufacturing Integration (SAP_COM_0077), Product Lifecycle Management - Master Data Integration (SAP_COM_0105), Finance - Posting Integration (SAP_COM_0002), Supplier Invoice Integration (SAP_COM_0057). See https://api.sap.com/api/API_CV_ATTACHMENT_SRV for more information.

Hierarchy

  • Entity
    • AttachmentContentSet

Implements

Index

Constructors

constructor

  • Returns AttachmentContentSet

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

archiveDocumentId

archiveDocumentId: string

SAP ArchiveLink: Document ID. Unique document key (document ID) assigned to stored document by the content server. Maximum length: 40.

Optional archiveLinkRepository

archiveLinkRepository: string

Content Repository Identification. ID for connection to a content repository through which documents can be stored in a content server. Maximum length: 2.

nullable

Optional businessObjectType

businessObjectType: string

BusinessObjectType. Maximum length: 40.

nullable

businessObjectTypeName

businessObjectTypeName: string

BusinessObjectTypeName. Maximum length: 40.

Optional changedDateTime

changedDateTime: Moment

Creation Time (UTC). Specifies the time when the logical or physical document was created.

nullable

Optional content

content: string

AttachmentContent.

nullable

Optional createdByUser

createdByUser: string

Created By. Creator of document. Maximum length: 12.

nullable

Optional createdByUserFullName

createdByUserFullName: string

Description of the Technical User Account. Maximum length: 80.

nullable

Optional creationDateTime

creationDateTime: Moment

Creation Time (UTC). Specifies the time when the logical or physical document was created.

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

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

DocumentInfoRecordDocVersion. Maximum length: 2.

Optional documentUrl

documentUrl: string

SAP ArchiveLink: Data Element for Absolute URI. Maximum length: 4096.

nullable

Optional fileName

fileName: string

Relative storage location of physical document. Maximum length: 255.

nullable

Optional fileSize

fileSize: string

File size (in bytes). Maximum length: 12.

nullable

Optional lastChangedByUser

lastChangedByUser: string

LastChangedByUser. Maximum length: 12.

nullable

Optional lastChangedByUserFullName

lastChangedByUserFullName: string

Full Name of Person. This field contains the complete personal name. It is usually generated from the individual name components (without title). There are two exceptions:The field contents were assembled by converting data from a previous release from the previous title and name fields because the title could not be assigned automatically to a title key . In this case the field CONVERTED ("Status of the field NAME_TEXT") has the value 'X'.The field contents were maintained manually using a supplementary function in dialog, e.g. because the complete name cannot be split into the specified name parts. In this case the field CONVERTED ("Status of the field NAME_TEXT") has the value 'M'.The field CONVERTED ("Status of the field NAME_TEXT") has the value SPACE if neither of the exceptions applies. Maximum length: 80.

nullable

linkedSapObjectKey

linkedSapObjectKey: string

Document Management Object Key. Number which identifies the master record of an object that is allocated to a document. The number is generated by the system based on key fields of the object for example:change object key fieldsmaterial BOM materials, plant, usedocument document number,document typedocument part, versioncustomer debtor number. Maximum length: 90.

logicalDocument

logicalDocument: string

Logical document. Name of a logical document. Maximum length: 32.

Optional mimeType

mimeType: string

HTML content type. Maximum length: 128.

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 semanticObject

semanticObject: string

Character field of length 40. Maximum length: 40.

nullable

Optional storageCategory

storageCategory: string

Category for physical documents. Name of the content category. A repository on the physical level is assigned to the category on the logical level. Maximum length: 10.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Optional workstationApplication

workstationApplication: string

Application. Key for a workstation application. You can use the application to create, process, or store in a secure in a secure area (storage category) original files (for example, text files) directly from the document info record.Before you can process an original file with an application you must make the following entries in the document info record:Define the storage location (path) where the original application file is stored.If the data that you want to edit with the application is stored on another computer, you must also enter a data carrier in the document info record.In Customizing for the Document Management several settings influence processing of original files.See also: Settings for the workstation applicationThe user needs the authorization to start the application for the document type: (authorization object C_DRAW_DOK).You can enter the following applications in a document info record:Acrobat ReaderMS Power PointMS Word 6.0When you have set the default for the application to MS Word 6.0 in Customizing (Define document type) then this application is preset when creating an original file. Maximum length: 3.

nullable

Static ALL_FIELDS

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

All fields selector.

Static ARCHIVE_DOCUMENT_ID

ARCHIVE_DOCUMENT_ID: StringField<AttachmentContentSet> = new StringField('ArchiveDocumentID', AttachmentContentSet, 'Edm.String')

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

Static ARCHIVE_LINK_REPOSITORY

ARCHIVE_LINK_REPOSITORY: StringField<AttachmentContentSet> = new StringField('ArchiveLinkRepository', AttachmentContentSet, 'Edm.String')

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

Static BUSINESS_OBJECT_TYPE

BUSINESS_OBJECT_TYPE: StringField<AttachmentContentSet> = new StringField('BusinessObjectType', AttachmentContentSet, 'Edm.String')

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

Static BUSINESS_OBJECT_TYPE_NAME

BUSINESS_OBJECT_TYPE_NAME: StringField<AttachmentContentSet> = new StringField('BusinessObjectTypeName', AttachmentContentSet, 'Edm.String')

Static representation of the businessObjectTypeName 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<AttachmentContentSet> = new DateField('ChangedDateTime', AttachmentContentSet, 'Edm.DateTime')

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 CONTENT

CONTENT: BinaryField<AttachmentContentSet> = new BinaryField('Content', AttachmentContentSet, 'Edm.Binary')

Static representation of the content 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<AttachmentContentSet> = new StringField('CreatedByUser', AttachmentContentSet, '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 CREATED_BY_USER_FULL_NAME

CREATED_BY_USER_FULL_NAME: StringField<AttachmentContentSet> = new StringField('CreatedByUserFullName', AttachmentContentSet, 'Edm.String')

Static representation of the createdByUserFullName 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<AttachmentContentSet> = new DateField('CreationDateTime', AttachmentContentSet, 'Edm.DateTime')

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_DOC_NUMBER

DOCUMENT_INFO_RECORD_DOC_NUMBER: StringField<AttachmentContentSet> = new StringField('DocumentInfoRecordDocNumber', AttachmentContentSet, '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<AttachmentContentSet> = new StringField('DocumentInfoRecordDocPart', AttachmentContentSet, '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<AttachmentContentSet> = new StringField('DocumentInfoRecordDocType', AttachmentContentSet, '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<AttachmentContentSet> = new StringField('DocumentInfoRecordDocVersion', AttachmentContentSet, '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 DOCUMENT_URL

DOCUMENT_URL: StringField<AttachmentContentSet> = new StringField('DocumentURL', AttachmentContentSet, 'Edm.String')

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

Static FILE_NAME

FILE_NAME: StringField<AttachmentContentSet> = new StringField('FileName', AttachmentContentSet, 'Edm.String')

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

Static FILE_SIZE

FILE_SIZE: StringField<AttachmentContentSet> = new StringField('FileSize', AttachmentContentSet, 'Edm.String')

Static representation of the fileSize 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<AttachmentContentSet> = new StringField('LastChangedByUser', AttachmentContentSet, '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 LAST_CHANGED_BY_USER_FULL_NAME

LAST_CHANGED_BY_USER_FULL_NAME: StringField<AttachmentContentSet> = new StringField('LastChangedByUserFullName', AttachmentContentSet, 'Edm.String')

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

Static LINKED_SAP_OBJECT_KEY

LINKED_SAP_OBJECT_KEY: StringField<AttachmentContentSet> = new StringField('LinkedSAPObjectKey', AttachmentContentSet, 'Edm.String')

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

Static LOGICAL_DOCUMENT

LOGICAL_DOCUMENT: StringField<AttachmentContentSet> = new StringField('LogicalDocument', AttachmentContentSet, 'Edm.String')

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

Static MIME_TYPE

MIME_TYPE: StringField<AttachmentContentSet> = new StringField('MimeType', AttachmentContentSet, 'Edm.String')

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

Static SEMANTIC_OBJECT

SEMANTIC_OBJECT: StringField<AttachmentContentSet> = new StringField('SemanticObject', AttachmentContentSet, 'Edm.String')

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

Static STORAGE_CATEGORY

STORAGE_CATEGORY: StringField<AttachmentContentSet> = new StringField('StorageCategory', AttachmentContentSet, 'Edm.String')

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

Static WORKSTATION_APPLICATION

WORKSTATION_APPLICATION: StringField<AttachmentContentSet> = new StringField('WorkstationApplication', AttachmentContentSet, 'Edm.String')

Static representation of the workstationApplication 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<AttachmentContentSet> | BinaryField<AttachmentContentSet> | DateField<AttachmentContentSet>> = [AttachmentContentSet.DOCUMENT_INFO_RECORD_DOC_TYPE,AttachmentContentSet.DOCUMENT_INFO_RECORD_DOC_NUMBER,AttachmentContentSet.DOCUMENT_INFO_RECORD_DOC_VERSION,AttachmentContentSet.DOCUMENT_INFO_RECORD_DOC_PART,AttachmentContentSet.LOGICAL_DOCUMENT,AttachmentContentSet.ARCHIVE_DOCUMENT_ID,AttachmentContentSet.LINKED_SAP_OBJECT_KEY,AttachmentContentSet.BUSINESS_OBJECT_TYPE_NAME,AttachmentContentSet.SEMANTIC_OBJECT,AttachmentContentSet.WORKSTATION_APPLICATION,AttachmentContentSet.FILE_SIZE,AttachmentContentSet.FILE_NAME,AttachmentContentSet.DOCUMENT_URL,AttachmentContentSet.MIME_TYPE,AttachmentContentSet.CONTENT,AttachmentContentSet.CREATED_BY_USER,AttachmentContentSet.CREATED_BY_USER_FULL_NAME,AttachmentContentSet.CREATION_DATE_TIME,AttachmentContentSet.BUSINESS_OBJECT_TYPE,AttachmentContentSet.LAST_CHANGED_BY_USER,AttachmentContentSet.LAST_CHANGED_BY_USER_FULL_NAME,AttachmentContentSet.CHANGED_DATE_TIME,AttachmentContentSet.STORAGE_CATEGORY,AttachmentContentSet.ARCHIVE_LINK_REPOSITORY]

All fields of the AttachmentContentSet entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "AttachmentContentSet"

Technical entity name for AttachmentContentSet.

Static _keyFields

_keyFields: Array<Selectable<AttachmentContentSet>> = [AttachmentContentSet.DOCUMENT_INFO_RECORD_DOC_TYPE, AttachmentContentSet.DOCUMENT_INFO_RECORD_DOC_NUMBER, AttachmentContentSet.DOCUMENT_INFO_RECORD_DOC_VERSION, AttachmentContentSet.DOCUMENT_INFO_RECORD_DOC_PART, AttachmentContentSet.LOGICAL_DOCUMENT, AttachmentContentSet.ARCHIVE_DOCUMENT_ID, AttachmentContentSet.LINKED_SAP_OBJECT_KEY, AttachmentContentSet.BUSINESS_OBJECT_TYPE_NAME]

All key fields of the AttachmentContentSet entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_CV_ATTACHMENT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<AttachmentContentSet>

    A builder that constructs instances of entity type AttachmentContentSet.

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

    Returns AttachmentContentSetRequestBuilder

    A AttachmentContentSet request builder.