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

Class SalesOrderHeaderPartner

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesorder.SalesOrderHeaderPartner

public class SalesOrderHeaderPartner
extends VdmEntity<SalesOrderHeaderPartner>

Sales Order Header Partner (API)

Original entity name from the Odata EDM: A_SalesOrderHeaderPartnerType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SalesOrderHeaderPartner.SalesOrderHeaderPartnerBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static SalesOrderHeaderPartnerSelectable	ALL_FIELDS Selector for all available fields of SalesOrderHeaderPartner.
static SalesOrderHeaderPartnerField<String>	CONTACT_PERSON Use with available fluent helpers to apply the ContactPerson field to query operations.
static SalesOrderHeaderPartnerField<String>	CUSTOMER Use with available fluent helpers to apply the Customer field to query operations.
static SalesOrderHeaderPartnerField<String>	PARTNER_FUNCTION Use with available fluent helpers to apply the PartnerFunction field to query operations.
static SalesOrderHeaderPartnerField<String>	PERSONNEL Use with available fluent helpers to apply the Personnel field to query operations.
static SalesOrderHeaderPartnerField<String>	SALES_ORDER Use with available fluent helpers to apply the SalesOrder field to query operations.
static SalesOrderHeaderPartnerField<String>	SUPPLIER Use with available fluent helpers to apply the Supplier field to query operations.
static SalesOrderHeaderPartnerLink<SalesOrder>	TO_SALES_ORDER Use with available fluent helpers to apply the to_SalesOrder 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
SalesOrderHeaderPartner()
SalesOrderHeaderPartner(String salesOrder, String partnerFunction, String customer, String supplier, String personnel, String contactPerson, ErpConfigContext erpConfigContext, SalesOrder toSalesOrder)

Method Summary

Modifier and Type	Method and Description
static SalesOrderHeaderPartner.SalesOrderHeaderPartnerBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
SalesOrder	fetchSalesOrder() Fetches the SalesOrder entity (one to one) associated with this entity.
static <T> SalesOrderHeaderPartnerField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> SalesOrderHeaderPartnerField<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	getCustomer() Constraints: Not nullable, Maximum length: 10
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	getSalesOrder() (Key Field) Constraints: Not nullable, Maximum length: 10
Optional<SalesOrder>	getSalesOrderIfPresent() Retrieval of associated SalesOrder entity (one to one).
SalesOrder	getSalesOrderOrFetch() Retrieval of associated SalesOrder entity (one to one).
String	getSupplier() Constraints: Not nullable, Maximum length: 10
Class<SalesOrderHeaderPartner>	getType()
int	hashCode()
void	setContactPerson(String contactPerson) Constraints: Not nullable, Maximum length: 10
void	setCustomer(String customer) Constraints: Not nullable, Maximum length: 10
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	setSalesOrder(SalesOrder value) Overwrites the associated SalesOrder entity for the loaded navigation property to_SalesOrder.
void	setSalesOrder(String salesOrder) (Key Field) Constraints: Not nullable, Maximum length: 10
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, setServicePathForFetch, 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 SalesOrderHeaderPartnerSelectable ALL_FIELDS

Selector for all available fields of SalesOrderHeaderPartner.

SALES_ORDER

public static final SalesOrderHeaderPartnerField<String> SALES_ORDER

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

PARTNER_FUNCTION

public static final SalesOrderHeaderPartnerField<String> PARTNER_FUNCTION

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

CUSTOMER

public static final SalesOrderHeaderPartnerField<String> CUSTOMER

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

SUPPLIER

public static final SalesOrderHeaderPartnerField<String> SUPPLIER

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

PERSONNEL

public static final SalesOrderHeaderPartnerField<String> PERSONNEL

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

CONTACT_PERSON

public static final SalesOrderHeaderPartnerField<String> CONTACT_PERSON

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

TO_SALES_ORDER

public static final SalesOrderHeaderPartnerLink<SalesOrder> TO_SALES_ORDER

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

Constructor Detail

SalesOrderHeaderPartner

public SalesOrderHeaderPartner()

SalesOrderHeaderPartner

public SalesOrderHeaderPartner(@Nullable
                               String salesOrder,
                               @Nullable
                               String partnerFunction,
                               @Nullable
                               String customer,
                               @Nullable
                               String supplier,
                               @Nullable
                               String personnel,
                               @Nullable
                               String contactPerson,
                               @Nullable
                               ErpConfigContext erpConfigContext,
                               @Nullable
                               SalesOrder toSalesOrder)

Method Detail

getType

public Class<SalesOrderHeaderPartner> getType()

Specified by:

getType in class VdmObject<SalesOrderHeaderPartner>

Returns:

The class of this object.

setSalesOrder

public void setSalesOrder(@Nullable
                          String salesOrder)

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

Original property name from the Odata EDM: SalesOrder

Parameters:

salesOrder - Sales Order

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

getKey

protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<SalesOrderHeaderPartner>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<SalesOrderHeaderPartner>

fromMap

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

Overrides:

fromMap in class VdmObject<SalesOrderHeaderPartner>

field

@Nonnull
public static <T> SalesOrderHeaderPartnerField<T> field(@Nonnull
                                                                  String fieldName,
                                                                  @Nonnull
                                                                  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.

field

@Nonnull
public static <T,DomainT> SalesOrderHeaderPartnerField<T> field(@Nonnull
                                                                          String fieldName,
                                                                          @Nonnull
                                                                          TypeConverter<T,DomainT> typeConverter)

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

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.

toMapOfNavigationProperties

protected Map<String,Object> toMapOfNavigationProperties()

Overrides:

toMapOfNavigationProperties in class VdmObject<SalesOrderHeaderPartner>

fetchSalesOrder

public SalesOrder fetchSalesOrder()
                           throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getSalesOrderOrFetch

public SalesOrder getSalesOrderOrFetch()
                                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated SalesOrder entity (one to one). This corresponds to the OData navigation property to_SalesOrder.

If the navigation property to_SalesOrder of a queried SalesOrderHeaderPartner 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 SalesOrder 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.

getSalesOrderIfPresent

public Optional<SalesOrder> getSalesOrderIfPresent()

Retrieval of associated SalesOrder entity (one to one). This corresponds to the OData navigation property to_SalesOrder.

If the navigation property for an entity SalesOrderHeaderPartner 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_SalesOrder is already loaded, the result will contain the SalesOrder entity. If not, an Optional with result state empty is returned.

setSalesOrder

public void setSalesOrder(SalesOrder value)

Overwrites the associated SalesOrder entity for the loaded navigation property to_SalesOrder.

Parameters:

value - New SalesOrder entity.

builder

public static SalesOrderHeaderPartner.SalesOrderHeaderPartnerBuilder builder()

getSalesOrder

@Nullable
public String getSalesOrder()

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

Original property name from the Odata EDM: SalesOrder

Returns:

Sales Order

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.

getErpConfigContext

@Nullable
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.

setErpConfigContext

public void setErpConfigContext(@Nullable
                                ErpConfigContext erpConfigContext)

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

Overrides:

setErpConfigContext in class VdmEntity<SalesOrderHeaderPartner>

Parameters:

erpConfigContext -

toString

public String toString()

Overrides:

toString in class VdmObject<SalesOrderHeaderPartner>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<SalesOrderHeaderPartner>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<SalesOrderHeaderPartner>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<SalesOrderHeaderPartner>