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

Class DocumentInfoRecordClass

java.lang.Object

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

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

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

public class DocumentInfoRecordClass
extends VdmEntity<DocumentInfoRecordClass>

API for DIR Class

Original entity name from the Odata EDM: A_DocumentInfoRecordClassType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static DocumentInfoRecordClassSelectable	ALL_FIELDS Selector for all available fields of DocumentInfoRecordClass.
static DocumentInfoRecordClassField<String>	CLASS_INTERNAL_ID Use with available fluent helpers to apply the ClassInternalID field to query operations.
static DocumentInfoRecordClassField<String>	CLASS_TYPE Use with available fluent helpers to apply the ClassType field to query operations.
static DocumentInfoRecordClassField<String>	DOCUMENT_INFO_RECORD_DOC_NUMBER Use with available fluent helpers to apply the DocumentInfoRecordDocNumber field to query operations.
static DocumentInfoRecordClassField<String>	DOCUMENT_INFO_RECORD_DOC_PART Use with available fluent helpers to apply the DocumentInfoRecordDocPart field to query operations.
static DocumentInfoRecordClassField<String>	DOCUMENT_INFO_RECORD_DOC_TYPE Use with available fluent helpers to apply the DocumentInfoRecordDocType field to query operations.
static DocumentInfoRecordClassField<String>	DOCUMENT_INFO_RECORD_DOC_VERSION Use with available fluent helpers to apply the DocumentInfoRecordDocVersion field to query operations.
static DocumentInfoRecordClassField<LocalDateTime>	KEY_DATE Use with available fluent helpers to apply the KeyDate field to query operations.
static DocumentInfoRecordClassLink<DocumentInfoRecordClassCharc>	TO_CHARACTERISTICS Use with available fluent helpers to apply the to_Characteristics navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
DocumentInfoRecordClass()
DocumentInfoRecordClass(String documentInfoRecordDocType, String documentInfoRecordDocNumber, String documentInfoRecordDocVersion, String documentInfoRecordDocPart, String classInternalID, LocalDateTime keyDate, String classType, List<DocumentInfoRecordClassCharc> toCharacteristics)

Method Summary

Modifier and Type	Method and Description
void	addCharacteristics(DocumentInfoRecordClassCharc... entity) Adds elements to the list of associated DocumentInfoRecordClassCharc entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static DocumentInfoRecordClass.DocumentInfoRecordClassBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<DocumentInfoRecordClassCharc>	fetchCharacteristics() Fetches the DocumentInfoRecordClassCharc entities (one to many) associated with this entity.
static <T> DocumentInfoRecordClassField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> DocumentInfoRecordClassField<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)
io.vavr.control.Option<List<DocumentInfoRecordClassCharc>>	getCharacteristicsIfPresent() Retrieval of associated DocumentInfoRecordClassCharc entities (one to many).
List<DocumentInfoRecordClassCharc>	getCharacteristicsOrFetch() Retrieval of associated DocumentInfoRecordClassCharc entities (one to many).
String	getClassInternalID() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getClassType() Constraints: Not nullable, Maximum length: 3
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.
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()
LocalDateTime	getKeyDate() Constraints: Not nullable, Precision: 0
Class<DocumentInfoRecordClass>	getType()
int	hashCode()
void	setCharacteristics(List<DocumentInfoRecordClassCharc> value) Overwrites the list of associated DocumentInfoRecordClassCharc entities for the loaded navigation property to_Characteristics.
void	setClassInternalID(String classInternalID) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setClassType(String classType) Constraints: Not nullable, Maximum length: 3
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	setKeyDate(LocalDateTime keyDate) Constraints: Not nullable, Precision: 0
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 DocumentInfoRecordClassSelectable ALL_FIELDS

Selector for all available fields of DocumentInfoRecordClass.

DOCUMENT_INFO_RECORD_DOC_TYPE

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

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

CLASS_INTERNAL_ID

public static final DocumentInfoRecordClassField<String> CLASS_INTERNAL_ID

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

KEY_DATE

public static final DocumentInfoRecordClassField<LocalDateTime> KEY_DATE

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

CLASS_TYPE

public static final DocumentInfoRecordClassField<String> CLASS_TYPE

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

TO_CHARACTERISTICS

public static final DocumentInfoRecordClassLink<DocumentInfoRecordClassCharc> TO_CHARACTERISTICS

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

Constructor Detail

DocumentInfoRecordClass

