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

Class CustomerReturnItemPartner

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.readcustomerreturns.CustomerReturnItemPartner

public class CustomerReturnItemPartner
extends VdmEntity<CustomerReturnItemPartner>

Customer Return Item Partner (API)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomerReturnItemPartner.CustomerReturnItemPartnerBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static CustomerReturnItemPartnerSelectable	ALL_FIELDS Selector for all available fields of CustomerReturnItemPartner.
static CustomerReturnItemPartnerField<String>	CONTACT_PERSON Use with available fluent helpers to apply the ContactPerson field to query operations.
static CustomerReturnItemPartnerField<String>	CUSTOMER Use with available fluent helpers to apply the Customer field to query operations.
static CustomerReturnItemPartnerField<String>	CUSTOMER_RETURN Use with available fluent helpers to apply the CustomerReturn field to query operations.
static CustomerReturnItemPartnerField<String>	CUSTOMER_RETURN_ITEM Use with available fluent helpers to apply the CustomerReturnItem field to query operations.
static CustomerReturnItemPartnerField<String>	PARTNER_FUNCTION Use with available fluent helpers to apply the PartnerFunction field to query operations.
static CustomerReturnItemPartnerField<String>	PERSONNEL Use with available fluent helpers to apply the Personnel field to query operations.
static CustomerReturnItemPartnerField<String>	SUPPLIER Use with available fluent helpers to apply the Supplier field to query operations.
static CustomerReturnItemPartnerLink<CustomerReturn>	TO_CUSTOMER_RETURN Use with available fluent helpers to apply the to_CustomerReturn navigation property to query operations.
static CustomerReturnItemPartnerLink<CustomerReturnItem>	TO_CUSTOMER_RETURN_ITEM Use with available fluent helpers to apply the to_CustomerReturnItem navigation property to query operations.

Constructor Summary

Constructors

Constructor and Description
CustomerReturnItemPartner()
CustomerReturnItemPartner(String customerReturn, String customerReturnItem, String partnerFunction, String customer, String supplier, String personnel, String contactPerson, ErpConfigContext erpConfigContext, CustomerReturn toCustomerReturn, CustomerReturnItem toCustomerReturnItem)

Method Summary

Methods

Modifier and Type	Method and Description
static CustomerReturnItemPartner.CustomerReturnItemPartnerBuilder	builder()
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> CustomerReturnItemPartnerField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
String	getContactPerson() Constraints: Not nullable, Maximum length: 10
String	getCustomer() Constraints: Not nullable, Maximum length: 10
String	getCustomerReturn() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getCustomerReturnItem() (Key Field) Constraints: Not nullable, Maximum length: 6
CustomerReturnItem	getCustomerReturnItemOrFetch() Retrieval of associated CustomerReturnItem entity (one to one).
com.google.common.base.Optional<CustomerReturnItem>	getCustomerReturnItemOrNull() Retrieval of associated CustomerReturnItem entity (one to one).
CustomerReturn	getCustomerReturnOrFetch() Retrieval of associated CustomerReturn entity (one to one).
com.google.common.base.Optional<CustomerReturn>	getCustomerReturnOrNull() Retrieval of associated CustomerReturn entity (one to one).
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
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<CustomerReturnItemPartner>	getType()
int	hashCode()
void	setContactPerson(String contactPerson) Constraints: Not nullable, Maximum length: 10
void	setCustomer(String customer) Constraints: Not nullable, Maximum length: 10
void	setCustomerReturn(CustomerReturn value) Overwrites the associated CustomerReturn entity for the loaded navigation property to_CustomerReturn.
void	setCustomerReturn(String value) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setCustomerReturnItem(CustomerReturnItem value) Overwrites the associated CustomerReturnItem entity for the loaded navigation property to_CustomerReturnItem.
void	setCustomerReturnItem(String value) (Key Field) Constraints: Not nullable, Maximum length: 6
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setPartnerFunction(String partnerFunction) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setPersonnel(String personnel) Constraints: Not nullable, Maximum length: 8
void	setSupplier(String supplier) Constraints: Not nullable, Maximum length: 10
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 CustomerReturnItemPartnerSelectable ALL_FIELDS

Selector for all available fields of CustomerReturnItemPartner.

CUSTOMER_RETURN

public static final CustomerReturnItemPartnerField<String> CUSTOMER_RETURN

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

CUSTOMER_RETURN_ITEM

public static final CustomerReturnItemPartnerField<String> CUSTOMER_RETURN_ITEM

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

PARTNER_FUNCTION

public static final CustomerReturnItemPartnerField<String> PARTNER_FUNCTION

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

CUSTOMER

public static final CustomerReturnItemPartnerField<String> CUSTOMER

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

SUPPLIER

public static final CustomerReturnItemPartnerField<String> SUPPLIER

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

PERSONNEL

public static final CustomerReturnItemPartnerField<String> PERSONNEL

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

CONTACT_PERSON

public static final CustomerReturnItemPartnerField<String> CONTACT_PERSON

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

TO_CUSTOMER_RETURN

public static final CustomerReturnItemPartnerLink<CustomerReturn> TO_CUSTOMER_RETURN

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

TO_CUSTOMER_RETURN_ITEM

public static final CustomerReturnItemPartnerLink<CustomerReturnItem> TO_CUSTOMER_RETURN_ITEM

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

