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

Class DocumentInfoRecord

java.lang.Object

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

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmEntity<DocumentInfoRecord>

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

public class DocumentInfoRecord
extends VdmEntity<DocumentInfoRecord>

API for Document Info Record

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentInfoRecord.DocumentInfoRecordBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static DocumentInfoRecordSelectable	ALL_FIELDS Selector for all available fields of DocumentInfoRecord.
static DocumentInfoRecordField<String>	AUTHORIZATION_GROUP Use with available fluent helpers to apply the AuthorizationGroup field to query operations.
static DocumentInfoRecordField<String>	CHANGE_NUMBER Use with available fluent helpers to apply the ChangeNumber field to query operations.
static DocumentInfoRecordField<Calendar>	CHANGED_DATE_TIME Use with available fluent helpers to apply the ChangedDateTime field to query operations.
static DocumentInfoRecordField<String>	CREATED_BY_USER Use with available fluent helpers to apply the CreatedByUser field to query operations.
static DocumentInfoRecordField<Calendar>	CREATION_DATE_TIME Use with available fluent helpers to apply the CreationDateTime field to query operations.
static DocumentInfoRecordField<Boolean>	DOC_INFO_RECD_IS_MARKED_FOR_DELETION Use with available fluent helpers to apply the DocInfoRecdIsMarkedForDeletion field to query operations.
static DocumentInfoRecordField<String>	DOCUMENT_INFO_RECORD_DOC_NUMBER Use with available fluent helpers to apply the DocumentInfoRecordDocNumber field to query operations.
static DocumentInfoRecordField<String>	DOCUMENT_INFO_RECORD_DOC_PART Use with available fluent helpers to apply the DocumentInfoRecordDocPart field to query operations.
static DocumentInfoRecordField<String>	DOCUMENT_INFO_RECORD_DOC_TYPE Use with available fluent helpers to apply the DocumentInfoRecordDocType field to query operations.
static DocumentInfoRecordField<String>	DOCUMENT_INFO_RECORD_DOC_VERSION Use with available fluent helpers to apply the DocumentInfoRecordDocVersion field to query operations.
static DocumentInfoRecordField<String>	INTERNAL_DOCUMENT_STATUS Use with available fluent helpers to apply the InternalDocumentStatus field to query operations.
static DocumentInfoRecordField<Boolean>	IS_DOC_INFO_RECD_CREATED_FROM_CAD Use with available fluent helpers to apply the IsDocInfoRecdCreatedFromCAD field to query operations.
static DocumentInfoRecordField<String>	IS_DOC_INFO_RECD_STRUCTURE Use with available fluent helpers to apply the IsDocInfoRecdStructure field to query operations.
static DocumentInfoRecordField<String>	LABORATORY_OR_DESIGN_OFFICE Use with available fluent helpers to apply the LaboratoryOrDesignOffice field to query operations.
static DocumentInfoRecordField<String>	LAST_CHANGED_BY_USER Use with available fluent helpers to apply the LastChangedByUser field to query operations.
static DocumentInfoRecordField<String>	RESPONSIBLE_PERSON_NAME Use with available fluent helpers to apply the ResponsiblePersonName field to query operations.
static DocumentInfoRecordLink<DocumentInfoRecordDesc>	TO_DOC_DESC Use with available fluent helpers to apply the to_DocDesc navigation property to query operations.
static DocumentInfoRecordLink<DocumentInfoRecordDocStsVH>	TO_DOC_STATUS_VH Use with available fluent helpers to apply the to_DocStatusVH navigation property to query operations.
static DocumentInfoRecordLink<DocInfoRecdObjLinkProduct>	TO_PRODUCT_OBJ Use with available fluent helpers to apply the to_ProductObj navigation property to query operations.

Constructor Summary

Constructors

