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

Class DocInfoRecdObjLinkChgRecd

java.lang.Object

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

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

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

public class DocInfoRecdObjLinkChgRecd
extends VdmEntity<DocInfoRecdObjLinkChgRecd>

Doc Info Recd Obj Link CR TP

Original entity name from the Odata EDM: A_DocInfoRecdObjLinkChgRecdType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static DocInfoRecdObjLinkChgRecdSelectable	ALL_FIELDS Selector for all available fields of DocInfoRecdObjLinkChgRecd.
static DocInfoRecdObjLinkChgRecdField<String>	DOC_OBJECT_LINK_COUNTER Use with available fluent helpers to apply the DocObjectLinkCounter field to query operations.
static DocInfoRecdObjLinkChgRecdField<String>	DOCUMENT_INFO_RECORD_DOC_NUMBER Use with available fluent helpers to apply the DocumentInfoRecordDocNumber field to query operations.
static DocInfoRecdObjLinkChgRecdField<String>	DOCUMENT_INFO_RECORD_DOC_PART Use with available fluent helpers to apply the DocumentInfoRecordDocPart field to query operations.
static DocInfoRecdObjLinkChgRecdField<String>	DOCUMENT_INFO_RECORD_DOC_TYPE Use with available fluent helpers to apply the DocumentInfoRecordDocType field to query operations.
static DocInfoRecdObjLinkChgRecdField<String>	DOCUMENT_INFO_RECORD_DOC_VERSION Use with available fluent helpers to apply the DocumentInfoRecordDocVersion field to query operations.
static DocInfoRecdObjLinkChgRecdField<String>	LINKED_SAP_OBJECT Use with available fluent helpers to apply the LinkedSAPObject field to query operations.
static DocInfoRecdObjLinkChgRecdField<String>	LINKED_SAP_OBJECT_KEY Use with available fluent helpers to apply the LinkedSAPObjectKey field to query operations.
static DocInfoRecdObjLinkChgRecdOneToOneLink<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
DocInfoRecdObjLinkChgRecd()
DocInfoRecdObjLinkChgRecd(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String linkedSAPObject, String linkedSAPObjectKey, String docObjectLinkCounter, 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 DocInfoRecdObjLinkChgRecd.DocInfoRecdObjLinkChgRecdBuilder	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> DocInfoRecdObjLinkChgRecdField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> DocInfoRecdObjLinkChgRecdField<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)
protected String	getDefaultServicePath() Used by fluent helpers and navigation property methods to construct OData queries.
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
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	getDocObjectLinkCounter() (Key Field) Constraints: Not nullable, Maximum length: 4
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() Used by fluent helpers and navigation property methods to construct OData queries.
protected Map<String,Object>	getKey()
String	getLinkedSAPObject() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getLinkedSAPObjectKey() (Key Field) Constraints: Not nullable, Maximum length: 90
Class<DocInfoRecdObjLinkChgRecd>	getType()
int	hashCode()
void	setDocInfoRecord(DocumentInfoRecord value) Overwrites the associated DocumentInfoRecord entity for the loaded navigation property to_DocInfoRecord.
void	setDocObjectLinkCounter(String docObjectLinkCounter) (Key Field) Constraints: Not nullable, Maximum length: 4
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	setLinkedSAPObject(String linkedSAPObject) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setLinkedSAPObjectKey(String linkedSAPObjectKey) (Key Field) Constraints: Not nullable, Maximum length: 90
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 DocInfoRecdObjLinkChgRecdSelectable ALL_FIELDS

Selector for all available fields of DocInfoRecdObjLinkChgRecd.

DOCUMENT_INFO_RECORD_DOC_TYPE

public static final DocInfoRecdObjLinkChgRecdField<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 DocInfoRecdObjLinkChgRecdField<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 DocInfoRecdObjLinkChgRecdField<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 DocInfoRecdObjLinkChgRecdField<String> DOCUMENT_INFO_RECORD_DOC_PART

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

LINKED_SAP_OBJECT

public static final DocInfoRecdObjLinkChgRecdField<String> LINKED_SAP_OBJECT

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

LINKED_SAP_OBJECT_KEY

public static final DocInfoRecdObjLinkChgRecdField<String> LINKED_SAP_OBJECT_KEY

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

