public class DocumentInfoRecordDesc extends VdmEntity<DocumentInfoRecordDesc>
Original entity name from the Odata EDM: A_DocumentInfoRecordDescType
Modifier and Type | Class and Description |
---|---|
static class |
DocumentInfoRecordDesc.DocumentInfoRecordDescBuilder
Helper class to allow for fluent creation of DocumentInfoRecordDesc instances.
|
Modifier and Type | Field and Description |
---|---|
static DocumentInfoRecordDescSelectable |
ALL_FIELDS
Selector for all available fields of DocumentInfoRecordDesc.
|
static DocumentInfoRecordDescField<ZonedDateTime> |
CHANGED_DATE_TIME
Use with available fluent helpers to apply the ChangedDateTime field to query operations.
|
static DocumentInfoRecordDescField<String> |
DOC_INFO_RECD_SHORT_TEXT
Use with available fluent helpers to apply the DocInfoRecdShortText field to query operations.
|
static DocumentInfoRecordDescField<String> |
DOCUMENT_DESCRIPTION
Use with available fluent helpers to apply the DocumentDescription field to query operations.
|
static DocumentInfoRecordDescField<String> |
DOCUMENT_INFO_RECORD_DOC_NUMBER
Use with available fluent helpers to apply the DocumentInfoRecordDocNumber field to query operations.
|
static DocumentInfoRecordDescField<String> |
DOCUMENT_INFO_RECORD_DOC_PART
Use with available fluent helpers to apply the DocumentInfoRecordDocPart field to query operations.
|
static DocumentInfoRecordDescField<String> |
DOCUMENT_INFO_RECORD_DOC_TYPE
Use with available fluent helpers to apply the DocumentInfoRecordDocType field to query operations.
|
static DocumentInfoRecordDescField<String> |
DOCUMENT_INFO_RECORD_DOC_VERSION
Use with available fluent helpers to apply the DocumentInfoRecordDocVersion field to query operations.
|
static DocumentInfoRecordDescField<String> |
LANGUAGE
Use with available fluent helpers to apply the Language field to query operations.
|
static DocumentInfoRecordDescField<String> |
LONG_TEXT_EXISTS
Use with available fluent helpers to apply the LongTextExists field to query operations.
|
static DocumentInfoRecordDescOneToOneLink<DocumentInfoRecord> |
TO_DOC_INFO_RECORD
Use with available fluent helpers to apply the to_DocInfoRecord navigation property to query operations.
|
changedOriginalFields
Constructor and Description |
---|
DocumentInfoRecordDesc() |
DocumentInfoRecordDesc(String documentInfoRecordDocType,
String documentInfoRecordDocNumber,
String documentInfoRecordDocVersion,
String documentInfoRecordDocPart,
String language,
String documentDescription,
String longTextExists,
String docInfoRecdShortText,
ZonedDateTime changedDateTime,
DocumentInfoRecord toDocInfoRecord) |
Modifier and Type | Method and Description |
---|---|
void |
attachToService(String servicePath,
ErpConfigContext configContext)
Sets the service path and ERP configuration context for the fetch commands of this entity.
|
static DocumentInfoRecordDesc.DocumentInfoRecordDescBuilder |
builder() |
protected boolean |
canEqual(Object other) |
boolean |
equals(Object o) |
DocumentInfoRecord |
fetchDocInfoRecord()
Fetches the DocumentInfoRecord entity (one to one) associated with this entity.
|
static <T> DocumentInfoRecordDescField<T> |
field(String fieldName,
Class<T> fieldType)
Use with available fluent helpers to apply an extension field to query operations.
|
static <T,DomainT> |
field(String fieldName,
TypeConverter<T,DomainT> typeConverter)
Use with available fluent helpers to apply an extension field to query operations.
|
protected void |
fromMap(Map<String,Object> inputValues) |
ZonedDateTime |
getChangedDateTime()
Constraints: Not nullable, Precision: 0
|
protected String |
getDefaultServicePath() |
String |
getDocInfoRecdShortText()
Constraints: Not nullable, Maximum length: 40
|
Optional<DocumentInfoRecord> |
getDocInfoRecordIfPresent()
Retrieval of associated DocumentInfoRecord entity (one to one).
|
DocumentInfoRecord |
getDocInfoRecordOrFetch()
Retrieval of associated DocumentInfoRecord entity (one to one).
|
String |
getDocumentDescription()
Constraints: Not nullable, Maximum length: 40
|
String |
getDocumentInfoRecordDocNumber()
(Key Field) Constraints: Not nullable, Maximum length: 25
|
String |
getDocumentInfoRecordDocPart()
(Key Field) Constraints: Not nullable, Maximum length: 3
|
String |
getDocumentInfoRecordDocType()
(Key Field) Constraints: Not nullable, Maximum length: 3
|
String |
getDocumentInfoRecordDocVersion()
(Key Field) Constraints: Not nullable, Maximum length: 2
|
protected String |
getEntityCollection() |
ErpConfigContext |
getErpConfigContext()
Convienence field for reusing the same ERP system context with multiple queries (e.g.
|
protected Map<String,Object> |
getKey() |
String |
getLanguage()
(Key Field) Constraints: Not nullable, Maximum length: 2
|
String |
getLongTextExists()
Constraints: Not nullable, Maximum length: 1
|
Class<DocumentInfoRecordDesc> |
getType() |
int |
hashCode() |
void |
setChangedDateTime(ZonedDateTime changedDateTime)
Constraints: Not nullable, Precision: 0
|
void |
setDocInfoRecdShortText(String docInfoRecdShortText)
Constraints: Not nullable, Maximum length: 40
|
void |
setDocInfoRecord(DocumentInfoRecord value)
Overwrites the associated DocumentInfoRecord entity for the loaded navigation property
to_DocInfoRecord.
|
void |
setDocumentDescription(String documentDescription)
Constraints: Not nullable, Maximum length: 40
|
void |
setDocumentInfoRecordDocNumber(String documentInfoRecordDocNumber)
(Key Field) Constraints: Not nullable, Maximum length: 25
|
void |
setDocumentInfoRecordDocPart(String documentInfoRecordDocPart)
(Key Field) Constraints: Not nullable, Maximum length: 3
|
void |
setDocumentInfoRecordDocType(String documentInfoRecordDocType)
(Key Field) Constraints: Not nullable, Maximum length: 3
|
void |
setDocumentInfoRecordDocVersion(String documentInfoRecordDocVersion)
(Key Field) Constraints: Not nullable, Maximum length: 2
|
void |
setErpConfigContext(ErpConfigContext erpConfigContext)
Deprecated.
Use
attachToService(String, ErpConfigContext) instead. |
void |
setLanguage(String language)
(Key Field) Constraints: Not nullable, Maximum length: 2
|
void |
setLongTextExists(String longTextExists)
Constraints: Not nullable, Maximum length: 1
|
protected void |
setServicePathForFetch(String servicePathForFetch)
The service path only used for the fetch commands of this entity.
|
protected Map<String,Object> |
toMapOfFields() |
protected Map<String,Object> |
toMapOfNavigationProperties() |
String |
toString() |
getEndpointUrl, getServicePathForFetch, getVersionIdentifier, setVersionIdentifier
getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields
public static final DocumentInfoRecordDescSelectable ALL_FIELDS
public static final DocumentInfoRecordDescField<String> DOCUMENT_INFO_RECORD_DOC_TYPE
public static final DocumentInfoRecordDescField<String> DOCUMENT_INFO_RECORD_DOC_NUMBER
public static final DocumentInfoRecordDescField<String> DOCUMENT_INFO_RECORD_DOC_VERSION
public static final DocumentInfoRecordDescField<String> DOCUMENT_INFO_RECORD_DOC_PART
public static final DocumentInfoRecordDescField<String> LANGUAGE
public static final DocumentInfoRecordDescField<String> DOCUMENT_DESCRIPTION
public static final DocumentInfoRecordDescField<String> LONG_TEXT_EXISTS
public static final DocumentInfoRecordDescField<String> DOC_INFO_RECD_SHORT_TEXT
public static final DocumentInfoRecordDescField<ZonedDateTime> CHANGED_DATE_TIME
public static final DocumentInfoRecordDescOneToOneLink<DocumentInfoRecord> TO_DOC_INFO_RECORD
public DocumentInfoRecordDesc()
public DocumentInfoRecordDesc(@Nullable String documentInfoRecordDocType, @Nullable String documentInfoRecordDocNumber, @Nullable String documentInfoRecordDocVersion, @Nullable String documentInfoRecordDocPart, @Nullable String language, @Nullable String documentDescription, @Nullable String longTextExists, @Nullable String docInfoRecdShortText, @Nullable ZonedDateTime changedDateTime, @Nullable DocumentInfoRecord toDocInfoRecord)
@Nonnull public Class<DocumentInfoRecordDesc> getType()
getType
in class VdmObject<DocumentInfoRecordDesc>
public void setDocumentInfoRecordDocType(@Nullable String documentInfoRecordDocType)
Original property name from the Odata EDM: DocumentInfoRecordDocType
documentInfoRecordDocType
- Part of the document key, which categorizes documents according to their distinguishing features and
the organizational procedures which result from them.public void setDocumentInfoRecordDocNumber(@Nullable String documentInfoRecordDocNumber)
Original property name from the Odata EDM: DocumentInfoRecordDocNumber
documentInfoRecordDocNumber
- This number is the main part of the document key, which is used to identify the document.public void setDocumentInfoRecordDocVersion(@Nullable String documentInfoRecordDocVersion)
Original property name from the Odata EDM: DocumentInfoRecordDocVersion
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).
documentInfoRecordDocVersion
- Number which identifies the version of a document.public void setDocumentInfoRecordDocPart(@Nullable String documentInfoRecordDocPart)
Original property name from the Odata EDM: DocumentInfoRecordDocPart
Design departments, for example, can use document parts to divide up large documents such as design drawings into pages.
documentInfoRecordDocPart
- Section of a document which is maintained as an independent document.public void setLanguage(@Nullable String language)
Original property name from the Odata EDM: Language
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.
language
- Key for the language in which you want to maintain the text.public void setDocumentDescription(@Nullable String documentDescription)
Original property name from the Odata EDM: DocumentDescription
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.
documentDescription
- Short text describing the document.public void setLongTextExists(@Nullable String longTextExists)
Original property name from the Odata EDM: LongTextExists
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.
longTextExists
- Indicator: there is a long text describing the document in the language entered in field Language.public void setDocInfoRecdShortText(@Nullable String docInfoRecdShortText)
Original property name from the Odata EDM: DocInfoRecdShortText
docInfoRecdShortText
- DMS: Short Texts in Capital Letterspublic void setChangedDateTime(@Nullable ZonedDateTime changedDateTime)
Original property name from the Odata EDM: ChangedDateTime
changedDateTime
- Time last change was madeprotected String getEntityCollection()
getEntityCollection
in class VdmEntity<DocumentInfoRecordDesc>
@Nonnull protected Map<String,Object> getKey()
getKey
in class VdmObject<DocumentInfoRecordDesc>
@Nonnull protected Map<String,Object> toMapOfFields()
toMapOfFields
in class VdmObject<DocumentInfoRecordDesc>
protected void fromMap(Map<String,Object> inputValues)
fromMap
in class VdmObject<DocumentInfoRecordDesc>
@Nonnull public static <T> DocumentInfoRecordDescField<T> field(@Nonnull String fieldName, @Nonnull Class<T> fieldType)
T
- The type of the extension field when performing value comparisons.fieldName
- The name of the extension field as returned by the OData service.fieldType
- The Java type to use for the extension field when performing value comparisons.@Nonnull public static <T,DomainT> DocumentInfoRecordDescField<T> field(@Nonnull String fieldName, @Nonnull TypeConverter<T,DomainT> typeConverter)
T
- The type of the extension field when performing value comparisons.DomainT
- The type of the extension field as returned by the OData service.typeConverter
- A TypeConverterfieldName
- The name of the extension field as returned by the OData service.@Nullable public ErpConfigContext getErpConfigContext()
VdmEntity
getErpConfigContext
in class VdmEntity<DocumentInfoRecordDesc>
@Deprecated public void setErpConfigContext(@Nullable ErpConfigContext erpConfigContext)
attachToService(String, ErpConfigContext)
instead.VdmEntity
setErpConfigContext
in class VdmEntity<DocumentInfoRecordDesc>
erpConfigContext
- New ERP configuration context to apply to this entityprotected void setServicePathForFetch(@Nullable String servicePathForFetch)
VdmEntity
Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.
setServicePathForFetch
in class VdmEntity<DocumentInfoRecordDesc>
public void attachToService(@Nullable String servicePath, @Nullable ErpConfigContext configContext)
VdmEntity
Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.
attachToService
in class VdmEntity<DocumentInfoRecordDesc>
servicePath
- Optional parameter. New service path to apply to this entity and any associated entities that were
previously fetched. If a null value is provided and the service path has never been set, then the
service path will be set to the default defined in the corresponding service interface.configContext
- Optional parameter. New ERP configuration context to apply to this entity and any associated entities
that were previously fetched. If a null value is provided and the ERP configuration context has never
been set, then the ERP configuration context will be set to a new instance of
ErpConfigContext
.protected String getDefaultServicePath()
getDefaultServicePath
in class VdmEntity<DocumentInfoRecordDesc>
@Nonnull protected Map<String,Object> toMapOfNavigationProperties()
toMapOfNavigationProperties
in class VdmObject<DocumentInfoRecordDesc>
@Nullable public DocumentInfoRecord fetchDocInfoRecord() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
null
if an entity is not associated.com.sap.cloud.sdk.odatav2.connectivity.ODataException
- If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and
therefore has no ERP configuration context assigned. An entity is managed if it has been either
retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or
UPDATE call.@Nullable public DocumentInfoRecord getDocInfoRecordOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
If the navigation property to_DocInfoRecord of a queried DocumentInfoRecordDesc is operated lazily, an ODataException can be thrown in case of an OData query error.
Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
com.sap.cloud.sdk.odatav2.connectivity.ODataException
- If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and
therefore has no ERP configuration context assigned. An entity is managed if it has been either
retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or
UPDATE call.@Nonnull public Optional<DocumentInfoRecord> getDocInfoRecordIfPresent()
If the navigation property for an entity DocumentInfoRecordDesc has not been resolved yet, this method
will not query further information. Instead its Optional
result state will be
empty
.
Optional
with result state
empty
is returned.public void setDocInfoRecord(DocumentInfoRecord value)
value
- New DocumentInfoRecord entity.public static DocumentInfoRecordDesc.DocumentInfoRecordDescBuilder builder()
@Nullable public String getDocumentInfoRecordDocType()
Original property name from the Odata EDM: DocumentInfoRecordDocType
@Nullable public String getDocumentInfoRecordDocNumber()
Original property name from the Odata EDM: DocumentInfoRecordDocNumber
@Nullable public String getDocumentInfoRecordDocVersion()
Original property name from the Odata EDM: DocumentInfoRecordDocVersion
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).
@Nullable public String getDocumentInfoRecordDocPart()
Original property name from the Odata EDM: DocumentInfoRecordDocPart
Design departments, for example, can use document parts to divide up large documents such as design drawings into pages.
@Nullable public String getLanguage()
Original property name from the Odata EDM: Language
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.
@Nullable public String getDocumentDescription()
Original property name from the Odata EDM: DocumentDescription
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.
@Nullable public String getLongTextExists()
Original property name from the Odata EDM: LongTextExists
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.
@Nullable public String getDocInfoRecdShortText()
Original property name from the Odata EDM: DocInfoRecdShortText
@Nullable public ZonedDateTime getChangedDateTime()
Original property name from the Odata EDM: ChangedDateTime
public String toString()
toString
in class VdmObject<DocumentInfoRecordDesc>
public boolean equals(Object o)
equals
in class VdmObject<DocumentInfoRecordDesc>
protected boolean canEqual(Object other)
canEqual
in class VdmObject<DocumentInfoRecordDesc>
public int hashCode()
hashCode
in class VdmObject<DocumentInfoRecordDesc>
Copyright © 2019 SAP SE. All rights reserved.