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

Class CreditMemoReqItemPartner

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.creditmemorequest.CreditMemoReqItemPartner

public class CreditMemoReqItemPartner
extends VdmEntity<CreditMemoReqItemPartner>

Credit Memo Request Item Partner (API)

Original entity name from the Odata EDM: A_CreditMemoReqItemPartnerType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static CreditMemoReqItemPartnerSelectable	ALL_FIELDS Selector for all available fields of CreditMemoReqItemPartner.
static CreditMemoReqItemPartnerField<String>	CONTACT_PERSON Use with available fluent helpers to apply the ContactPerson field to query operations.
static CreditMemoReqItemPartnerField<String>	CREDIT_MEMO_REQUEST Use with available fluent helpers to apply the CreditMemoRequest field to query operations.
static CreditMemoReqItemPartnerField<String>	CREDIT_MEMO_REQUEST_ITEM Use with available fluent helpers to apply the CreditMemoRequestItem field to query operations.
static CreditMemoReqItemPartnerField<String>	CUSTOMER Use with available fluent helpers to apply the Customer field to query operations.
static CreditMemoReqItemPartnerField<String>	PARTNER_FUNCTION Use with available fluent helpers to apply the PartnerFunction field to query operations.
static CreditMemoReqItemPartnerField<String>	PERSONNEL Use with available fluent helpers to apply the Personnel field to query operations.
static CreditMemoReqItemPartnerField<String>	SUPPLIER Use with available fluent helpers to apply the Supplier field to query operations.
static CreditMemoReqItemPartnerOneToOneLink<CreditMemoRequest>	TO_CREDIT_MEMO_REQUEST Use with available fluent helpers to apply the to_CreditMemoRequest navigation property to query operations.
static CreditMemoReqItemPartnerOneToOneLink<CreditMemoRequestItem>	TO_CREDIT_MEMO_REQUEST_ITEM Use with available fluent helpers to apply the to_CreditMemoRequestItem navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
CreditMemoReqItemPartner()
CreditMemoReqItemPartner(String creditMemoRequest, String creditMemoRequestItem, String partnerFunction, String customer, String supplier, String personnel, String contactPerson, CreditMemoRequest toCreditMemoRequest, CreditMemoRequestItem toCreditMemoRequestItem)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
static CreditMemoReqItemPartner.CreditMemoReqItemPartnerBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
CreditMemoRequest	fetchCreditMemoRequest() Fetches the CreditMemoRequest entity (one to one) associated with this entity.
CreditMemoRequestItem	fetchCreditMemoRequestItem() Fetches the CreditMemoRequestItem entity (one to one) associated with this entity.
static <T> CreditMemoReqItemPartnerField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> CreditMemoReqItemPartnerField<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)
String	getContactPerson() Constraints: Not nullable, Maximum length: 10
String	getCreditMemoRequest() (Key Field) Constraints: Not nullable, Maximum length: 10
Optional<CreditMemoRequest>	getCreditMemoRequestIfPresent() Retrieval of associated CreditMemoRequest entity (one to one).
String	getCreditMemoRequestItem() (Key Field) Constraints: Not nullable, Maximum length: 6
Optional<CreditMemoRequestItem>	getCreditMemoRequestItemIfPresent() Retrieval of associated CreditMemoRequestItem entity (one to one).
CreditMemoRequestItem	getCreditMemoRequestItemOrFetch() Retrieval of associated CreditMemoRequestItem entity (one to one).
CreditMemoRequest	getCreditMemoRequestOrFetch() Retrieval of associated CreditMemoRequest entity (one to one).
String	getCustomer() Constraints: Not nullable, Maximum length: 10
protected String	getDefaultServicePath()
protected String	getEntityCollection()
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
protected Map<String,Object>	getKey()
String	getPartnerFunction() (Key Field) Constraints: Not nullable, Maximum length: 2
String	getPersonnel() Constraints: Not nullable, Maximum length: 8
String	getSupplier() Constraints: Not nullable, Maximum length: 10
Class<CreditMemoReqItemPartner>	getType()
int	hashCode()
void	setContactPerson(String contactPerson) Constraints: Not nullable, Maximum length: 10
void	setCreditMemoRequest(CreditMemoRequest value) Overwrites the associated CreditMemoRequest entity for the loaded navigation property to_CreditMemoRequest.
void	setCreditMemoRequest(String creditMemoRequest) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setCreditMemoRequestItem(CreditMemoRequestItem value) Overwrites the associated CreditMemoRequestItem entity for the loaded navigation property to_CreditMemoRequestItem.
void	setCreditMemoRequestItem(String creditMemoRequestItem) (Key Field) Constraints: Not nullable, Maximum length: 6
void	setCustomer(String customer) Constraints: Not nullable, Maximum length: 10
void	setErpConfigContext(ErpConfigContext erpConfigContext) Deprecated. Use attachToService(String, ErpConfigContext) instead.
void	setPartnerFunction(String partnerFunction) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setPersonnel(String personnel) Constraints: Not nullable, Maximum length: 8
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setSupplier(String supplier) Constraints: Not nullable, Maximum length: 10
protected Map<String,Object>	toMapOfFields()
protected Map<String,Object>	toMapOfNavigationProperties()
String	toString()

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

