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

Class OutbDeliveryPartner

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.readcreateupdateanddeleteoutbounddeliveries.OutbDeliveryPartner

public class OutbDeliveryPartner
extends VdmEntity<OutbDeliveryPartner>

A_OutbDeliveryPartnerType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OutbDeliveryPartner.OutbDeliveryPartnerBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static OutbDeliveryPartnerField<String>	ADDRESS_ID Use with available fluent helpers to apply the AddressID field to query operations.
static OutbDeliveryPartnerSelectable	ALL_FIELDS Selector for all available fields of OutbDeliveryPartner.
static OutbDeliveryPartnerField<String>	CONTACT_PERSON Use with available fluent helpers to apply the ContactPerson field to query operations.
static OutbDeliveryPartnerField<String>	CUSTOMER Use with available fluent helpers to apply the Customer field to query operations.
static OutbDeliveryPartnerField<String>	PARTNER_FUNCTION Use with available fluent helpers to apply the PartnerFunction field to query operations.
static OutbDeliveryPartnerField<String>	PERSONNEL Use with available fluent helpers to apply the Personnel field to query operations.
static OutbDeliveryPartnerField<String>	SD_DOCUMENT Use with available fluent helpers to apply the SDDocument field to query operations.
static OutbDeliveryPartnerField<String>	SD_DOCUMENT_ITEM Use with available fluent helpers to apply the SDDocumentItem field to query operations.
static OutbDeliveryPartnerField<String>	SUPPLIER Use with available fluent helpers to apply the Supplier field to query operations.
static OutbDeliveryPartnerLink<OutbDeliveryAddress>	TO_ADDRESS Use with available fluent helpers to apply the to_Address navigation property to query operations.

Constructor Summary

Constructors

Constructor and Description
OutbDeliveryPartner()
OutbDeliveryPartner(String addressID, String contactPerson, String customer, String partnerFunction, String personnel, String sDDocument, String sDDocumentItem, String supplier, ErpConfigContext erpConfigContext, OutbDeliveryAddress toAddress)

Method Summary

Modifier and Type	Method and Description
static OutbDeliveryPartner.OutbDeliveryPartnerBuilder	builder()
boolean	equals(Object o)
OutbDeliveryAddress	fetchAddress() Fetches the OutbDeliveryAddress entity (one to one) associated with this entity.
static <T> OutbDeliveryPartnerField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
String	getAddressID() Constraints: Not nullable, Maximum length: 10
OutbDeliveryAddress	getAddressOrFetch() Retrieval of associated OutbDeliveryAddress entity (one to one).
com.google.common.base.Optional<OutbDeliveryAddress>	getAddressOrNull() Retrieval of associated OutbDeliveryAddress entity (one to one).
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	getSDDocument() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getSDDocumentItem() Constraints: Not nullable, Maximum length: 6
String	getSupplier() Constraints: Not nullable, Maximum length: 10
Class<OutbDeliveryPartner>	getType()
int	hashCode()
void	setAddress(OutbDeliveryAddress value) Overwrites the associated OutbDeliveryAddress entity for the loaded navigation property to_Address.
void	setAddressID(String addressID) Constraints: Not nullable, Maximum length: 10
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	setSDDocument(String sDDocument) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setSDDocumentItem(String sDDocumentItem) Constraints: Not nullable, Maximum length: 6
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 OutbDeliveryPartnerSelectable ALL_FIELDS

Selector for all available fields of OutbDeliveryPartner.

ADDRESS_ID

public static final OutbDeliveryPartnerField<String> ADDRESS_ID

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

CONTACT_PERSON

public static final OutbDeliveryPartnerField<String> CONTACT_PERSON

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

CUSTOMER

public static final OutbDeliveryPartnerField<String> CUSTOMER

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

PARTNER_FUNCTION

public static final OutbDeliveryPartnerField<String> PARTNER_FUNCTION

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

PERSONNEL

public static final OutbDeliveryPartnerField<String> PERSONNEL

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

SD_DOCUMENT

public static final OutbDeliveryPartnerField<String> SD_DOCUMENT

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

SD_DOCUMENT_ITEM