Constructor and Description
DocumentInfoRecord()
DocumentInfoRecord(String documentInfoRecordDocType, String documentInfoRecordDocVersion, String documentInfoRecordDocNumber, String documentInfoRecordDocPart, String internalDocumentStatus, String laboratoryOrDesignOffice, String authorizationGroup, String changeNumber, Boolean docInfoRecdIsMarkedForDeletion, Boolean isDocInfoRecdCreatedFromCAD, String isDocInfoRecdStructure, String responsiblePersonName, Calendar creationDateTime, String createdByUser, Calendar changedDateTime, String lastChangedByUser, ErpConfigContext erpConfigContext, List<DocumentInfoRecordDesc> toDocDesc, DocumentInfoRecordDocStsVH toDocStatusVH, List<DocInfoRecdObjLinkProduct> toProductObj)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDocDesc(DocumentInfoRecordDesc... entity) Adds elements to the list of associated DocumentInfoRecordDesc entities.
void	addProductObj(DocInfoRecdObjLinkProduct... entity) Adds elements to the list of associated DocInfoRecdObjLinkProduct entities.
static DocumentInfoRecord.DocumentInfoRecordBuilder	builder()
boolean	equals(Object o)
List<DocumentInfoRecordDesc>	fetchDocDesc() Fetches the DocumentInfoRecordDesc entities (one to many) associated with this entity.
DocumentInfoRecordDocStsVH	fetchDocStatusVH() Fetches the DocumentInfoRecordDocStsVH entity (one to one) associated with this entity.
List<DocInfoRecdObjLinkProduct>	fetchProductObj() Fetches the DocInfoRecdObjLinkProduct entities (one to many) associated with this entity.
static <T> DocumentInfoRecordField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
String	getAuthorizationGroup() Constraints: Not nullable, Maximum length: 4
Calendar	getChangedDateTime() Constraints: Not nullable, Precision: 0
String	getChangeNumber() Constraints: Not nullable, Maximum length: 12
String	getCreatedByUser() Constraints: Not nullable, Maximum length: 12
Calendar	getCreationDateTime() Constraints: Not nullable, Precision: 0
List<DocumentInfoRecordDesc>	getDocDescOrFetch() Retrieval of associated DocumentInfoRecordDesc entities (one to many).
com.google.common.base.Optional<List<DocumentInfoRecordDesc>>	getDocDescOrNull() Retrieval of associated DocumentInfoRecordDesc entities (one to many).
Boolean	getDocInfoRecdIsMarkedForDeletion() Constraints: none
DocumentInfoRecordDocStsVH	getDocStatusVHOrFetch() Retrieval of associated DocumentInfoRecordDocStsVH entity (one to one).
com.google.common.base.Optional<DocumentInfoRecordDocStsVH>	getDocStatusVHOrNull() Retrieval of associated DocumentInfoRecordDocStsVH entity (one to one).
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
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
String	getInternalDocumentStatus() Constraints: Not nullable, Maximum length: 2
Boolean	getIsDocInfoRecdCreatedFromCAD() Constraints: none
String	getIsDocInfoRecdStructure() Constraints: Not nullable, Maximum length: 1
String	getLaboratoryOrDesignOffice() Constraints: Not nullable, Maximum length: 3
String	getLastChangedByUser() Constraints: Not nullable, Maximum length: 12
List<DocInfoRecdObjLinkProduct>	getProductObjOrFetch() Retrieval of associated DocInfoRecdObjLinkProduct entities (one to many).
com.google.common.base.Optional<List<DocInfoRecdObjLinkProduct>>	getProductObjOrNull() Retrieval of associated DocInfoRecdObjLinkProduct entities (one to many).
String	getResponsiblePersonName() Constraints: Not nullable, Maximum length: 12
Class<DocumentInfoRecord>	getType()
int	hashCode()
void	setAuthorizationGroup(String authorizationGroup) Constraints: Not nullable, Maximum length: 4
void	setChangedDateTime(Calendar changedDateTime) Constraints: Not nullable, Precision: 0
void	setChangeNumber(String changeNumber) Constraints: Not nullable, Maximum length: 12
void	setCreatedByUser(String createdByUser) Constraints: Not nullable, Maximum length: 12
void	setCreationDateTime(Calendar creationDateTime) Constraints: Not nullable, Precision: 0
void	setDocDesc(List<DocumentInfoRecordDesc> value) Overwrites the list of associated DocumentInfoRecordDesc entities for the loaded navigation property to_DocDesc.
void	setDocInfoRecdIsMarkedForDeletion(Boolean docInfoRecdIsMarkedForDeletion) Constraints: none
void	setDocStatusVH(DocumentInfoRecordDocStsVH value) Overwrites the associated DocumentInfoRecordDocStsVH entity for the loaded navigation property to_DocStatusVH.
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) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setInternalDocumentStatus(String internalDocumentStatus) Constraints: Not nullable, Maximum length: 2
void	setIsDocInfoRecdCreatedFromCAD(Boolean isDocInfoRecdCreatedFromCAD) Constraints: none
void	setIsDocInfoRecdStructure(String isDocInfoRecdStructure) Constraints: Not nullable, Maximum length: 1
void	setLaboratoryOrDesignOffice(String laboratoryOrDesignOffice) Constraints: Not nullable, Maximum length: 3
void	setLastChangedByUser(String lastChangedByUser) Constraints: Not nullable, Maximum length: 12
void	setProductObj(List<DocInfoRecdObjLinkProduct> value) Overwrites the list of associated DocInfoRecdObjLinkProduct entities for the loaded navigation property to_ProductObj.
void	setResponsiblePersonName(String responsiblePersonName) Constraints: Not nullable, Maximum length: 12
String	toString()

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