getEndpointUrl, getServicePathForFetch, getVersionIdentifier, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.s4hana.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 CreditMemoReqItemPartnerSelectable ALL_FIELDS

Selector for all available fields of CreditMemoReqItemPartner.

CREDIT_MEMO_REQUEST

public static final CreditMemoReqItemPartnerField<String> CREDIT_MEMO_REQUEST

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

CREDIT_MEMO_REQUEST_ITEM

public static final CreditMemoReqItemPartnerField<String> CREDIT_MEMO_REQUEST_ITEM

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

PARTNER_FUNCTION

public static final CreditMemoReqItemPartnerField<String> PARTNER_FUNCTION

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

CUSTOMER

public static final CreditMemoReqItemPartnerField<String> CUSTOMER

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

SUPPLIER

public static final CreditMemoReqItemPartnerField<String> SUPPLIER

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

PERSONNEL

public static final CreditMemoReqItemPartnerField<String> PERSONNEL

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

CONTACT_PERSON

public static final CreditMemoReqItemPartnerField<String> CONTACT_PERSON

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

TO_CREDIT_MEMO_REQUEST

public static final CreditMemoReqItemPartnerOneToOneLink<CreditMemoRequest> TO_CREDIT_MEMO_REQUEST

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

TO_CREDIT_MEMO_REQUEST_ITEM

public static final CreditMemoReqItemPartnerOneToOneLink<CreditMemoRequestItem> TO_CREDIT_MEMO_REQUEST_ITEM

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

Constructor Detail

CreditMemoReqItemPartner

public CreditMemoReqItemPartner()

CreditMemoReqItemPartner

public CreditMemoReqItemPartner(@Nullable
                                String creditMemoRequest,
                                @Nullable
                                String creditMemoRequestItem,
                                @Nullable
                                String partnerFunction,
                                @Nullable
                                String customer,
                                @Nullable
                                String supplier,
                                @Nullable
                                String personnel,
                                @Nullable
                                String contactPerson,
                                @Nullable
                                CreditMemoRequest toCreditMemoRequest,
                                @Nullable
                                CreditMemoRequestItem toCreditMemoRequestItem)

Method Detail

getType

@Nonnull
public Class<CreditMemoReqItemPartner> getType()

Specified by:

getType in class VdmObject<CreditMemoReqItemPartner>

Returns:

The class of this object.

setCreditMemoRequest

public void setCreditMemoRequest(@Nullable
                                 String creditMemoRequest)

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

Original property name from the Odata EDM: CreditMemoRequest

Parameters:

creditMemoRequest - The number that uniquely identifies the sales, delivery, or billing document.

setCreditMemoRequestItem

public void setCreditMemoRequestItem(@Nullable
                                     String creditMemoRequestItem)

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

Original property name from the Odata EDM: CreditMemoRequestItem

Parameters:

creditMemoRequestItem - The number that uniquely identifies the item in the sales, shipping, or billing document.

setPartnerFunction

public void setPartnerFunction(@Nullable
                               String partnerFunction)

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

Original property name from the Odata EDM: PartnerFunction

Parameters:

partnerFunction - The abbreviated form of the name that identifies the partner function.

setCustomer

public void setCustomer(@Nullable
                        String customer)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: Customer

Parameters:

customer - Gives an alphanumeric key, which clearly identifies the customer or vendor in the SAP system.

setSupplier

public void setSupplier(@Nullable
                        String supplier)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: Supplier

Parameters:

supplier - Specifies an alphanumeric key that uniquely identifies the supplier in the SAP system.

setPersonnel

public void setPersonnel(@Nullable
                         String personnel)

Constraints: Not nullable, Maximum length: 8

Original property name from the Odata EDM: Personnel

Parameters:

personnel - The personnel number is the only feature within a client which is unique to an employee. You have to enter a personnel number before you can display and maintain an employee's master data and time data.

setContactPerson

public void setContactPerson(@Nullable
                             String contactPerson)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: ContactPerson

Parameters:

contactPerson - The number that uniquely identifies the contact person.

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<CreditMemoReqItemPartner>

getKey

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

Overrides:

getKey in class VdmObject<CreditMemoReqItemPartner>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<CreditMemoReqItemPartner>

fromMap

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

Overrides:

fromMap in class VdmObject<CreditMemoReqItemPartner>

field

@Nonnull
public static <T> CreditMemoReqItemPartnerField<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> CreditMemoReqItemPartnerField<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.

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Description copied from class: VdmEntity

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities). New ERP configuration context to apply to this entity

Overrides:

getErpConfigContext in class VdmEntity<CreditMemoReqItemPartner>

Returns:

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

setErpConfigContext

@Deprecated
public void setErpConfigContext(@Nullable
                                            ErpConfigContext erpConfigContext)

