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

Class SchAgrmtPartner

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtPartner

public class SchAgrmtPartner
extends VdmEntity<SchAgrmtPartner>

CDS View for SA partner API exposure

Original entity name from the Odata EDM: A_SchAgrmtPartnerType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SchAgrmtPartner.SchAgrmtPartnerBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static SchAgrmtPartnerSelectable	ALL_FIELDS Selector for all available fields of SchAgrmtPartner.
static SchAgrmtPartnerField<Boolean>	DEFAULT_PARTNER Use with available fluent helpers to apply the DefaultPartner field to query operations.
static SchAgrmtPartnerField<String>	PARTNER_COUNTER Use with available fluent helpers to apply the PartnerCounter field to query operations.
static SchAgrmtPartnerField<String>	PARTNER_FUNCTION Use with available fluent helpers to apply the PartnerFunction field to query operations.
static SchAgrmtPartnerField<String>	PLANT Use with available fluent helpers to apply the Plant field to query operations.
static SchAgrmtPartnerField<String>	PURCHASING_ORGANIZATION Use with available fluent helpers to apply the PurchasingOrganization field to query operations.
static SchAgrmtPartnerField<String>	SCHEDULING_AGREEMENT Use with available fluent helpers to apply the SchedulingAgreement field to query operations.
static SchAgrmtPartnerField<String>	SCHEDULING_AGREEMENT_ITEM Use with available fluent helpers to apply the SchedulingAgreementItem field to query operations.
static SchAgrmtPartnerField<String>	SUPPLIER Use with available fluent helpers to apply the Supplier field to query operations.
static SchAgrmtPartnerField<String>	SUPPLIER_SUBRANGE Use with available fluent helpers to apply the SupplierSubrange field to query operations.
static SchAgrmtPartnerLink<SchAgrmtItem>	TO_SCHEDG_AGRMT_ITM Use with available fluent helpers to apply the to_SchedgAgrmtItm 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
SchAgrmtPartner()
SchAgrmtPartner(String schedulingAgreement, String schedulingAgreementItem, String purchasingOrganization, String supplierSubrange, String plant, String partnerFunction, String partnerCounter, String supplier, Boolean defaultPartner, ErpConfigContext erpConfigContext, SchAgrmtItem toSchedgAgrmtItm)

Method Summary

Modifier and Type	Method and Description
static SchAgrmtPartner.SchAgrmtPartnerBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
SchAgrmtItem	fetchSchedgAgrmtItm() Fetches the SchAgrmtItem entity (one to one) associated with this entity.
static <T> SchAgrmtPartnerField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> SchAgrmtPartnerField<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)
Boolean	getDefaultPartner() Constraints: none
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	getPartnerCounter() (Key Field) Constraints: Not nullable, Maximum length: 3
String	getPartnerFunction() (Key Field) Constraints: Not nullable, Maximum length: 2
String	getPlant() (Key Field) Constraints: Not nullable, Maximum length: 4
String	getPurchasingOrganization() (Key Field) Constraints: Not nullable, Maximum length: 4
Optional<SchAgrmtItem>	getSchedgAgrmtItmIfPresent() Retrieval of associated SchAgrmtItem entity (one to one).
SchAgrmtItem	getSchedgAgrmtItmOrFetch() Retrieval of associated SchAgrmtItem entity (one to one).
String	getSchedulingAgreement() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getSchedulingAgreementItem() (Key Field) Constraints: Not nullable, Maximum length: 5
String	getSupplier() Constraints: Not nullable, Maximum length: 10
String	getSupplierSubrange() (Key Field) Constraints: Not nullable, Maximum length: 6
Class<SchAgrmtPartner>	getType()
int	hashCode()
void	setDefaultPartner(Boolean defaultPartner) Constraints: none
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setPartnerCounter(String partnerCounter) (Key Field) Constraints: Not nullable, Maximum length: 3
void	setPartnerFunction(String partnerFunction) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setPlant(String plant) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setPurchasingOrganization(String purchasingOrganization) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setSchedgAgrmtItm(SchAgrmtItem value) Overwrites the associated SchAgrmtItem entity for the loaded navigation property to_SchedgAgrmtItm.
void	setSchedulingAgreement(String schedulingAgreement) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setSchedulingAgreementItem(String schedulingAgreementItem) (Key Field) Constraints: Not nullable, Maximum length: 5
void	setSupplier(String supplier) Constraints: Not nullable, Maximum length: 10
void	setSupplierSubrange(String supplierSubrange) (Key Field) Constraints: Not nullable, Maximum length: 6
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 SchAgrmtPartnerSelectable ALL_FIELDS