Constructor Detail

CustomerReturnItemPartner

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

CustomerReturnItemPartner

@ConstructorProperties(value={"customerReturn","customerReturnItem","partnerFunction","customer","supplier","personnel","contactPerson","erpConfigContext","toCustomerReturn","toCustomerReturnItem"})
@Generated(value="lombok")
public CustomerReturnItemPartner(@Nullable
                                                                   String customerReturn,
                                                                   @Nullable
                                                                   String customerReturnItem,
                                                                   @Nullable
                                                                   String partnerFunction,
                                                                   @Nullable
                                                                   String customer,
                                                                   @Nullable
                                                                   String supplier,
                                                                   @Nullable
                                                                   String personnel,
                                                                   @Nullable
                                                                   String contactPerson,
                                                                   @Nullable
                                                                   ErpConfigContext erpConfigContext,
                                                                   @Nullable
                                                                   CustomerReturn toCustomerReturn,
                                                                   @Nullable
                                                                   CustomerReturnItem toCustomerReturnItem)

Method Detail

getType

public Class<CustomerReturnItemPartner> getType()

Specified by:

getType in class VdmObject<CustomerReturnItemPartner>

Returns:

The class of this object.

field

public static <T> CustomerReturnItemPartnerField<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.

fetchCustomerReturn

public CustomerReturn fetchCustomerReturn()
                                   throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getCustomerReturnOrFetch

public CustomerReturn getCustomerReturnOrFetch()
                                        throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated CustomerReturn entity (one to one).

If the navigation property to_CustomerReturn of a queried CustomerReturnItemPartner 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 CustomerReturn 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.

getCustomerReturnOrNull

public com.google.common.base.Optional<CustomerReturn> getCustomerReturnOrNull()

Retrieval of associated CustomerReturn entity (one to one).

If the navigation property to_CustomerReturn for an entity CustomerReturnItemPartner 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_CustomerReturn is already loaded, the result will contain the CustomerReturn entity. If not, a null value state is returned.

setCustomerReturn

public void setCustomerReturn(CustomerReturn value)

Overwrites the associated CustomerReturn entity for the loaded navigation property to_CustomerReturn.

Parameters:

value - New CustomerReturn entity.

setCustomerReturn

public void setCustomerReturn(String value)

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

Parameters:

value - customerReturn

fetchCustomerReturnItem

public CustomerReturnItem fetchCustomerReturnItem()
                                           throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getCustomerReturnItemOrFetch

public CustomerReturnItem getCustomerReturnItemOrFetch()
                                                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated CustomerReturnItem entity (one to one).

If the navigation property to_CustomerReturnItem of a queried CustomerReturnItemPartner 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 CustomerReturnItem 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.

getCustomerReturnItemOrNull

public com.google.common.base.Optional<CustomerReturnItem> getCustomerReturnItemOrNull()

Retrieval of associated CustomerReturnItem entity (one to one).

If the navigation property to_CustomerReturnItem for an entity CustomerReturnItemPartner 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_CustomerReturnItem is already loaded, the result will contain the CustomerReturnItem entity. If not, a null value state is returned.

setCustomerReturnItem

public void setCustomerReturnItem(CustomerReturnItem value)

Overwrites the associated CustomerReturnItem entity for the loaded navigation property to_CustomerReturnItem.

Parameters:

value - New CustomerReturnItem entity.

setCustomerReturnItem

public void setCustomerReturnItem(String value)

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

Parameters:

value - customerReturnItem

builder

@Generated(value="lombok")
public static CustomerReturnItemPartner.CustomerReturnItemPartnerBuilder builder()

getCustomerReturn

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

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

Returns:

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

getCustomerReturnItem

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

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

Returns:

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

getPartnerFunction

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

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

Returns:

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

getCustomer

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

Constraints: Not nullable, Maximum length: 10

Returns:

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

getSupplier

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

Constraints: Not nullable, Maximum length: 10

Returns:

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

getPersonnel

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

Constraints: Not nullable, Maximum length: 8

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
@Generated(value="lombok")
public String getContactPerson()

Constraints: Not nullable, Maximum length: 10

Returns:

The number that uniquely identifies the contact person.

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.

setPartnerFunction

@Generated(value="lombok")
public void setPartnerFunction(@Nullable
                                     String partnerFunction)

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

Parameters:

partnerFunction -

setCustomer

@Generated(value="lombok")
public void setCustomer(@Nullable
                              String customer)

Constraints: Not nullable, Maximum length: 10

Parameters:

customer -

setSupplier

@Generated(value="lombok")
public void setSupplier(@Nullable
                              String supplier)

Constraints: Not nullable, Maximum length: 10

Parameters:

supplier -

setPersonnel

@Generated(value="lombok")
public void setPersonnel(@Nullable
                               String personnel)

Constraints: Not nullable, Maximum length: 8

Parameters:

personnel -

setContactPerson

@Generated(value="lombok")
public void setContactPerson(@Nullable
                                   String contactPerson)

Constraints: Not nullable, Maximum length: 10

Parameters:

contactPerson -

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

equals

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

Overrides:

equals in class VdmObject<CustomerReturnItemPartner>

hashCode

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

Overrides:

hashCode in class VdmObject<CustomerReturnItemPartner>