com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.documentmanagement

Class DocumentInfoRecordDesc

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>

com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<DocumentInfoRecordDesc>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.documentmanagement.DocumentInfoRecordDesc

public class DocumentInfoRecordDesc
extends VdmEntity<DocumentInfoRecordDesc>

API for Document Info Record Description

Original entity name from the Odata EDM: A_DocumentInfoRecordDescType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentInfoRecordDesc.DocumentInfoRecordDescBuilder Helper class to allow for fluent creation of DocumentInfoRecordDesc instances.

Field Summary

Fields

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.

Fields inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject

changedOriginalFields

Constructor Summary

Constructors

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)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination 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> DocumentInfoRecordDescField<T>	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()
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
String	getDocInfoRecdShortText() Constraints: Not nullable, Maximum length: 40
io.vavr.control.Option<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()
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	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()

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity

getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject

getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final DocumentInfoRecordDescSelectable ALL_FIELDS

Selector for all available fields of DocumentInfoRecordDesc.

DOCUMENT_INFO_RECORD_DOC_TYPE

public static final DocumentInfoRecordDescField<String> DOCUMENT_INFO_RECORD_DOC_TYPE

Use with available fluent helpers to apply the DocumentInfoRecordDocType field to query operations.

DOCUMENT_INFO_RECORD_DOC_NUMBER

public static final DocumentInfoRecordDescField<String> DOCUMENT_INFO_RECORD_DOC_NUMBER

Use with available fluent helpers to apply the DocumentInfoRecordDocNumber field to query operations.

DOCUMENT_INFO_RECORD_DOC_VERSION

public static final DocumentInfoRecordDescField<String> DOCUMENT_INFO_RECORD_DOC_VERSION

Use with available fluent helpers to apply the DocumentInfoRecordDocVersion field to query operations.

DOCUMENT_INFO_RECORD_DOC_PART

public static final DocumentInfoRecordDescField<String> DOCUMENT_INFO_RECORD_DOC_PART

Use with available fluent helpers to apply the DocumentInfoRecordDocPart field to query operations.

LANGUAGE

public static final DocumentInfoRecordDescField<String> LANGUAGE

Use with available fluent helpers to apply the Language field to query operations.

DOCUMENT_DESCRIPTION

public static final DocumentInfoRecordDescField<String> DOCUMENT_DESCRIPTION

Use with available fluent helpers to apply the DocumentDescription field to query operations.

LONG_TEXT_EXISTS

public static final DocumentInfoRecordDescField<String> LONG_TEXT_EXISTS

Use with available fluent helpers to apply the LongTextExists field to query operations.

DOC_INFO_RECD_SHORT_TEXT

public static final DocumentInfoRecordDescField<String> DOC_INFO_RECD_SHORT_TEXT

Use with available fluent helpers to apply the DocInfoRecdShortText field to query operations.

CHANGED_DATE_TIME

public static final DocumentInfoRecordDescField<ZonedDateTime> CHANGED_DATE_TIME

Use with available fluent helpers to apply the ChangedDateTime field to query operations.

TO_DOC_INFO_RECORD

public static final DocumentInfoRecordDescOneToOneLink<DocumentInfoRecord> TO_DOC_INFO_RECORD

Use with available fluent helpers to apply the to_DocInfoRecord navigation property to query operations.

Constructor Detail

DocumentInfoRecordDesc

public DocumentInfoRecordDesc()

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)

Method Detail

getType

@Nonnull
public Class<DocumentInfoRecordDesc> getType()

Specified by:

getType in class VdmObject<DocumentInfoRecordDesc>

Returns:

The class of this object.

setDocumentInfoRecordDocType

public void setDocumentInfoRecordDocType(@Nullable
                                         String documentInfoRecordDocType)

(Key Field) Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: DocumentInfoRecordDocType

Parameters:

documentInfoRecordDocType - Part of the document key, which categorizes documents according to their distinguishing features and the organizational procedures which result from them.

setDocumentInfoRecordDocNumber

public void setDocumentInfoRecordDocNumber(@Nullable
                                           String documentInfoRecordDocNumber)

(Key Field) Constraints: Not nullable, Maximum length: 25

Original property name from the Odata EDM: DocumentInfoRecordDocNumber