Selector for all available fields of SchAgrmtPartner.

SCHEDULING_AGREEMENT

public static final SchAgrmtPartnerField<String> SCHEDULING_AGREEMENT

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

SCHEDULING_AGREEMENT_ITEM

public static final SchAgrmtPartnerField<String> SCHEDULING_AGREEMENT_ITEM

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

PURCHASING_ORGANIZATION

public static final SchAgrmtPartnerField<String> PURCHASING_ORGANIZATION

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

SUPPLIER_SUBRANGE

public static final SchAgrmtPartnerField<String> SUPPLIER_SUBRANGE

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

PLANT

public static final SchAgrmtPartnerField<String> PLANT

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

PARTNER_FUNCTION

public static final SchAgrmtPartnerField<String> PARTNER_FUNCTION

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

PARTNER_COUNTER

public static final SchAgrmtPartnerField<String> PARTNER_COUNTER

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

SUPPLIER

public static final SchAgrmtPartnerField<String> SUPPLIER

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

DEFAULT_PARTNER

public static final SchAgrmtPartnerField<Boolean> DEFAULT_PARTNER

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

TO_SCHEDG_AGRMT_ITM

public static final SchAgrmtPartnerLink<SchAgrmtItem> TO_SCHEDG_AGRMT_ITM

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

Constructor Detail

SchAgrmtPartner

public SchAgrmtPartner()

SchAgrmtPartner

public SchAgrmtPartner(@Nullable
                       String schedulingAgreement,
                       @Nullable
                       String schedulingAgreementItem,
                       @Nullable
                       String purchasingOrganization,
                       @Nullable
                       String supplierSubrange,
                       @Nullable
                       String plant,
                       @Nullable
                       String partnerFunction,
                       @Nullable
                       String partnerCounter,
                       @Nullable
                       String supplier,
                       @Nullable
                       Boolean defaultPartner,
                       @Nullable
                       ErpConfigContext erpConfigContext,
                       @Nullable
                       SchAgrmtItem toSchedgAgrmtItm)

Method Detail

getType

public Class<SchAgrmtPartner> getType()

Specified by:

getType in class VdmObject<SchAgrmtPartner>

Returns:

The class of this object.

setSchedulingAgreement

public void setSchedulingAgreement(@Nullable
                                   String schedulingAgreement)

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

Original property name from the Odata EDM: SchedulingAgreement

Parameters:

schedulingAgreement - Purchasing Document Number

setSchedulingAgreementItem

public void setSchedulingAgreementItem(@Nullable
                                       String schedulingAgreementItem)

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

Original property name from the Odata EDM: SchedulingAgreementItem

Parameters:

schedulingAgreementItem - Item Number of Purchasing Document

setPurchasingOrganization

public void setPurchasingOrganization(@Nullable
                                      String purchasingOrganization)

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

Original property name from the Odata EDM: PurchasingOrganization

Parameters:

purchasingOrganization - Purchasing Organization

setSupplierSubrange

public void setSupplierSubrange(@Nullable
                                String supplierSubrange)

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

Original property name from the Odata EDM: SupplierSubrange

Parameters:

supplierSubrange - Supplier Subrange

setPlant

public void setPlant(@Nullable
                     String plant)

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

Original property name from the Odata EDM: Plant

Parameters:

plant - Plant

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 - Partner Function

setPartnerCounter

public void setPartnerCounter(@Nullable
                              String partnerCounter)

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

Original property name from the Odata EDM: PartnerCounter

Parameters:

partnerCounter - Partner counter

setSupplier

public void setSupplier(@Nullable
                        String supplier)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: Supplier

Parameters:

supplier - Account Number of Supplier

setDefaultPartner

public void setDefaultPartner(@Nullable
                              Boolean defaultPartner)

Constraints: none

Original property name from the Odata EDM: DefaultPartner

Parameters:

defaultPartner - Default Partner

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<SchAgrmtPartner>

getKey

protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<SchAgrmtPartner>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<SchAgrmtPartner>

fromMap

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

Overrides:

fromMap in class VdmObject<SchAgrmtPartner>

field

@Nonnull
public static <T> SchAgrmtPartnerField<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> SchAgrmtPartnerField<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<SchAgrmtPartner>

fetchSchedgAgrmtItm

public SchAgrmtItem fetchSchedgAgrmtItm()
                                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getSchedgAgrmtItmOrFetch

public SchAgrmtItem getSchedgAgrmtItmOrFetch()
                                      throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated SchAgrmtItem entity (one to one). This corresponds to the OData navigation property to_SchedgAgrmtItm.

If the navigation property to_SchedgAgrmtItm of a queried SchAgrmtPartner 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 SchAgrmtItem 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.

getSchedgAgrmtItmIfPresent

public Optional<SchAgrmtItem> getSchedgAgrmtItmIfPresent()

Retrieval of associated SchAgrmtItem entity (one to one). This corresponds to the OData navigation property to_SchedgAgrmtItm.

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

setSchedgAgrmtItm

public void setSchedgAgrmtItm(SchAgrmtItem value)

Overwrites the associated SchAgrmtItem entity for the loaded navigation property to_SchedgAgrmtItm.

Parameters:

value - New SchAgrmtItem entity.

builder

public static SchAgrmtPartner.SchAgrmtPartnerBuilder builder()

getSchedulingAgreement

@Nullable
public String getSchedulingAgreement()

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

Original property name from the Odata EDM: SchedulingAgreement

Returns:

Purchasing Document Number

getSchedulingAgreementItem

@Nullable
public String getSchedulingAgreementItem()

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

Original property name from the Odata EDM: SchedulingAgreementItem

Returns:

Item Number of Purchasing Document

getPurchasingOrganization

@Nullable
public String getPurchasingOrganization()

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

Original property name from the Odata EDM: PurchasingOrganization

Returns:

Purchasing Organization

getSupplierSubrange

@Nullable
public String getSupplierSubrange()

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

Original property name from the Odata EDM: SupplierSubrange

Returns:

Supplier Subrange

getPlant

@Nullable
public String getPlant()

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

Original property name from the Odata EDM: Plant

Returns:

Plant

getPartnerFunction

@Nullable
public String getPartnerFunction()

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

Original property name from the Odata EDM: PartnerFunction

Returns:

Partner Function

getPartnerCounter

@Nullable
public String getPartnerCounter()

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

Original property name from the Odata EDM: PartnerCounter

Returns:

Partner counter

getSupplier

@Nullable
public String getSupplier()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: Supplier

Returns:

Account Number of Supplier

getDefaultPartner

@Nullable
public Boolean getDefaultPartner()

Constraints: none

Original property name from the Odata EDM: DefaultPartner

Returns:

Default Partner

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

Parameters:

erpConfigContext -

toString

public String toString()

Overrides:

toString in class VdmObject<SchAgrmtPartner>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<SchAgrmtPartner>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<SchAgrmtPartner>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<SchAgrmtPartner>