getCustomField, getCustomField, getCustomFieldNames, getCustomFields, hasCustomField, hasCustomField, setCustomField, setCustomField

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final DocumentInfoRecordSelectable ALL_FIELDS

Selector for all available fields of DocumentInfoRecord.

DOCUMENT_INFO_RECORD_DOC_TYPE

public static final DocumentInfoRecordField<String> DOCUMENT_INFO_RECORD_DOC_TYPE

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

DOCUMENT_INFO_RECORD_DOC_VERSION

public static final DocumentInfoRecordField<String> DOCUMENT_INFO_RECORD_DOC_VERSION

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

DOCUMENT_INFO_RECORD_DOC_NUMBER

public static final DocumentInfoRecordField<String> DOCUMENT_INFO_RECORD_DOC_NUMBER

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

DOCUMENT_INFO_RECORD_DOC_PART

public static final DocumentInfoRecordField<String> DOCUMENT_INFO_RECORD_DOC_PART

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

INTERNAL_DOCUMENT_STATUS

public static final DocumentInfoRecordField<String> INTERNAL_DOCUMENT_STATUS

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

LABORATORY_OR_DESIGN_OFFICE

public static final DocumentInfoRecordField<String> LABORATORY_OR_DESIGN_OFFICE

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

AUTHORIZATION_GROUP

public static final DocumentInfoRecordField<String> AUTHORIZATION_GROUP

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

CHANGE_NUMBER

public static final DocumentInfoRecordField<String> CHANGE_NUMBER

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

DOC_INFO_RECD_IS_MARKED_FOR_DELETION

public static final DocumentInfoRecordField<Boolean> DOC_INFO_RECD_IS_MARKED_FOR_DELETION

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

IS_DOC_INFO_RECD_CREATED_FROM_CAD

public static final DocumentInfoRecordField<Boolean> IS_DOC_INFO_RECD_CREATED_FROM_CAD

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

IS_DOC_INFO_RECD_STRUCTURE

public static final DocumentInfoRecordField<String> IS_DOC_INFO_RECD_STRUCTURE

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

RESPONSIBLE_PERSON_NAME

public static final DocumentInfoRecordField<String> RESPONSIBLE_PERSON_NAME

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

CREATION_DATE_TIME

public static final DocumentInfoRecordField<Calendar> CREATION_DATE_TIME

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

CREATED_BY_USER

public static final DocumentInfoRecordField<String> CREATED_BY_USER

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

CHANGED_DATE_TIME

public static final DocumentInfoRecordField<Calendar> CHANGED_DATE_TIME

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

LAST_CHANGED_BY_USER

public static final DocumentInfoRecordField<String> LAST_CHANGED_BY_USER

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

TO_DOC_DESC

public static final DocumentInfoRecordLink<DocumentInfoRecordDesc> TO_DOC_DESC

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

TO_DOC_STATUS_VH

public static final DocumentInfoRecordLink<DocumentInfoRecordDocStsVH> TO_DOC_STATUS_VH

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

TO_PRODUCT_OBJ

public static final DocumentInfoRecordLink<DocInfoRecdObjLinkProduct> TO_PRODUCT_OBJ

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

Constructor Detail

DocumentInfoRecord

@Generated(value="lombok")
public DocumentInfoRecord()

DocumentInfoRecord