Deprecated. Use attachToService(String, ErpConfigContext) instead.

Description copied from class: VdmEntity

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

Overrides:

setErpConfigContext in class VdmEntity<CreditMemoReqItemPartner>

Parameters:

erpConfigContext - New ERP configuration context to apply to this entity

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

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nullable
                            ErpConfigContext configContext)

Description copied from class: VdmEntity

Sets the service path and ERP configuration context for the fetch commands of this entity. Ensures that both are set to some value by using defaults if null values are provided in the arguments. Existing values are preserved if null values are provided in the arguments. 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<CreditMemoReqItemPartner>

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.

configContext - Optional parameter. New ERP configuration context to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the ERP configuration context has never been set, then the ERP configuration context will be set to a new instance of ErpConfigContext.

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<CreditMemoReqItemPartner>

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<CreditMemoReqItemPartner>

fetchCreditMemoRequest

@Nullable
public CreditMemoRequest fetchCreditMemoRequest()
                                                   throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getCreditMemoRequestOrFetch

@Nullable
public CreditMemoRequest getCreditMemoRequestOrFetch()
                                                        throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated CreditMemoRequest entity (one to one). This corresponds to the OData navigation property to_CreditMemoRequest.

If the navigation property to_CreditMemoRequest of a queried CreditMemoReqItemPartner 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 CreditMemoRequest 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.

getCreditMemoRequestIfPresent

@Nonnull
public Optional<CreditMemoRequest> getCreditMemoRequestIfPresent()

Retrieval of associated CreditMemoRequest entity (one to one). This corresponds to the OData navigation property to_CreditMemoRequest.

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

Returns:

If the information for navigation property to_CreditMemoRequest is already loaded, the result will contain the CreditMemoRequest entity. If not, an Optional with result state empty is returned.

setCreditMemoRequest

public void setCreditMemoRequest(CreditMemoRequest value)

Overwrites the associated CreditMemoRequest entity for the loaded navigation property to_CreditMemoRequest.

Parameters:

value - New CreditMemoRequest entity.

fetchCreditMemoRequestItem

@Nullable
public CreditMemoRequestItem fetchCreditMemoRequestItem()
                                                           throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getCreditMemoRequestItemOrFetch

@Nullable
public CreditMemoRequestItem getCreditMemoRequestItemOrFetch()
                                                                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated CreditMemoRequestItem entity (one to one). This corresponds to the OData navigation property to_CreditMemoRequestItem.

If the navigation property to_CreditMemoRequestItem of a queried CreditMemoReqItemPartner 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 CreditMemoRequestItem 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.

getCreditMemoRequestItemIfPresent

@Nonnull
public Optional<CreditMemoRequestItem> getCreditMemoRequestItemIfPresent()

Retrieval of associated CreditMemoRequestItem entity (one to one). This corresponds to the OData navigation property to_CreditMemoRequestItem.

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

Returns:

If the information for navigation property to_CreditMemoRequestItem is already loaded, the result will contain the CreditMemoRequestItem entity. If not, an Optional with result state empty is returned.

setCreditMemoRequestItem

public void setCreditMemoRequestItem(CreditMemoRequestItem value)

Overwrites the associated CreditMemoRequestItem entity for the loaded navigation property to_CreditMemoRequestItem.

Parameters:

value - New CreditMemoRequestItem entity.

builder

public static CreditMemoReqItemPartner.CreditMemoReqItemPartnerBuilder builder()

getCreditMemoRequest

@Nullable
public String getCreditMemoRequest()

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

Original property name from the Odata EDM: CreditMemoRequest

Returns:

The number that uniquely identifies the sales, delivery, or billing document.

getCreditMemoRequestItem

@Nullable
public String getCreditMemoRequestItem()

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

Original property name from the Odata EDM: CreditMemoRequestItem

Returns:

The number that uniquely identifies the item in the sales, shipping, or billing document.

getPartnerFunction

@Nullable
public String getPartnerFunction()

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

Original property name from the Odata EDM: PartnerFunction

Returns:

The abbreviated form of the name that identifies the partner function.

getCustomer

@Nullable
public String getCustomer()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: Customer

Returns:

Gives an alphanumeric key, which clearly identifies the customer or vendor in the SAP system.

getSupplier

@Nullable
public String getSupplier()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: Supplier

Returns:

Specifies an alphanumeric key that uniquely identifies the supplier in the SAP system.

getPersonnel

@Nullable
public String getPersonnel()

Constraints: Not nullable, Maximum length: 8

Original property name from the Odata EDM: Personnel

Returns:

The personnel number is the only feature within a client which is unique to an employee. You have to enter a personnel number before you can display and maintain an employee's master data and time data.

getContactPerson

@Nullable
public String getContactPerson()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: ContactPerson

Returns:

The number that uniquely identifies the contact person.

toString

public String toString()

Overrides:

toString in class VdmObject<CreditMemoReqItemPartner>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<CreditMemoReqItemPartner>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<CreditMemoReqItemPartner>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<CreditMemoReqItemPartner>