Parameters:

documentInfoRecordDocNumber - This number is the main part of the document key, which is used to identify the document.

setDocumentInfoRecordDocVersion

public void setDocumentInfoRecordDocVersion(@Nullable
                                            String documentInfoRecordDocVersion)

(Key Field) Constraints: Not nullable, Maximum length: 2

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

Parameters:

documentInfoRecordDocVersion - Number which identifies the version of a document.

setDocumentInfoRecordDocPart

public void setDocumentInfoRecordDocPart(@Nullable
                                         String documentInfoRecordDocPart)

(Key Field) Constraints: Not nullable, Maximum length: 3

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.

Parameters:

documentInfoRecordDocPart - Section of a document which is maintained as an independent document.

setLanguage

public void setLanguage(@Nullable
                        String language)

(Key Field) Constraints: Not nullable, Maximum length: 2

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.

Parameters:

language - Key for the language in which you want to maintain the text.

setDocumentDescription

public void setDocumentDescription(@Nullable
                                   String documentDescription)

Constraints: Not nullable, Maximum length: 40

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.

Parameters:

documentDescription - Short text describing the document.

setLongTextExists

public void setLongTextExists(@Nullable
                              String longTextExists)

Constraints: Not nullable, Maximum length: 1

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.

Parameters:

longTextExists - Indicator: there is a long text describing the document in the language entered in field Language.

setDocInfoRecdShortText

public void setDocInfoRecdShortText(@Nullable
                                    String docInfoRecdShortText)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: DocInfoRecdShortText

Parameters:

docInfoRecdShortText - DMS: Short Texts in Capital Letters

setChangedDateTime

public void setChangedDateTime(@Nullable
                               ZonedDateTime changedDateTime)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: ChangedDateTime

Parameters:

changedDateTime - Time last change was made

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<DocumentInfoRecordDesc>

getKey

@Nonnull
protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<DocumentInfoRecordDesc>

Returns:

The compound key of this object.

toMapOfFields

@Nonnull
protected Map<String,Object> toMapOfFields()

Overrides:

toMapOfFields in class VdmObject<DocumentInfoRecordDesc>

fromMap

protected void fromMap(Map<String,Object> inputValues)

Overrides:

fromMap in class VdmObject<DocumentInfoRecordDesc>

field

@Nonnull
public static <T> DocumentInfoRecordDescField<T> field(@Nonnull
                                                                String fieldName,
                                                                @Nonnull
                                                                Class<T> fieldType)

Use with available fluent helpers to apply an extension field to query operations.

Type Parameters:

T - The type of the extension field when performing value comparisons.

Parameters:

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.

Returns:

A representation of an extension field from this entity.

field

@Nonnull
public static <T,DomainT> DocumentInfoRecordDescField<T> field(@Nonnull
                                                                        String fieldName,
                                                                        @Nonnull
                                                                        TypeConverter<T,DomainT> typeConverter)

Use with available fluent helpers to apply an extension field to query operations.

Type Parameters:

T - The type of the extension field when performing value comparisons.

DomainT - The type of the extension field as returned by the OData service.

Parameters:

typeConverter - A TypeConverter instance whose first generic type matches the Java type of the field

fieldName - The name of the extension field as returned by the OData service.

Returns:

A representation of an extension field from this entity, holding a reference to the given TypeConverter.

getDestinationForFetch

@Nullable
public HttpDestinationProperties getDestinationForFetch()

Description copied from class: VdmEntity

Convienence field for reusing the same destination with multiple queries (e.g. fetching associated entities). New destination to apply to this entity

Overrides:

getDestinationForFetch in class VdmEntity<DocumentInfoRecordDesc>

Returns:

The stored destination for executing queries, or null if no such context has been set.

setServicePathForFetch

protected void setServicePathForFetch(@Nullable
                                      String servicePathForFetch)

Description copied from class: VdmEntity

The service path only used for the fetch commands of this entity.

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.

Overrides:

setServicePathForFetch in class VdmEntity<DocumentInfoRecordDesc>

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nonnull
                            HttpDestinationProperties destination)

Description copied from class: VdmEntity

Sets the service path and destination for the fetch commands of this entity. Also applies to any associated entities (navigation properties) that were previously fetched.

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.