@ConstructorProperties(value={"documentInfoRecordDocType","documentInfoRecordDocVersion","documentInfoRecordDocNumber","documentInfoRecordDocPart","internalDocumentStatus","laboratoryOrDesignOffice","authorizationGroup","changeNumber","docInfoRecdIsMarkedForDeletion","isDocInfoRecdCreatedFromCAD","isDocInfoRecdStructure","responsiblePersonName","creationDateTime","createdByUser","changedDateTime","lastChangedByUser","erpConfigContext","toDocDesc","toDocStatusVH","toProductObj"})
@Generated(value="lombok")
public DocumentInfoRecord(@Nullable
                                                            String documentInfoRecordDocType,
                                                            @Nullable
                                                            String documentInfoRecordDocVersion,
                                                            @Nullable
                                                            String documentInfoRecordDocNumber,
                                                            @Nullable
                                                            String documentInfoRecordDocPart,
                                                            @Nullable
                                                            String internalDocumentStatus,
                                                            @Nullable
                                                            String laboratoryOrDesignOffice,
                                                            @Nullable
                                                            String authorizationGroup,
                                                            @Nullable
                                                            String changeNumber,
                                                            @Nullable
                                                            Boolean docInfoRecdIsMarkedForDeletion,
                                                            @Nullable
                                                            Boolean isDocInfoRecdCreatedFromCAD,
                                                            @Nullable
                                                            String isDocInfoRecdStructure,
                                                            @Nullable
                                                            String responsiblePersonName,
                                                            @Nullable
                                                            Calendar creationDateTime,
                                                            @Nullable
                                                            String createdByUser,
                                                            @Nullable
                                                            Calendar changedDateTime,
                                                            @Nullable
                                                            String lastChangedByUser,
                                                            @Nullable
                                                            ErpConfigContext erpConfigContext,
                                                            List<DocumentInfoRecordDesc> toDocDesc,
                                                            @Nullable
                                                            DocumentInfoRecordDocStsVH toDocStatusVH,
                                                            List<DocInfoRecdObjLinkProduct> toProductObj)

Method Detail

getType

public Class<DocumentInfoRecord> getType()

Specified by:

getType in class VdmObject<DocumentInfoRecord>

Returns:

The class of this object.

field

public static <T> DocumentInfoRecordField<T> field(String fieldName,
                                   Class<T> fieldType)

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

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.

fetchDocDesc

public List<DocumentInfoRecordDesc> fetchDocDesc()
                                          throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

List containing one or more associated DocumentInfoRecordDesc 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.

getDocDescOrFetch

public List<DocumentInfoRecordDesc> getDocDescOrFetch()
                                               throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated DocumentInfoRecordDesc entities (one to many).

If the navigation property to_DocDesc of a queried DocumentInfoRecord 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 DocumentInfoRecordDesc 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.

getDocDescOrNull

public com.google.common.base.Optional<List<DocumentInfoRecordDesc>> getDocDescOrNull()

Retrieval of associated DocumentInfoRecordDesc entities (one to many).

If the navigation property to_DocDesc for an entity DocumentInfoRecord has not been resolved yet, this method will not query further information. Instead its Optional result state will be null.

Returns:

If the information for navigation property to_DocDesc is already loaded, the result will contain the DocumentInfoRecordDesc entities. If not, a null value state is returned.

setDocDesc

public void setDocDesc(@NonNull
              List<DocumentInfoRecordDesc> value)

Overwrites the list of associated DocumentInfoRecordDesc entities for the loaded navigation property to_DocDesc.

If the navigation property to_DocDesc of a queried DocumentInfoRecord 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 DocumentInfoRecordDesc entities.

addDocDesc

public void addDocDesc(DocumentInfoRecordDesc... entity)

Adds elements to the list of associated DocumentInfoRecordDesc entities.

If the navigation property to_DocDesc of a queried DocumentInfoRecord 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 DocumentInfoRecordDesc entities.

fetchDocStatusVH

public DocumentInfoRecordDocStsVH fetchDocStatusVH()
                                            throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

The single associated DocumentInfoRecordDocStsVH 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.

getDocStatusVHOrFetch

public DocumentInfoRecordDocStsVH getDocStatusVHOrFetch()
                                                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated DocumentInfoRecordDocStsVH entity (one to one).

If the navigation property to_DocStatusVH of a queried DocumentInfoRecord 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 DocumentInfoRecordDocStsVH 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.

getDocStatusVHOrNull

