public class CustomerReturnProcessStep extends VdmEntity<CustomerReturnProcessStep>
Original entity name from the Odata EDM: A_CustomerReturnProcessStepType
Modifier and Type | Class and Description |
---|---|
static class |
CustomerReturnProcessStep.CustomerReturnProcessStepBuilder
Helper class to allow for fluent creation of CustomerReturnProcessStep instances.
|
Modifier and Type | Field and Description |
---|---|
static CustomerReturnProcessStepSelectable |
ALL_FIELDS
Selector for all available fields of CustomerReturnProcessStep.
|
static CustomerReturnProcessStepField<String> |
RETS_MGMT_PROC_ITM_QTY_SPLIT
Use with available fluent helpers to apply the RetsMgmtProcItmQtySplit field to query operations.
|
static CustomerReturnProcessStepField<String> |
RETS_MGMT_PROC_STEP_EXEC_STATUS
Use with available fluent helpers to apply the RetsMgmtProcStepExecStatus field to query operations.
|
static CustomerReturnProcessStepField<String> |
RETS_MGMT_PROCESS
Use with available fluent helpers to apply the RetsMgmtProcess field to query operations.
|
static CustomerReturnProcessStepField<String> |
RETS_MGMT_PROCESS_ITEM
Use with available fluent helpers to apply the RetsMgmtProcessItem field to query operations.
|
static CustomerReturnProcessStepField<String> |
RETS_MGMT_PROCESS_STEP
Use with available fluent helpers to apply the RetsMgmtProcessStep field to query operations.
|
static CustomerReturnProcessStepField<String> |
RETURNS_DOCUMENT
Use with available fluent helpers to apply the ReturnsDocument field to query operations.
|
static CustomerReturnProcessStepField<String> |
RETURNS_DOCUMENT_APPROVAL_STATUS
Use with available fluent helpers to apply the ReturnsDocumentApprovalStatus field to query operations.
|
static CustomerReturnProcessStepField<String> |
RETURNS_DOCUMENT_ITEM
Use with available fluent helpers to apply the ReturnsDocumentItem field to query operations.
|
static CustomerReturnProcessStepField<String> |
RETURNS_DOCUMENT_STATUS
Use with available fluent helpers to apply the ReturnsDocumentStatus field to query operations.
|
static CustomerReturnProcessStepField<String> |
RETURNS_DOCUMENT_TYPE
Use with available fluent helpers to apply the ReturnsDocumentType field to query operations.
|
static CustomerReturnProcessStepField<String> |
RETURNS_REFERENCE_DOCUMENT
Use with available fluent helpers to apply the ReturnsReferenceDocument field to query operations.
|
static CustomerReturnProcessStepField<String> |
RETURNS_REFERENCE_DOCUMENT_ITEM
Use with available fluent helpers to apply the ReturnsReferenceDocumentItem field to query operations.
|
static CustomerReturnProcessStepField<String> |
RETURNS_REFERENCE_DOCUMENT_TYPE
Use with available fluent helpers to apply the ReturnsReferenceDocumentType field to query operations.
|
static CustomerReturnProcessStepOneToOneLink<CustomerReturn> |
TO_CUSTOMER_RETURN
Use with available fluent helpers to apply the to_CustomerReturn navigation property to query operations.
|
static CustomerReturnProcessStepOneToOneLink<CustomerReturnItem> |
TO_CUSTOMER_RETURN_ITEM
Use with available fluent helpers to apply the to_CustomerReturnItem navigation property to query
operations.
|
changedOriginalFields
Constructor and Description |
---|
CustomerReturnProcessStep() |
CustomerReturnProcessStep(String retsMgmtProcess,
String retsMgmtProcessItem,
String retsMgmtProcItmQtySplit,
String retsMgmtProcessStep,
String returnsDocumentType,
String returnsDocument,
String returnsDocumentItem,
String returnsDocumentStatus,
String returnsDocumentApprovalStatus,
String returnsReferenceDocumentType,
String returnsReferenceDocument,
String returnsReferenceDocumentItem,
String retsMgmtProcStepExecStatus,
CustomerReturn toCustomerReturn,
CustomerReturnItem toCustomerReturnItem) |
Modifier and Type | Method and Description |
---|---|
void |
attachToService(String servicePath,
HttpDestinationProperties destination)
Sets the service path and destination for the fetch commands of this entity.
|
static CustomerReturnProcessStep.CustomerReturnProcessStepBuilder |
builder() |
protected boolean |
canEqual(Object other) |
boolean |
equals(Object o) |
CustomerReturn |
fetchCustomerReturn()
Fetches the CustomerReturn entity (one to one) associated with this entity.
|
CustomerReturnItem |
fetchCustomerReturnItem()
Fetches the CustomerReturnItem entity (one to one) associated with this entity.
|
static <T> CustomerReturnProcessStepField<T> |
field(String fieldName,
Class<T> fieldType)
Use with available fluent helpers to apply an extension field to query operations.
|
static <T,DomainT> |
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<CustomerReturn> |
getCustomerReturnIfPresent()
Retrieval of associated CustomerReturn entity (one to one).
|
io.vavr.control.Option<CustomerReturnItem> |
getCustomerReturnItemIfPresent()
Retrieval of associated CustomerReturnItem entity (one to one).
|
CustomerReturnItem |
getCustomerReturnItemOrFetch()
Retrieval of associated CustomerReturnItem entity (one to one).
|
CustomerReturn |
getCustomerReturnOrFetch()
Retrieval of associated CustomerReturn entity (one to one).
|
protected String |
getDefaultServicePath() |
HttpDestinationProperties |
getDestinationForFetch()
Convienence field for reusing the same destination with multiple queries (e.g.
|
protected String |
getEntityCollection() |
protected Map<String,Object> |
getKey() |
String |
getRetsMgmtProcess()
(Key Field) Constraints: Not nullable, Maximum length: 10
|
String |
getRetsMgmtProcessItem()
(Key Field) Constraints: Not nullable, Maximum length: 6
|
String |
getRetsMgmtProcessStep()
(Key Field) Constraints: Not nullable, Maximum length: 4
|
String |
getRetsMgmtProcItmQtySplit()
(Key Field) Constraints: Not nullable, Maximum length: 3
|
String |
getRetsMgmtProcStepExecStatus()
Constraints: Not nullable, Maximum length: 1
|
String |
getReturnsDocument()
(Key Field) Constraints: Not nullable, Maximum length: 30
|
String |
getReturnsDocumentApprovalStatus()
Constraints: Not nullable, Maximum length: 1
|
String |
getReturnsDocumentItem()
(Key Field) Constraints: Not nullable, Maximum length: 10
|
String |
getReturnsDocumentStatus()
Constraints: Not nullable, Maximum length: 1
|
String |
getReturnsDocumentType()
(Key Field) Constraints: Not nullable, Maximum length: 2
|
String |
getReturnsReferenceDocument()
Constraints: Not nullable, Maximum length: 30
|
String |
getReturnsReferenceDocumentItem()
Constraints: Not nullable, Maximum length: 10
|
String |
getReturnsReferenceDocumentType()
Constraints: Not nullable, Maximum length: 2
|
Class<CustomerReturnProcessStep> |
getType() |
int |
hashCode() |
void |
setCustomerReturn(CustomerReturn value)
Overwrites the associated CustomerReturn entity for the loaded navigation property
to_CustomerReturn.
|
void |
setCustomerReturnItem(CustomerReturnItem value)
Overwrites the associated CustomerReturnItem entity for the loaded navigation property
to_CustomerReturnItem.
|
void |
setRetsMgmtProcess(String retsMgmtProcess)
(Key Field) Constraints: Not nullable, Maximum length: 10
|
void |
setRetsMgmtProcessItem(String retsMgmtProcessItem)
(Key Field) Constraints: Not nullable, Maximum length: 6
|
void |
setRetsMgmtProcessStep(String retsMgmtProcessStep)
(Key Field) Constraints: Not nullable, Maximum length: 4
|
void |
setRetsMgmtProcItmQtySplit(String retsMgmtProcItmQtySplit)
(Key Field) Constraints: Not nullable, Maximum length: 3
|
void |
setRetsMgmtProcStepExecStatus(String retsMgmtProcStepExecStatus)
Constraints: Not nullable, Maximum length: 1
|
void |
setReturnsDocument(String returnsDocument)
(Key Field) Constraints: Not nullable, Maximum length: 30
|
void |
setReturnsDocumentApprovalStatus(String returnsDocumentApprovalStatus)
Constraints: Not nullable, Maximum length: 1
|
void |
setReturnsDocumentItem(String returnsDocumentItem)
(Key Field) Constraints: Not nullable, Maximum length: 10
|
void |
setReturnsDocumentStatus(String returnsDocumentStatus)
Constraints: Not nullable, Maximum length: 1
|
void |
setReturnsDocumentType(String returnsDocumentType)
(Key Field) Constraints: Not nullable, Maximum length: 2
|
void |
setReturnsReferenceDocument(String returnsReferenceDocument)
Constraints: Not nullable, Maximum length: 30
|
void |
setReturnsReferenceDocumentItem(String returnsReferenceDocumentItem)
Constraints: Not nullable, Maximum length: 10
|
void |
setReturnsReferenceDocumentType(String returnsReferenceDocumentType)
Constraints: Not nullable, Maximum length: 2
|
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() |
getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier
getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields
public static final CustomerReturnProcessStepSelectable ALL_FIELDS
public static final CustomerReturnProcessStepField<String> RETS_MGMT_PROCESS
public static final CustomerReturnProcessStepField<String> RETS_MGMT_PROCESS_ITEM
public static final CustomerReturnProcessStepField<String> RETS_MGMT_PROC_ITM_QTY_SPLIT
public static final CustomerReturnProcessStepField<String> RETS_MGMT_PROCESS_STEP
public static final CustomerReturnProcessStepField<String> RETURNS_DOCUMENT_TYPE
public static final CustomerReturnProcessStepField<String> RETURNS_DOCUMENT
public static final CustomerReturnProcessStepField<String> RETURNS_DOCUMENT_ITEM
public static final CustomerReturnProcessStepField<String> RETURNS_DOCUMENT_STATUS
public static final CustomerReturnProcessStepField<String> RETURNS_DOCUMENT_APPROVAL_STATUS
public static final CustomerReturnProcessStepField<String> RETURNS_REFERENCE_DOCUMENT_TYPE
public static final CustomerReturnProcessStepField<String> RETURNS_REFERENCE_DOCUMENT
public static final CustomerReturnProcessStepField<String> RETURNS_REFERENCE_DOCUMENT_ITEM
public static final CustomerReturnProcessStepField<String> RETS_MGMT_PROC_STEP_EXEC_STATUS
public static final CustomerReturnProcessStepOneToOneLink<CustomerReturn> TO_CUSTOMER_RETURN
public static final CustomerReturnProcessStepOneToOneLink<CustomerReturnItem> TO_CUSTOMER_RETURN_ITEM
public CustomerReturnProcessStep()
public CustomerReturnProcessStep(@Nullable String retsMgmtProcess, @Nullable String retsMgmtProcessItem, @Nullable String retsMgmtProcItmQtySplit, @Nullable String retsMgmtProcessStep, @Nullable String returnsDocumentType, @Nullable String returnsDocument, @Nullable String returnsDocumentItem, @Nullable String returnsDocumentStatus, @Nullable String returnsDocumentApprovalStatus, @Nullable String returnsReferenceDocumentType, @Nullable String returnsReferenceDocument, @Nullable String returnsReferenceDocumentItem, @Nullable String retsMgmtProcStepExecStatus, @Nullable CustomerReturn toCustomerReturn, @Nullable CustomerReturnItem toCustomerReturnItem)
@Nonnull public Class<CustomerReturnProcessStep> getType()
getType
in class VdmObject<CustomerReturnProcessStep>
public void setRetsMgmtProcess(@Nullable String retsMgmtProcess)
Original property name from the Odata EDM: RetsMgmtProcess
retsMgmtProcess
- Specifies the unique identifier of the advanced returns process.public void setRetsMgmtProcessItem(@Nullable String retsMgmtProcessItem)
Original property name from the Odata EDM: RetsMgmtProcessItem
retsMgmtProcessItem
- Specifies an item in the start document of a returns process. This can be a returns order, a returns
purchase order, or a returns stock transport order.public void setRetsMgmtProcItmQtySplit(@Nullable String retsMgmtProcItmQtySplit)
Original property name from the Odata EDM: RetsMgmtProcItmQtySplit
The quantity of a specific returns item may be split up during the returns process, for example, because partial quantities of the returns item were assigned to different follow-up activities. These partial quantities are identified internally with a split ID.
retsMgmtProcItmQtySplit
- Identifies partial qantities of a specific returns item.public void setRetsMgmtProcessStep(@Nullable String retsMgmtProcessStep)
Original property name from the Odata EDM: RetsMgmtProcessStep
The advanced returns sequence Customer return received directly comprises the following steps:0001 Create Returns Order0021 Inbound Delivery0031 Goods Receipt0041 Inspection
retsMgmtProcessStep
- Describes a given document, such as a returns order, an inbound delivery, or a purchase order, in the
advanced returns process. Table MSR_I_STEP contains all valid step IDs.public void setReturnsDocumentType(@Nullable String returnsDocumentType)
Original property name from the Odata EDM: ReturnsDocumentType
returnsDocumentType
- Specifies the returns document type, such as a returns order, goods movement, or credit memo.public void setReturnsDocument(@Nullable String returnsDocument)
Original property name from the Odata EDM: ReturnsDocument
returnsDocument
- Specifies the document number of a returns document.public void setReturnsDocumentItem(@Nullable String returnsDocumentItem)
Original property name from the Odata EDM: ReturnsDocumentItem
returnsDocumentItem
- Specifies an item of the displayed document.public void setReturnsDocumentStatus(@Nullable String returnsDocumentStatus)
Original property name from the Odata EDM: ReturnsDocumentStatus
A document item can have the following statuses:ActiveThe document item has been created without errors.Deletion Flag SetThe document item has been deleted.Document Was CancelledThe document item has been cancelled and a corresponding reversal or cancellation document exists.Reversal (Cancellation) DocumentThis is a cancellation or reversal document and a corresponding cancelled document exists.
returnsDocumentStatus
- Specifies the status of the document item.public void setReturnsDocumentApprovalStatus(@Nullable String returnsDocumentApprovalStatus)
Original property name from the Odata EDM: ReturnsDocumentApprovalStatus
returnsDocumentApprovalStatus
- Approval Status of Returns Processpublic void setReturnsReferenceDocumentType(@Nullable String returnsReferenceDocumentType)
Original property name from the Odata EDM: ReturnsReferenceDocumentType
returnsReferenceDocumentType
- Specifies the returns document type, such as a returns order, goods movement, or credit memo.public void setReturnsReferenceDocument(@Nullable String returnsReferenceDocument)
Original property name from the Odata EDM: ReturnsReferenceDocument
returnsReferenceDocument
- Specifies the document number of a returns document.public void setReturnsReferenceDocumentItem(@Nullable String returnsReferenceDocumentItem)
Original property name from the Odata EDM: ReturnsReferenceDocumentItem
returnsReferenceDocumentItem
- Specifies an item of the displayed document.public void setRetsMgmtProcStepExecStatus(@Nullable String retsMgmtProcStepExecStatus)
Original property name from the Odata EDM: RetsMgmtProcStepExecStatus
retsMgmtProcStepExecStatus
- Execution Step Statusprotected String getEntityCollection()
getEntityCollection
in class VdmEntity<CustomerReturnProcessStep>
@Nonnull protected Map<String,Object> getKey()
getKey
in class VdmObject<CustomerReturnProcessStep>
@Nonnull protected Map<String,Object> toMapOfFields()
toMapOfFields
in class VdmObject<CustomerReturnProcessStep>
protected void fromMap(Map<String,Object> inputValues)
fromMap
in class VdmObject<CustomerReturnProcessStep>
@Nonnull public static <T> CustomerReturnProcessStepField<T> field(@Nonnull String fieldName, @Nonnull Class<T> fieldType)
T
- The type of the extension field when performing value comparisons.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.@Nonnull public static <T,DomainT> CustomerReturnProcessStepField<T> field(@Nonnull String fieldName, @Nonnull TypeConverter<T,DomainT> typeConverter)
T
- The type of the extension field when performing value comparisons.DomainT
- The type of the extension field as returned by the OData service.typeConverter
- A TypeConverterfieldName
- The name of the extension field as returned by the OData service.@Nullable public HttpDestinationProperties getDestinationForFetch()
VdmEntity
getDestinationForFetch
in class VdmEntity<CustomerReturnProcessStep>
protected void setServicePathForFetch(@Nullable String servicePathForFetch)
VdmEntity
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.
setServicePathForFetch
in class VdmEntity<CustomerReturnProcessStep>
public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
VdmEntity
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.
attachToService
in class VdmEntity<CustomerReturnProcessStep>
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.protected String getDefaultServicePath()
getDefaultServicePath
in class VdmEntity<CustomerReturnProcessStep>
@Nonnull protected Map<String,Object> toMapOfNavigationProperties()
toMapOfNavigationProperties
in class VdmObject<CustomerReturnProcessStep>
@Nullable public CustomerReturn fetchCustomerReturn() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
null
if an entity is not associated.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.@Nullable public CustomerReturn getCustomerReturnOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
If the navigation property to_CustomerReturn of a queried CustomerReturnProcessStep 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.@Nonnull public io.vavr.control.Option<CustomerReturn> getCustomerReturnIfPresent()
If the navigation property for an entity CustomerReturnProcessStep has not been resolved yet, this method
will not query further information. Instead its Option
result state will be
empty
.
Option
with result state
empty
is returned.public void setCustomerReturn(CustomerReturn value)
value
- New CustomerReturn entity.@Nullable public CustomerReturnItem fetchCustomerReturnItem() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
Please note: This method will not cache or persist the query results.
null
if an entity is not associated.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.@Nullable public CustomerReturnItem getCustomerReturnItemOrFetch() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
If the navigation property to_CustomerReturnItem of a queried CustomerReturnProcessStep 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.@Nonnull public io.vavr.control.Option<CustomerReturnItem> getCustomerReturnItemIfPresent()
If the navigation property for an entity CustomerReturnProcessStep has not been resolved yet, this method
will not query further information. Instead its Option
result state will be
empty
.
Option
with result state
empty
is returned.public void setCustomerReturnItem(CustomerReturnItem value)
value
- New CustomerReturnItem entity.public static CustomerReturnProcessStep.CustomerReturnProcessStepBuilder builder()
@Nullable public String getRetsMgmtProcess()
Original property name from the Odata EDM: RetsMgmtProcess
@Nullable public String getRetsMgmtProcessItem()
Original property name from the Odata EDM: RetsMgmtProcessItem
@Nullable public String getRetsMgmtProcItmQtySplit()
Original property name from the Odata EDM: RetsMgmtProcItmQtySplit
The quantity of a specific returns item may be split up during the returns process, for example, because partial quantities of the returns item were assigned to different follow-up activities. These partial quantities are identified internally with a split ID.
@Nullable public String getRetsMgmtProcessStep()
Original property name from the Odata EDM: RetsMgmtProcessStep
The advanced returns sequence Customer return received directly comprises the following steps:0001 Create Returns Order0021 Inbound Delivery0031 Goods Receipt0041 Inspection
@Nullable public String getReturnsDocumentType()
Original property name from the Odata EDM: ReturnsDocumentType
@Nullable public String getReturnsDocument()
Original property name from the Odata EDM: ReturnsDocument
@Nullable public String getReturnsDocumentItem()
Original property name from the Odata EDM: ReturnsDocumentItem
@Nullable public String getReturnsDocumentStatus()
Original property name from the Odata EDM: ReturnsDocumentStatus
A document item can have the following statuses:ActiveThe document item has been created without errors.Deletion Flag SetThe document item has been deleted.Document Was CancelledThe document item has been cancelled and a corresponding reversal or cancellation document exists.Reversal (Cancellation) DocumentThis is a cancellation or reversal document and a corresponding cancelled document exists.
@Nullable public String getReturnsDocumentApprovalStatus()
Original property name from the Odata EDM: ReturnsDocumentApprovalStatus
@Nullable public String getReturnsReferenceDocumentType()
Original property name from the Odata EDM: ReturnsReferenceDocumentType
@Nullable public String getReturnsReferenceDocument()
Original property name from the Odata EDM: ReturnsReferenceDocument
@Nullable public String getReturnsReferenceDocumentItem()
Original property name from the Odata EDM: ReturnsReferenceDocumentItem
@Nullable public String getRetsMgmtProcStepExecStatus()
Original property name from the Odata EDM: RetsMgmtProcStepExecStatus
public String toString()
toString
in class VdmObject<CustomerReturnProcessStep>
public boolean equals(Object o)
equals
in class VdmObject<CustomerReturnProcessStep>
protected boolean canEqual(Object other)
canEqual
in class VdmObject<CustomerReturnProcessStep>
public int hashCode()
hashCode
in class VdmObject<CustomerReturnProcessStep>
Copyright © 2020 SAP SE. All rights reserved.