public DocumentInfoRecordClass()

DocumentInfoRecordClass

public DocumentInfoRecordClass(@Nullable
                               String documentInfoRecordDocType,
                               @Nullable
                               String documentInfoRecordDocNumber,
                               @Nullable
                               String documentInfoRecordDocVersion,
                               @Nullable
                               String documentInfoRecordDocPart,
                               @Nullable
                               String classInternalID,
                               @Nullable
                               LocalDateTime keyDate,
                               @Nullable
                               String classType,
                               List<DocumentInfoRecordClassCharc> toCharacteristics)

Method Detail

getType

@Nonnull
public Class<DocumentInfoRecordClass> getType()

Specified by:

getType in class VdmObject<DocumentInfoRecordClass>

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.

setClassInternalID

public void setClassInternalID(@Nullable
                               String classInternalID)

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

Original property name from the Odata EDM: ClassInternalID

Parameters:

classInternalID - Internal Class Number

setKeyDate

public void setKeyDate(@Nullable
                       LocalDateTime keyDate)

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: KeyDate

Parameters:

keyDate - The keyDate to set.

setClassType

public void setClassType(@Nullable
                         String classType)

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: ClassType

Parameters:

classType - Uniquely identifies the class type

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<DocumentInfoRecordClass>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<DocumentInfoRecordClass>

fromMap

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

Overrides:

fromMap in class VdmObject<DocumentInfoRecordClass>

field

@Nonnull
public static <T> DocumentInfoRecordClassField<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> DocumentInfoRecordClassField<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<DocumentInfoRecordClass>

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

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

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

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

fetchCharacteristics

@Nonnull
public List<DocumentInfoRecordClassCharc> fetchCharacteristics()
                                                                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the DocumentInfoRecordClassCharc entities (one to many) associated with this entity. This corresponds to the OData navigation property to_Characteristics.

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

Returns:

List containing one or more associated DocumentInfoRecordClassCharc entities. If no entities are associated then an empty list is returned.

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.

getCharacteristicsOrFetch

@Nonnull
public List<DocumentInfoRecordClassCharc> getCharacteristicsOrFetch()
                                                                      throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated DocumentInfoRecordClassCharc entities (one to many). This corresponds to the OData navigation property to_Characteristics.

If the navigation property to_Characteristics of a queried DocumentInfoRecordClass 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 DocumentInfoRecordClassCharc entities.

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.

getCharacteristicsIfPresent

@Nonnull
public io.vavr.control.Option<List<DocumentInfoRecordClassCharc>> getCharacteristicsIfPresent()

Retrieval of associated DocumentInfoRecordClassCharc entities (one to many). This corresponds to the OData navigation property to_Characteristics.

If the navigation property for an entity DocumentInfoRecordClass 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_Characteristics is already loaded, the result will contain the DocumentInfoRecordClassCharc entities. If not, an Option with result state empty is returned.

setCharacteristics

public void setCharacteristics(@Nonnull
                               List<DocumentInfoRecordClassCharc> value)

Overwrites the list of associated DocumentInfoRecordClassCharc entities for the loaded navigation property to_Characteristics.

If the navigation property to_Characteristics of a queried DocumentInfoRecordClass 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.

Parameters:

value - List of DocumentInfoRecordClassCharc entities.

addCharacteristics

public void addCharacteristics(DocumentInfoRecordClassCharc... entity)

Adds elements to the list of associated DocumentInfoRecordClassCharc entities. This corresponds to the OData navigation property to_Characteristics.

If the navigation property to_Characteristics of a queried DocumentInfoRecordClass 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.

Parameters:

entity - Array of DocumentInfoRecordClassCharc entities.

builder

public static DocumentInfoRecordClass.DocumentInfoRecordClassBuilder 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.

getClassInternalID

@Nullable
public String getClassInternalID()

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

Original property name from the Odata EDM: ClassInternalID

Returns:

Internal Class Number

getKeyDate

@Nullable
public LocalDateTime getKeyDate()

Constraints: Not nullable, Precision: 0

Original property name from the Odata EDM: KeyDate

Returns:

The keyDate contained in this entity.

getClassType

@Nullable
public String getClassType()

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: ClassType

Returns:

Uniquely identifies the class type

toString

public String toString()

Overrides:

toString in class VdmObject<DocumentInfoRecordClass>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<DocumentInfoRecordClass>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<DocumentInfoRecordClass>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<DocumentInfoRecordClass>