public com.google.common.base.Optional<DocumentInfoRecordDocStsVH> getDocStatusVHOrNull()

Retrieval of associated DocumentInfoRecordDocStsVH entity (one to one).

If the navigation property to_DocStatusVH for an entity DocumentInfoRecord has not been resolved yet, this method will not query further information. Instead its Optional result state will be null.

Returns:

If the information for navigation property to_DocStatusVH is already loaded, the result will contain the DocumentInfoRecordDocStsVH entity. If not, a null value state is returned.

setDocStatusVH

public void setDocStatusVH(DocumentInfoRecordDocStsVH value)

Overwrites the associated DocumentInfoRecordDocStsVH entity for the loaded navigation property to_DocStatusVH.

Parameters:

value - New DocumentInfoRecordDocStsVH entity.

fetchProductObj

public List<DocInfoRecdObjLinkProduct> fetchProductObj()
                                                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

List containing one or more associated DocInfoRecdObjLinkProduct 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.

getProductObjOrFetch

public List<DocInfoRecdObjLinkProduct> getProductObjOrFetch()
                                                     throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated DocInfoRecdObjLinkProduct entities (one to many).

If the navigation property to_ProductObj of a queried DocumentInfoRecord 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 DocInfoRecdObjLinkProduct 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.

getProductObjOrNull

public com.google.common.base.Optional<List<DocInfoRecdObjLinkProduct>> getProductObjOrNull()

Retrieval of associated DocInfoRecdObjLinkProduct entities (one to many).

If the navigation property to_ProductObj for an entity DocumentInfoRecord has not been resolved yet, this method will not query further information. Instead its Optional result state will be null.

Returns:

If the information for navigation property to_ProductObj is already loaded, the result will contain the DocInfoRecdObjLinkProduct entities. If not, a null value state is returned.

setProductObj

public void setProductObj(@NonNull
                 List<DocInfoRecdObjLinkProduct> value)

Overwrites the list of associated DocInfoRecdObjLinkProduct entities for the loaded navigation property to_ProductObj.

If the navigation property to_ProductObj of a queried DocumentInfoRecord 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 DocInfoRecdObjLinkProduct entities.

addProductObj

public void addProductObj(DocInfoRecdObjLinkProduct... entity)

Adds elements to the list of associated DocInfoRecdObjLinkProduct entities.

If the navigation property to_ProductObj of a queried DocumentInfoRecord 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 DocInfoRecdObjLinkProduct entities.

builder

@Generated(value="lombok")
public static DocumentInfoRecord.DocumentInfoRecordBuilder builder()

getDocumentInfoRecordDocType

@Nullable
@Generated(value="lombok")
public String getDocumentInfoRecordDocType()

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

Returns:

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

getDocumentInfoRecordDocVersion

@Nullable
@Generated(value="lombok")
public String getDocumentInfoRecordDocVersion()

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

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.

getDocumentInfoRecordDocNumber

@Nullable
@Generated(value="lombok")
public String getDocumentInfoRecordDocNumber()

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

Returns:

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

getDocumentInfoRecordDocPart

@Nullable
@Generated(value="lombok")
public String getDocumentInfoRecordDocPart()

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

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.

getInternalDocumentStatus

@Nullable
@Generated(value="lombok")
public String getInternalDocumentStatus()

Constraints: Not nullable, Maximum length: 2

For each document type, you can define a status network in which one or more previous statuses are defined for a status. You can display the current possible entries (language-dependent) in any processing situation.When you set a new status, the system checks whether the current status is one of the possible previous statuses.When you set a status, the system checks your authorization.

Returns:

Key which represents the current document status.

getLaboratoryOrDesignOffice

@Nullable
@Generated(value="lombok")
public String getLaboratoryOrDesignOffice()

Constraints: Not nullable, Maximum length: 3

You define the keys in Customizing (for the Material Master).

Returns:

Key for the design office, laboratory, or laboratory worker responsible.

getAuthorizationGroup

@Nullable
@Generated(value="lombok")
public String getAuthorizationGroup()

Constraints: Not nullable, Maximum length: 4

In order to carry out a specific activity, the user must have authorization for the combination of the activity and the authorization group.

Returns:

The authorization group enables you protect access to certain objects.

getChangeNumber

@Nullable
@Generated(value="lombok")
public String getChangeNumber()

Constraints: Not nullable, Maximum length: 12