Overrides:

attachToService in class VdmEntity<DocumentInfoRecordDesc>

Parameters:

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.

destination - New destination to apply to this entity and any associated entities that were previously fetched.

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<DocumentInfoRecordDesc>

toMapOfNavigationProperties

@Nonnull
protected Map<String,Object> toMapOfNavigationProperties()

Overrides:

toMapOfNavigationProperties in class VdmObject<DocumentInfoRecordDesc>

fetchDocInfoRecord

@Nullable
public DocumentInfoRecord fetchDocInfoRecord()
                                                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the DocumentInfoRecord entity (one to one) associated with this entity. This corresponds to the OData navigation property to_DocInfoRecord.

Please note: This method will not cache or persist the query results.

Returns:

The single associated DocumentInfoRecord entity, or null if an entity is not associated.

Throws:

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.

getDocInfoRecordOrFetch

@Nullable
public DocumentInfoRecord getDocInfoRecordOrFetch()
                                                     throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated DocumentInfoRecord entity (one to one). This corresponds to the OData navigation property to_DocInfoRecord.

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.

Returns:

List of associated DocumentInfoRecord entity.

Throws:

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.

getDocInfoRecordIfPresent

@Nonnull
public io.vavr.control.Option<DocumentInfoRecord> getDocInfoRecordIfPresent()

Retrieval of associated DocumentInfoRecord entity (one to one). This corresponds to the OData navigation property to_DocInfoRecord.

If the navigation property for an entity DocumentInfoRecordDesc has not been resolved yet, this method will not query further information. Instead its Option result state will be empty.

Returns:

If the information for navigation property to_DocInfoRecord is already loaded, the result will contain the DocumentInfoRecord entity. If not, an Option with result state empty is returned.

setDocInfoRecord

public void setDocInfoRecord(DocumentInfoRecord value)

Overwrites the associated DocumentInfoRecord entity for the loaded navigation property to_DocInfoRecord.

Parameters:

value - New DocumentInfoRecord entity.

builder

public static DocumentInfoRecordDesc.DocumentInfoRecordDescBuilder builder()

getDocumentInfoRecordDocType

@Nullable
public String getDocumentInfoRecordDocType()

(Key Field) Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: DocumentInfoRecordDocType

Returns:

Part of the document key, which categorizes documents according to their distinguishing features and the organizational procedures which result from them.

getDocumentInfoRecordDocNumber

@Nullable
public String getDocumentInfoRecordDocNumber()

(Key Field) Constraints: Not nullable, Maximum length: 25

Original property name from the Odata EDM: DocumentInfoRecordDocNumber

Returns:

This number is the main part of the document key, which is used to identify the document.

getDocumentInfoRecordDocVersion

@Nullable
public String getDocumentInfoRecordDocVersion()

(Key Field) Constraints: Not nullable, Maximum length: 2

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

Returns:

Number which identifies the version of a document.

getDocumentInfoRecordDocPart

@Nullable
public String getDocumentInfoRecordDocPart()

(Key Field) Constraints: Not nullable, Maximum length: 3

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.

Returns:

Section of a document which is maintained as an independent document.

getLanguage

@Nullable
public String getLanguage()

(Key Field) Constraints: Not nullable, Maximum length: 2

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.

Returns:

Key for the language in which you want to maintain the text.

getDocumentDescription

@Nullable
public String getDocumentDescription()

Constraints: Not nullable, Maximum length: 40

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.

Returns:

Short text describing the document.

getLongTextExists

@Nullable
public String getLongTextExists()

Constraints: Not nullable, Maximum length: 1

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.

Returns:

Indicator: there is a long text describing the document in the language entered in field Language.

getDocInfoRecdShortText

@Nullable
public String getDocInfoRecdShortText()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: DocInfoRecdShortText

Returns:

DMS: Short Texts in Capital Letters

getChangedDateTime

@Nullable
public ZonedDateTime getChangedDateTime()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: ChangedDateTime

Returns:

Time last change was made

toString

public String toString()

Overrides:

toString in class VdmObject<DocumentInfoRecordDesc>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<DocumentInfoRecordDesc>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<DocumentInfoRecordDesc>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<DocumentInfoRecordDesc>