public class DocumentInfoRecordAttch extends VdmEntity<DocumentInfoRecordAttch>
Original entity name from the Odata EDM: A_DocumentInfoRecordAttchType
Modifier and Type | Class and Description |
---|---|
static class |
DocumentInfoRecordAttch.DocumentInfoRecordAttchBuilder |
Modifier and Type | Field and Description |
---|---|
static DocumentInfoRecordAttchSelectable |
ALL_FIELDS
Selector for all available fields of DocumentInfoRecordAttch.
|
static DocumentInfoRecordAttchField<Boolean> |
DOC_INFO_RECD_IS_MARKED_FOR_DELETION
Use with available fluent helpers to apply the DocInfoRecdIsMarkedForDeletion field to query operations.
|
static DocumentInfoRecordAttchField<String> |
DOCUMENT_DESCRIPTION
Use with available fluent helpers to apply the DocumentDescription field to query operations.
|
static DocumentInfoRecordAttchField<String> |
DOCUMENT_INFO_RECORD
Use with available fluent helpers to apply the DocumentInfoRecord field to query operations.
|
static DocumentInfoRecordAttchField<String> |
DOCUMENT_INFO_RECORD_DOC_NUMBER
Use with available fluent helpers to apply the DocumentInfoRecordDocNumber field to query operations.
|
static DocumentInfoRecordAttchField<String> |
DOCUMENT_INFO_RECORD_DOC_PART
Use with available fluent helpers to apply the DocumentInfoRecordDocPart field to query operations.
|
static DocumentInfoRecordAttchField<String> |
DOCUMENT_INFO_RECORD_DOC_TYPE
Use with available fluent helpers to apply the DocumentInfoRecordDocType field to query operations.
|
static DocumentInfoRecordAttchField<String> |
DOCUMENT_INFO_RECORD_DOC_VERSION
Use with available fluent helpers to apply the DocumentInfoRecordDocVersion field to query operations.
|
static DocumentInfoRecordAttchField<String> |
DOCUMENT_STATUS_NAME
Use with available fluent helpers to apply the DocumentStatusName field to query operations.
|
static DocumentInfoRecordAttchField<String> |
EXTERNAL_DOCUMENT_STATUS
Use with available fluent helpers to apply the ExternalDocumentStatus field to query operations.
|
static DocumentInfoRecordAttchLink<AttachmentContent> |
TO_DOCUMENT_INFO_RECORD_TO_ATTACHMENT_NAVIGATION
Use with available fluent helpers to apply the DocumentInfoRecordToAttachmentNavigation navigation property to query operations.
|
changedOriginalFields
Constructor and Description |
---|
DocumentInfoRecordAttch() |
DocumentInfoRecordAttch(String documentInfoRecordDocType,
String documentInfoRecordDocNumber,
String documentInfoRecordDocVersion,
String documentInfoRecordDocPart,
String documentInfoRecord,
String documentDescription,
String externalDocumentStatus,
String documentStatusName,
Boolean docInfoRecdIsMarkedForDeletion,
ErpConfigContext erpConfigContext,
List<AttachmentContent> toDocumentInfoRecordToAttachmentNavigation) |
Modifier and Type | Method and Description |
---|---|
void |
addDocumentInfoRecordToAttachmentNavigation(AttachmentContent... entity)
Adds elements to the list of associated AttachmentContent entities.
|
static DocumentInfoRecordAttch.DocumentInfoRecordAttchBuilder |
builder() |
protected boolean |
canEqual(Object other) |
boolean |
equals(Object o) |
List<AttachmentContent> |
fetchDocumentInfoRecordToAttachmentNavigation()
Fetches the AttachmentContent entities (one to many) associated with this entity.
|
static <T> DocumentInfoRecordAttchField<T> |
field(String fieldName,
Class<T> fieldType)
Use with available fluent helpers to apply an extension field to query operations.
|
protected void |
fromMap(Map<String,Object> inputValues) |
Boolean |
getDocInfoRecdIsMarkedForDeletion()
Constraints: noneOriginal property name from the Odata EDM: DocInfoRecdIsMarkedForDeletion
|
String |
getDocumentDescription()
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: DocumentDescriptionIf you enter a long text describing the document (Edit -> Long text), the first 40 characters of the two texts are kept consistent.If this field is defined as a required field for a document type, this only applies to the logon language.
|
String |
getDocumentInfoRecord()
Constraints: Not nullable, Maximum length: 70 Original property name from the Odata EDM: DocumentInfoRecord
|
String |
getDocumentInfoRecordDocNumber()
(Key Field) Constraints: Not nullable, Maximum length: 25 Original property name from the Odata EDM: DocumentInfoRecordDocNumber
|
String |
getDocumentInfoRecordDocPart()
(Key Field) Constraints: Not nullable, Maximum length: 3 Original property name from the Odata EDM: DocumentInfoRecordDocPartDesign departments, for example, can use document parts to divide up large documents such as design drawings into pages.
|
String |
getDocumentInfoRecordDocType()
(Key Field) Constraints: Not nullable, Maximum length: 3 Original property name from the Odata EDM: DocumentInfoRecordDocType
|
String |
getDocumentInfoRecordDocVersion()
(Key Field) Constraints: Not nullable, Maximum length: 2 Original property name from the Odata EDM: DocumentInfoRecordDocVersionA 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).
|
Optional<List<AttachmentContent>> |
getDocumentInfoRecordToAttachmentNavigationIfPresent()
Retrieval of associated AttachmentContent entities (one to many).
|
List<AttachmentContent> |
getDocumentInfoRecordToAttachmentNavigationOrFetch()
Retrieval of associated AttachmentContent entities (one to many).
|
String |
getDocumentStatusName()
Constraints: Not nullable, Maximum length: 16 Original property name from the Odata EDM: DocumentStatusName
|
protected String |
getEndpointUrl() |
protected String |
getEntityCollection() |
ErpConfigContext |
getErpConfigContext()
Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
|
String |
getExternalDocumentStatus()
Constraints: Not nullable, Maximum length: 2 Original property name from the Odata EDM: ExternalDocumentStatusIf a status network is defined for the document type you canchoose a status among the entry possibilities which is supported inthe current processing situation when you create orchange.You can find more information with an additional colored release indicator:If the document version is releasedIn which time interval the version is releasedYou define the status network in Customizing work step Define document type level Define document status.
|
protected Map<String,Object> |
getKey() |
Class<DocumentInfoRecordAttch> |
getType() |
int |
hashCode() |
void |
setDocInfoRecdIsMarkedForDeletion(Boolean docInfoRecdIsMarkedForDeletion)
Constraints: noneOriginal property name from the Odata EDM: DocInfoRecdIsMarkedForDeletion
|
void |
setDocumentDescription(String documentDescription)
Constraints: Not nullable, Maximum length: 40 Original property name from the Odata EDM: DocumentDescriptionIf you enter a long text describing the document (Edit -> Long text), the first 40 characters of the two texts are kept consistent.If this field is defined as a required field for a document type, this only applies to the logon language.
|
void |
setDocumentInfoRecord(String documentInfoRecord)
Constraints: Not nullable, Maximum length: 70 Original property name from the Odata EDM: DocumentInfoRecord
|
void |
setDocumentInfoRecordDocNumber(String documentInfoRecordDocNumber)
(Key Field) Constraints: Not nullable, Maximum length: 25 Original property name from the Odata EDM: DocumentInfoRecordDocNumber
|
void |
setDocumentInfoRecordDocPart(String documentInfoRecordDocPart)
(Key Field) Constraints: Not nullable, Maximum length: 3 Original property name from the Odata EDM: DocumentInfoRecordDocPartDesign departments, for example, can use document parts to divide up large documents such as design drawings into pages.
|
void |
setDocumentInfoRecordDocType(String documentInfoRecordDocType)
(Key Field) Constraints: Not nullable, Maximum length: 3 Original property name from the Odata EDM: DocumentInfoRecordDocType
|
void |
setDocumentInfoRecordDocVersion(String documentInfoRecordDocVersion)
(Key Field) Constraints: Not nullable, Maximum length: 2 Original property name from the Odata EDM: DocumentInfoRecordDocVersionA 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).
|
void |
setDocumentInfoRecordToAttachmentNavigation(List<AttachmentContent> value)
Overwrites the list of associated AttachmentContent entities for the loaded navigation property DocumentInfoRecordToAttachmentNavigation.
|
void |
setDocumentStatusName(String documentStatusName)
Constraints: Not nullable, Maximum length: 16 Original property name from the Odata EDM: DocumentStatusName
|
void |
setErpConfigContext(ErpConfigContext erpConfigContext)
Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
|
void |
setExternalDocumentStatus(String externalDocumentStatus)
Constraints: Not nullable, Maximum length: 2 Original property name from the Odata EDM: ExternalDocumentStatusIf a status network is defined for the document type you canchoose a status among the entry possibilities which is supported inthe current processing situation when you create orchange.You can find more information with an additional colored release indicator:If the document version is releasedIn which time interval the version is releasedYou define the status network in Customizing work step Define document type level Define document status.
|
protected Map<String,Object> |
toMapOfFields() |
protected Map<String,Object> |
toMapOfNavigationProperties() |
String |
toString() |
getVersionIdentifier, setVersionIdentifier
getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields
public static final DocumentInfoRecordAttchSelectable ALL_FIELDS
public static final DocumentInfoRecordAttchField<String> DOCUMENT_INFO_RECORD_DOC_TYPE
public static final DocumentInfoRecordAttchField<String> DOCUMENT_INFO_RECORD_DOC_NUMBER
public static final DocumentInfoRecordAttchField<String> DOCUMENT_INFO_RECORD_DOC_VERSION
public static final DocumentInfoRecordAttchField<String> DOCUMENT_INFO_RECORD_DOC_PART
public static final DocumentInfoRecordAttchField<String> DOCUMENT_INFO_RECORD
public static final DocumentInfoRecordAttchField<String> DOCUMENT_DESCRIPTION
public static final DocumentInfoRecordAttchField<String> EXTERNAL_DOCUMENT_STATUS
public static final DocumentInfoRecordAttchField<String> DOCUMENT_STATUS_NAME
public static final DocumentInfoRecordAttchField<Boolean> DOC_INFO_RECD_IS_MARKED_FOR_DELETION
public static final DocumentInfoRecordAttchLink<AttachmentContent> TO_DOCUMENT_INFO_RECORD_TO_ATTACHMENT_NAVIGATION
public DocumentInfoRecordAttch()
public DocumentInfoRecordAttch(@Nullable String documentInfoRecordDocType, @Nullable String documentInfoRecordDocNumber, @Nullable String documentInfoRecordDocVersion, @Nullable String documentInfoRecordDocPart, @Nullable String documentInfoRecord, @Nullable String documentDescription, @Nullable String externalDocumentStatus, @Nullable String documentStatusName, @Nullable Boolean docInfoRecdIsMarkedForDeletion, @Nullable ErpConfigContext erpConfigContext, List<AttachmentContent> toDocumentInfoRecordToAttachmentNavigation)
public Class<DocumentInfoRecordAttch> getType()
getType
in class VdmObject<DocumentInfoRecordAttch>
public void setDocumentInfoRecordDocType(@Nullable String documentInfoRecordDocType)
Original property name from the Odata EDM: DocumentInfoRecordDocType
documentInfoRecordDocType
- Part of the document key, which categorizes documents according to their distinguishing features and the organizational procedures which result from them.public void setDocumentInfoRecordDocNumber(@Nullable String documentInfoRecordDocNumber)
Original property name from the Odata EDM: DocumentInfoRecordDocNumber
documentInfoRecordDocNumber
- This number is the main part of the document key, which is used to identify the document.public void setDocumentInfoRecordDocVersion(@Nullable String documentInfoRecordDocVersion)
Original property name from the Odata EDM: DocumentInfoRecordDocVersion
A new version is assigned after the original files have been edited in the following processing situations:The new processing status varies from the original in a certain way (for example, text change sin a text file).You want the original processing status to remain the same (for example, documentation of project progress).
documentInfoRecordDocVersion
- Number which identifies the version of a document.public void setDocumentInfoRecordDocPart(@Nullable String documentInfoRecordDocPart)
Original property name from the Odata EDM: DocumentInfoRecordDocPart
Design departments, for example, can use document parts to divide up large documents such as design drawings into pages.
documentInfoRecordDocPart
- Section of a document which is maintained as an independent document.public void setDocumentInfoRecord(@Nullable String documentInfoRecord)
Original property name from the Odata EDM: DocumentInfoRecord
documentInfoRecord
- Document Info Record key in concatenated formpublic void setDocumentDescription(@Nullable String documentDescription)
Original property name from the Odata EDM: DocumentDescription
If you enter a long text describing the document (Edit -> Long text), the first 40 characters of the two texts are kept consistent.If this field is defined as a required field for a document type, this only applies to the logon language. If you change the language while creating the document, the field becomes an optional field.
documentDescription
- Short text describing the document.public void setExternalDocumentStatus(@Nullable String externalDocumentStatus)
Original property name from the Odata EDM: ExternalDocumentStatus
If a status network is defined for the document type you canchoose a status among the entry possibilities which is supported inthe current processing situation when you create orchange.You can find more information with an additional colored release indicator:If the document version is releasedIn which time interval the version is releasedYou define the status network in Customizing work step Define document type level Define document status.
externalDocumentStatus
- This key shows the document status.public void setDocumentStatusName(@Nullable String documentStatusName)
Original property name from the Odata EDM: DocumentStatusName
documentStatusName
- Description of the current document status.public void setDocInfoRecdIsMarkedForDeletion(@Nullable Boolean docInfoRecdIsMarkedForDeletion)
Original property name from the Odata EDM: DocInfoRecdIsMarkedForDeletion
docInfoRecdIsMarkedForDeletion
- Indicator: the document will be deleted during the next reorganization run.protected String getEndpointUrl()
getEndpointUrl
in class VdmEntity<DocumentInfoRecordAttch>
protected String getEntityCollection()
getEntityCollection
in class VdmEntity<DocumentInfoRecordAttch>
protected Map<String,Object> getKey()
getKey
in class VdmObject<DocumentInfoRecordAttch>
protected Map<String,Object> toMapOfFields()
toMapOfFields
in class VdmObject<DocumentInfoRecordAttch>
protected void fromMap(Map<String,Object> inputValues)
fromMap
in class VdmObject<DocumentInfoRecordAttch>
public static <T> DocumentInfoRecordAttchField<T> field(String fieldName, Class<T> fieldType)
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.protected Map<String,Object> toMapOfNavigationProperties()
toMapOfNavigationProperties
in class VdmObject<DocumentInfoRecordAttch>
public List<AttachmentContent> fetchDocumentInfoRecordToAttachmentNavigation() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
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.public List<AttachmentContent> getDocumentInfoRecordToAttachmentNavigationOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
If the navigation property DocumentInfoRecordToAttachmentNavigation of a queried DocumentInfoRecordAttch is operated lazily, an ODataException can be thrown in case of an OData query error.
Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.
com.sap.cloud.sdk.odatav2.connectivity.ODataException
- If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.public Optional<List<AttachmentContent>> getDocumentInfoRecordToAttachmentNavigationIfPresent()
If the navigation property for an entity DocumentInfoRecordAttch has not been resolved yet, this method will not query further information. Instead its Optional
result state will be empty
.
Optional
with result state empty
is returned.public void setDocumentInfoRecordToAttachmentNavigation(@Nonnull List<AttachmentContent> value)
If the navigation property DocumentInfoRecordToAttachmentNavigation of a queried DocumentInfoRecordAttch 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.
value
- List of AttachmentContent entities.public void addDocumentInfoRecordToAttachmentNavigation(AttachmentContent... entity)
If the navigation property DocumentInfoRecordToAttachmentNavigation of a queried DocumentInfoRecordAttch 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.
entity
- Array of AttachmentContent entities.public static DocumentInfoRecordAttch.DocumentInfoRecordAttchBuilder builder()
@Nullable public String getDocumentInfoRecordDocType()
Original property name from the Odata EDM: DocumentInfoRecordDocType
@Nullable public String getDocumentInfoRecordDocNumber()
Original property name from the Odata EDM: DocumentInfoRecordDocNumber
@Nullable public String getDocumentInfoRecordDocVersion()
Original property name from the Odata EDM: DocumentInfoRecordDocVersion
A new version is assigned after the original files have been edited in the following processing situations:The new processing status varies from the original in a certain way (for example, text change sin a text file).You want the original processing status to remain the same (for example, documentation of project progress).
@Nullable public String getDocumentInfoRecordDocPart()
Original property name from the Odata EDM: DocumentInfoRecordDocPart
Design departments, for example, can use document parts to divide up large documents such as design drawings into pages.
@Nullable public String getDocumentInfoRecord()
Original property name from the Odata EDM: DocumentInfoRecord
@Nullable public String getDocumentDescription()
Original property name from the Odata EDM: DocumentDescription
If you enter a long text describing the document (Edit -> Long text), the first 40 characters of the two texts are kept consistent.If this field is defined as a required field for a document type, this only applies to the logon language. If you change the language while creating the document, the field becomes an optional field.
@Nullable public String getExternalDocumentStatus()
Original property name from the Odata EDM: ExternalDocumentStatus
If a status network is defined for the document type you canchoose a status among the entry possibilities which is supported inthe current processing situation when you create orchange.You can find more information with an additional colored release indicator:If the document version is releasedIn which time interval the version is releasedYou define the status network in Customizing work step Define document type level Define document status.
@Nullable public String getDocumentStatusName()
Original property name from the Odata EDM: DocumentStatusName
@Nullable public Boolean getDocInfoRecdIsMarkedForDeletion()
Original property name from the Odata EDM: DocInfoRecdIsMarkedForDeletion
@Nullable public ErpConfigContext getErpConfigContext()
public void setErpConfigContext(@Nullable ErpConfigContext erpConfigContext)
setErpConfigContext
in class VdmEntity<DocumentInfoRecordAttch>
erpConfigContext
- public String toString()
toString
in class VdmObject<DocumentInfoRecordAttch>
public boolean equals(Object o)
equals
in class VdmObject<DocumentInfoRecordAttch>
protected boolean canEqual(Object other)
canEqual
in class VdmObject<DocumentInfoRecordAttch>
public int hashCode()
hashCode
in class VdmObject<DocumentInfoRecordAttch>
Copyright © 2018 SAP SE. All rights reserved.