The system determines the valid-from date from the header of the change master record.If you want to create a document:Once you save the document info record, you can no longer change the change number.If you want to process the document with another change number, you have to create a new version.The change master record must support processing of documents (Indicator: object type active for change number must be set in the change master).

Returns:

Number of the change master record which groups together logically linked documents and any other SAP objects (such as bill of material, routing, material).

getDocInfoRecdIsMarkedForDeletion

@Nullable
@Generated(value="lombok")
public Boolean getDocInfoRecdIsMarkedForDeletion()

Constraints: none

Returns:

Indicator: the document will be deleted during the next reorganization run.

getIsDocInfoRecdCreatedFromCAD

@Nullable
@Generated(value="lombok")
public Boolean getIsDocInfoRecdCreatedFromCAD()

Constraints: none

This indicator is only for information.However you can use it as search criteria for a document search. You can restrict the document search as follows:Entry DescriptionX find documents with a CAD indicatorfind documents without a CAD indicator* find documents with or without a CAD indicatorThis indicator is set using the CAD interface.

Returns:

This indicator shows that the object (such as BOM or document) was created or changed in a CAD system. Data transfer in the SAP system via CAD interface.

getIsDocInfoRecdStructure

@Nullable
@Generated(value="lombok")
public String getIsDocInfoRecdStructure()

Constraints: Not nullable, Maximum length: 1

getResponsiblePersonName

@Nullable
@Generated(value="lombok")
public String getResponsiblePersonName()

Constraints: Not nullable, Maximum length: 12

When you Create or Change a document info record:When you create a document info record, the system sets your user name as a default. You can overwrite this name using any user name defined in the SAP System. If you do not know the exact user name, you can select a user generically.To do this, enter the characters you know. Replace the sections you do not know with the special character "*".Example:Enter: WI*E*Hit list: WIDDELWIDERSKIIf you do not know any characters, enter the special character "*" at the beginning of the field. Please note that this will put a heavy load on the system.If the department of the responsible user is maintained in user maintenance (Address), this is displayed after the name.

Returns:

Name of the user who is responsible for the document info record.

getCreationDateTime

@Nullable
@Generated(value="lombok")
public Calendar getCreationDateTime()

Constraints: Not nullable, Precision: 0

Returns:

Time Document Was Created

getCreatedByUser

@Nullable
@Generated(value="lombok")
public String getCreatedByUser()

Constraints: Not nullable, Maximum length: 12

Returns:

Document Creator's Name

getChangedDateTime

@Nullable
@Generated(value="lombok")
public Calendar getChangedDateTime()

Constraints: Not nullable, Precision: 0

Returns:

Time last change was made

getLastChangedByUser

@Nullable
@Generated(value="lombok")
public String getLastChangedByUser()

Constraints: Not nullable, Maximum length: 12

Returns:

Last Changed By

getErpConfigContext

@Nullable
@Generated(value="lombok")
public ErpConfigContext getErpConfigContext()

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Returns:

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

setDocumentInfoRecordDocType

@Generated(value="lombok")
public void setDocumentInfoRecordDocType(@Nullable
                                               String documentInfoRecordDocType)

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

Parameters:

documentInfoRecordDocType -

setDocumentInfoRecordDocVersion

@Generated(value="lombok")
public void setDocumentInfoRecordDocVersion(@Nullable
                                                  String documentInfoRecordDocVersion)

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

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 -

setDocumentInfoRecordDocNumber

@Generated(value="lombok")
public void setDocumentInfoRecordDocNumber(@Nullable
                                                 String documentInfoRecordDocNumber)

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

Parameters:

documentInfoRecordDocNumber -

setDocumentInfoRecordDocPart

@Generated(value="lombok")
public void setDocumentInfoRecordDocPart(@Nullable
                                               String documentInfoRecordDocPart)

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

Design departments, for example, can use document parts to divide up large documents such as design drawings into pages.

Parameters:

documentInfoRecordDocPart -

setInternalDocumentStatus

@Generated(value="lombok")
public void setInternalDocumentStatus(@Nullable
                                            String internalDocumentStatus)

Constraints: Not nullable, Maximum length: 2

For each document type, you can define a status network in which one or more previous statuses are defined for a status. You can display the current possible entries (language-dependent) in any processing situation.When you set a new status, the system checks whether the current status is one of the possible previous statuses.When you set a status, the system checks your authorization.

