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

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

public class SalesOrderHeaderPartner
extends VdmEntity<SalesOrderHeaderPartner>

Sales Order Header Partner (API)

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.

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()
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.
String	getContactPerson() Constraints: Not nullable, Maximum length: 10
String	getCustomer() Constraints: Not nullable, Maximum length: 10
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	getSalesOrder() (Key Field) Constraints: Not nullable, Maximum length: 10
SalesOrder	getSalesOrderOrFetch() Retrieval of associated SalesOrder entity (one to one).
com.google.common.base.Optional<SalesOrder>	getSalesOrderOrNull() 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 value) (Key Field) Constraints: Not nullable, Maximum length: 10
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 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

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

SalesOrderHeaderPartner

@ConstructorProperties(value={"salesOrder","partnerFunction","customer","supplier","personnel","contactPerson","erpConfigContext","toSalesOrder"})
 @Generated(value="lombok")
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.

field

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

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).

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.

getSalesOrderOrNull

public com.google.common.base.Optional<SalesOrder> getSalesOrderOrNull()

Retrieval of associated SalesOrder entity (one to one).

If the navigation property to_SalesOrder for an entity SalesOrderHeaderPartner 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_SalesOrder is already loaded, the result will contain the SalesOrder entity. If not, a null value state 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.

setSalesOrder

public void setSalesOrder(String value)

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

Parameters:

value - salesOrder

builder

@Generated(value="lombok")
public static SalesOrderHeaderPartner.SalesOrderHeaderPartnerBuilder builder()

getSalesOrder

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

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

Returns:

Sales Order

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

equals

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

Overrides:

equals in class VdmObject<SalesOrderHeaderPartner>

hashCode

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

Overrides:

hashCode in class VdmObject<SalesOrderHeaderPartner>