DOC_OBJECT_LINK_COUNTER

public static final DocInfoRecdObjLinkChgRecdField<String> DOC_OBJECT_LINK_COUNTER

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

TO_DOC_INFO_RECORD

public static final DocInfoRecdObjLinkChgRecdOneToOneLink<DocumentInfoRecord> TO_DOC_INFO_RECORD

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

Constructor Detail

DocInfoRecdObjLinkChgRecd

public DocInfoRecdObjLinkChgRecd()

DocInfoRecdObjLinkChgRecd

public DocInfoRecdObjLinkChgRecd(@Nullable
                                 String documentInfoRecordDocType,
                                 @Nullable
                                 String documentInfoRecordDocNumber,
                                 @Nullable
                                 String documentInfoRecordDocVersion,
                                 @Nullable
                                 String documentInfoRecordDocPart,
                                 @Nullable
                                 String linkedSAPObject,
                                 @Nullable
                                 String linkedSAPObjectKey,
                                 @Nullable
                                 String docObjectLinkCounter,
                                 @Nullable
                                 DocumentInfoRecord toDocInfoRecord)

Method Detail

getType

@Nonnull
public Class<DocInfoRecdObjLinkChgRecd> getType()

Specified by:

getType in class VdmObject<DocInfoRecdObjLinkChgRecd>

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.

setLinkedSAPObject

public void setLinkedSAPObject(@Nullable
                               String linkedSAPObject)

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

Original property name from the Odata EDM: LinkedSAPObject

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

Parameters:

linkedSAPObject - Database table of the master record that is linked to the document.

setLinkedSAPObjectKey

public void setLinkedSAPObjectKey(@Nullable
                                  String linkedSAPObjectKey)

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

Original property name from the Odata EDM: LinkedSAPObjectKey

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

Parameters:

linkedSAPObjectKey - Number which identifies the master record of an object that is allocated to a document.

setDocObjectLinkCounter

public void setDocObjectLinkCounter(@Nullable
                                    String docObjectLinkCounter)

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

Original property name from the Odata EDM: DocObjectLinkCounter

Parameters:

docObjectLinkCounter - Counter key

getEntityCollection

protected String getEntityCollection()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Specified by:

getEntityCollection in class VdmEntity<DocInfoRecdObjLinkChgRecd>

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<DocInfoRecdObjLinkChgRecd>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<DocInfoRecdObjLinkChgRecd>

fromMap

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

Overrides:

fromMap in class VdmObject<DocInfoRecdObjLinkChgRecd>

field

@Nonnull
public static <T> DocInfoRecdObjLinkChgRecdField<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> DocInfoRecdObjLinkChgRecdField<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<DocInfoRecdObjLinkChgRecd>

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<DocInfoRecdObjLinkChgRecd>

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<DocInfoRecdObjLinkChgRecd>

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

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Overrides:

getDefaultServicePath in class VdmEntity<DocInfoRecdObjLinkChgRecd>

Returns:

Default context path to the OData service. In other words, everything in between the protocol://hostname:port and the OData resource name (entity set, $metadata, etc.)

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<DocInfoRecdObjLinkChgRecd>

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 DocInfoRecdObjLinkChgRecd 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 DocInfoRecdObjLinkChgRecd 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 DocInfoRecdObjLinkChgRecd.DocInfoRecdObjLinkChgRecdBuilder 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.

getLinkedSAPObject

@Nullable
public String getLinkedSAPObject()

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

Original property name from the Odata EDM: LinkedSAPObject

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

Returns:

Database table of the master record that is linked to the document.

getLinkedSAPObjectKey

@Nullable
public String getLinkedSAPObjectKey()

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

Original property name from the Odata EDM: LinkedSAPObjectKey

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

Returns:

Number which identifies the master record of an object that is allocated to a document.

getDocObjectLinkCounter

@Nullable
public String getDocObjectLinkCounter()

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

Original property name from the Odata EDM: DocObjectLinkCounter

Returns:

Counter key

toString

public String toString()

Overrides:

toString in class VdmObject<DocInfoRecdObjLinkChgRecd>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<DocInfoRecdObjLinkChgRecd>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<DocInfoRecdObjLinkChgRecd>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<DocInfoRecdObjLinkChgRecd>