Parameters:

internalDocumentStatus -

setLaboratoryOrDesignOffice

@Generated(value="lombok")
public void setLaboratoryOrDesignOffice(@Nullable
                                              String laboratoryOrDesignOffice)

Constraints: Not nullable, Maximum length: 3

You define the keys in Customizing (for the Material Master).

Parameters:

laboratoryOrDesignOffice -

setAuthorizationGroup

@Generated(value="lombok")
public void setAuthorizationGroup(@Nullable
                                        String authorizationGroup)

Constraints: Not nullable, Maximum length: 4

In order to carry out a specific activity, the user must have authorization for the combination of the activity and the authorization group.

Parameters:

authorizationGroup -

setChangeNumber

@Generated(value="lombok")
public void setChangeNumber(@Nullable
                                  String changeNumber)

Constraints: Not nullable, Maximum length: 12

The system determines the valid-from date from the header of the change master record.If you want to create a document:Once you save the document info record, you can no longer change the change number.If you want to process the document with another change number, you have to create a new version.The change master record must support processing of documents (Indicator: object type active for change number must be set in the change master).

Parameters:

changeNumber -

setDocInfoRecdIsMarkedForDeletion

@Generated(value="lombok")
public void setDocInfoRecdIsMarkedForDeletion(@Nullable
                                                    Boolean docInfoRecdIsMarkedForDeletion)

Constraints: none

Parameters:

docInfoRecdIsMarkedForDeletion -

setIsDocInfoRecdCreatedFromCAD

@Generated(value="lombok")
public void setIsDocInfoRecdCreatedFromCAD(@Nullable
                                                 Boolean isDocInfoRecdCreatedFromCAD)

Constraints: none

This indicator is only for information.However you can use it as search criteria for a document search. You can restrict the document search as follows:Entry DescriptionX find documents with a CAD indicatorfind documents without a CAD indicator* find documents with or without a CAD indicatorThis indicator is set using the CAD interface.

Parameters:

isDocInfoRecdCreatedFromCAD -

setIsDocInfoRecdStructure

@Generated(value="lombok")
public void setIsDocInfoRecdStructure(@Nullable
                                            String isDocInfoRecdStructure)

Constraints: Not nullable, Maximum length: 1

Parameters:

isDocInfoRecdStructure -

setResponsiblePersonName

@Generated(value="lombok")
public void setResponsiblePersonName(@Nullable
                                           String responsiblePersonName)

Constraints: Not nullable, Maximum length: 12

When you Create or Change a document info record:When you create a document info record, the system sets your user name as a default. You can overwrite this name using any user name defined in the SAP System. If you do not know the exact user name, you can select a user generically.To do this, enter the characters you know. Replace the sections you do not know with the special character "*".Example:Enter: WI*E*Hit list: WIDDELWIDERSKIIf you do not know any characters, enter the special character "*" at the beginning of the field. Please note that this will put a heavy load on the system.If the department of the responsible user is maintained in user maintenance (Address), this is displayed after the name.

Parameters:

responsiblePersonName -

setCreationDateTime

@Generated(value="lombok")
public void setCreationDateTime(@Nullable
                                      Calendar creationDateTime)

Constraints: Not nullable, Precision: 0

Parameters:

creationDateTime -

setCreatedByUser

@Generated(value="lombok")
public void setCreatedByUser(@Nullable
                                   String createdByUser)

Constraints: Not nullable, Maximum length: 12

Parameters:

createdByUser -

setChangedDateTime

@Generated(value="lombok")
public void setChangedDateTime(@Nullable
                                     Calendar changedDateTime)

Constraints: Not nullable, Precision: 0

Parameters:

changedDateTime -

setLastChangedByUser

@Generated(value="lombok")
public void setLastChangedByUser(@Nullable
                                       String lastChangedByUser)

Constraints: Not nullable, Maximum length: 12

Parameters:

lastChangedByUser -

setErpConfigContext

@Generated(value="lombok")
public void setErpConfigContext(@Nullable
                                      ErpConfigContext erpConfigContext)

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Parameters:

erpConfigContext -

toString

@Generated(value="lombok")
public String toString()

Overrides:

toString in class VdmObject<DocumentInfoRecord>

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class VdmObject<DocumentInfoRecord>

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class VdmObject<DocumentInfoRecord>