public static final OutbDeliveryPartnerField<String> SD_DOCUMENT_ITEM

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

SUPPLIER

public static final OutbDeliveryPartnerField<String> SUPPLIER

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

TO_ADDRESS

public static final OutbDeliveryPartnerLink<OutbDeliveryAddress> TO_ADDRESS

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

Constructor Detail

OutbDeliveryPartner

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

OutbDeliveryPartner

@ConstructorProperties(value={"addressID","contactPerson","customer","partnerFunction","personnel","sDDocument","sDDocumentItem","supplier","erpConfigContext","toAddress"})
 @Generated(value="lombok")
public OutbDeliveryPartner(@Nullable
                                                                                                                                                                                                                                    String addressID,
                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                    String contactPerson,
                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                    String customer,
                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                    String partnerFunction,
                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                    String personnel,
                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                    String sDDocument,
                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                    String sDDocumentItem,
                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                    String supplier,
                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                    ErpConfigContext erpConfigContext,
                                                                                                                                                                                                                                    @Nullable
                                                                                                                                                                                                                                    OutbDeliveryAddress toAddress)

Method Detail

getType

public Class<OutbDeliveryPartner> getType()

Specified by:

getType in class VdmObject<OutbDeliveryPartner>

Returns:

The class of this object.

field

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

fetchAddress

public OutbDeliveryAddress fetchAddress()
                                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getAddressOrFetch

public OutbDeliveryAddress getAddressOrFetch()
                                      throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated OutbDeliveryAddress entity (one to one).

If the navigation property to_Address of a queried OutbDeliveryPartner 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 OutbDeliveryAddress 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.

getAddressOrNull

public com.google.common.base.Optional<OutbDeliveryAddress> getAddressOrNull()

Retrieval of associated OutbDeliveryAddress entity (one to one).

If the navigation property to_Address for an entity OutbDeliveryPartner 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_Address is already loaded, the result will contain the OutbDeliveryAddress entity. If not, a null value state is returned.

setAddress

public void setAddress(OutbDeliveryAddress value)

Overwrites the associated OutbDeliveryAddress entity for the loaded navigation property to_Address.

Parameters:

value - New OutbDeliveryAddress entity.

builder

@Generated(value="lombok")
public static OutbDeliveryPartner.OutbDeliveryPartnerBuilder builder()

getAddressID

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

Constraints: Not nullable, Maximum length: 10

Returns:

Identification of an address (name, postal code, city, and so on) in Business Address Services.

getContactPerson

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

Constraints: Not nullable, Maximum length: 10

Returns:

The number that uniquely identifies the contact person.

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.

getPartnerFunction

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

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

The ship-to party in your system could be abbreviated, for example, to "SH".

Returns:

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

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.

getSDDocument

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

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

Returns:

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

getSDDocumentItem

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

Constraints: Not nullable, Maximum length: 6

Returns:

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

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.

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.

setAddressID

@Generated(value="lombok")
public void setAddressID(@Nullable
                                                    String addressID)

Constraints: Not nullable, Maximum length: 10

Parameters:

addressID -

setContactPerson

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

Constraints: Not nullable, Maximum length: 10

Parameters:

contactPerson -

setCustomer

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

Constraints: Not nullable, Maximum length: 10

Parameters:

customer -

setPartnerFunction

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

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

The ship-to party in your system could be abbreviated, for example, to "SH".

Parameters:

partnerFunction -

setPersonnel

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

Constraints: Not nullable, Maximum length: 8

Parameters:

personnel -

setSDDocument

@Generated(value="lombok")
public void setSDDocument(@Nullable
                                                     String sDDocument)

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

Parameters:

sDDocument -

setSDDocumentItem

@Generated(value="lombok")
public void setSDDocumentItem(@Nullable
                                                         String sDDocumentItem)

Constraints: Not nullable, Maximum length: 6

Parameters:

sDDocumentItem -

setSupplier

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

Constraints: Not nullable, Maximum length: 10

Parameters:

supplier -

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

equals

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

Overrides:

equals in class VdmObject<OutbDeliveryPartner>

hashCode

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

Overrides:

hashCode in class VdmObject<OutbDeliveryPartner>