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

Class PurCtrPartners

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.purchasecontract.PurCtrPartners

public class PurCtrPartners
extends VdmEntity<PurCtrPartners>

API Purchase Contract Partner View

Original entity name from the Odata EDM: A_PurCtrPartnersType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PurCtrPartners.PurCtrPartnersBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static PurCtrPartnersSelectable	ALL_FIELDS Selector for all available fields of PurCtrPartners.
static PurCtrPartnersField<Boolean>	DEFAULT_PARTNER Use with available fluent helpers to apply the DefaultPartner field to query operations.
static PurCtrPartnersField<String>	PARTNER_COUNTER Use with available fluent helpers to apply the PartnerCounter field to query operations.
static PurCtrPartnersField<String>	PARTNER_FUNCTION Use with available fluent helpers to apply the PartnerFunction field to query operations.
static PurCtrPartnersField<String>	PLANT Use with available fluent helpers to apply the Plant field to query operations.
static PurCtrPartnersField<String>	PURCHASE_CONTRACT Use with available fluent helpers to apply the PurchaseContract field to query operations.
static PurCtrPartnersField<String>	PURCHASE_CONTRACT_ITEM Use with available fluent helpers to apply the PurchaseContractItem field to query operations.
static PurCtrPartnersField<String>	PURCHASING_ORGANIZATION Use with available fluent helpers to apply the PurchasingOrganization field to query operations.
static PurCtrPartnersField<String>	SUPPLIER Use with available fluent helpers to apply the Supplier field to query operations.
static PurCtrPartnersField<String>	SUPPLIER_SUBRANGE Use with available fluent helpers to apply the SupplierSubrange field to query operations.

Fields inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
PurCtrPartners()
PurCtrPartners(String purchaseContract, String purchaseContractItem, String purchasingOrganization, String partnerFunction, String plant, String supplierSubrange, String partnerCounter, String supplier, Boolean defaultPartner)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
static PurCtrPartners.PurCtrPartnersBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static <T> PurCtrPartnersField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> PurCtrPartnersField<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	getDefaultServicePath()
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	getPurchaseContract() (Key Field) Constraints: Not nullable, Maximum length: 10
String	getPurchaseContractItem() (Key Field) Constraints: Not nullable, Maximum length: 5
String	getPurchasingOrganization() (Key Field) Constraints: Not nullable, Maximum length: 4
String	getSupplier() Constraints: Not nullable, Maximum length: 10
String	getSupplierSubrange() (Key Field) Constraints: Not nullable, Maximum length: 6
Class<PurCtrPartners>	getType()
int	hashCode()
void	setDefaultPartner(Boolean defaultPartner) Constraints: none
void	setErpConfigContext(ErpConfigContext erpConfigContext) Deprecated. Use attachToService(String, ErpConfigContext) instead.
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	setPurchaseContract(String purchaseContract) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setPurchaseContractItem(String purchaseContractItem) (Key Field) Constraints: Not nullable, Maximum length: 5
void	setPurchasingOrganization(String purchasingOrganization) (Key Field) Constraints: Not nullable, Maximum length: 4
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
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()
String	toString()

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmEntity

getEndpointUrl, getServicePathForFetch, getVersionIdentifier, 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, toMapOfNavigationProperties

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final PurCtrPartnersSelectable ALL_FIELDS

Selector for all available fields of PurCtrPartners.

PURCHASE_CONTRACT

public static final PurCtrPartnersField<String> PURCHASE_CONTRACT

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

PURCHASE_CONTRACT_ITEM

public static final PurCtrPartnersField<String> PURCHASE_CONTRACT_ITEM

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

PURCHASING_ORGANIZATION

public static final PurCtrPartnersField<String> PURCHASING_ORGANIZATION

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

PARTNER_FUNCTION

public static final PurCtrPartnersField<String> PARTNER_FUNCTION

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

PLANT

public static final PurCtrPartnersField<String> PLANT

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

SUPPLIER_SUBRANGE

public static final PurCtrPartnersField<String> SUPPLIER_SUBRANGE

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

PARTNER_COUNTER

public static final PurCtrPartnersField<String> PARTNER_COUNTER

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

SUPPLIER

public static final PurCtrPartnersField<String> SUPPLIER

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

DEFAULT_PARTNER

public static final PurCtrPartnersField<Boolean> DEFAULT_PARTNER

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

Constructor Detail

PurCtrPartners

public PurCtrPartners()

PurCtrPartners

public PurCtrPartners(@Nullable
                      String purchaseContract,
                      @Nullable
                      String purchaseContractItem,
                      @Nullable
                      String purchasingOrganization,
                      @Nullable
                      String partnerFunction,
                      @Nullable
                      String plant,
                      @Nullable
                      String supplierSubrange,
                      @Nullable
                      String partnerCounter,
                      @Nullable
                      String supplier,
                      @Nullable
                      Boolean defaultPartner)

Method Detail

getType

@Nonnull
public Class<PurCtrPartners> getType()

Specified by:

getType in class VdmObject<PurCtrPartners>

Returns:

The class of this object.

setPurchaseContract

public void setPurchaseContract(@Nullable
                                String purchaseContract)

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

Original property name from the Odata EDM: PurchaseContract

Parameters:

purchaseContract - Alphanumeric key uniquely identifying the document.

setPurchaseContractItem

public void setPurchaseContractItem(@Nullable
                                    String purchaseContractItem)

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

Original property name from the Odata EDM: PurchaseContractItem

Parameters:

purchaseContractItem - Specifies the number that uniquely identifies an item in .

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 - Denotes the purchasing organization.

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.

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 - Key uniquely identifying a plant.

setSupplierSubrange

public void setSupplierSubrange(@Nullable
                                String supplierSubrange)

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

Original property name from the Odata EDM: SupplierSubrange

For each supplier sub-range:The master data is kept on a common basisCertain conditions applyIn the supplier master, you can create different purchasing data and different partner functions for each supplier sub-range.You can also maintain and change the conditions for each supplier sub-range. You assign a material to a supplier sub-range in the info record.In the supplier master, you can maintain different data for particular supplier sub-ranges, such as ordering addresses or terms of payment, for example.When creating a purchase order with a known supplier, different data is only determined if the supplier sub-range is entered in the initial screen.Your supplier Smith in Houston has two sub-ranges: paint and glue.All materials from the "paint" sub-range are ordered in Houston.You have maintained an alternative ordering address in Detroit for the "glue" sub-range.If you order materials from the "glue" sub-range, the supplier sub-range finds the Detroit ordering address.

Parameters:

supplierSubrange - Subdivision of a supplier's overall product range according to various criteria.

setPartnerCounter

public void setPartnerCounter(@Nullable
                              String partnerCounter)

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

Original property name from the Odata EDM: PartnerCounter

When you create a sales order for a particular customer, there may be more than one ship-to party defined. The different ship-to parties are numbered sequentially.

Parameters:

partnerCounter - The sequential number that the system applies when there is more than one partner for a particular partner function.

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.

setDefaultPartner

public void setDefaultPartner(@Nullable
                              Boolean defaultPartner)

Constraints: none

Original property name from the Odata EDM: DefaultPartner

When you enter more than one partner for a particular partner function (for example, you define three different ship-to parties), you can select one partner as the default. During sales or purchasing processing, if you have defined multiple partners for a partner function, the system prompts you to choose just one partner. The system presents the default partner as the first choice in the pop-up window.

Parameters:

defaultPartner - Specifies a partner as the default for a particular partner function.

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<PurCtrPartners>

getKey

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

Overrides:

getKey in class VdmObject<PurCtrPartners>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<PurCtrPartners>

fromMap

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

Overrides:

fromMap in class VdmObject<PurCtrPartners>

field

@Nonnull
public static <T> PurCtrPartnersField<T> field(@Nonnull
                                                        String fieldName,
                                                        @Nonnull
                                                        Class<T> fieldType)

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

Type Parameters:

T - The type of the extension field when performing value comparisons.

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> PurCtrPartnersField<T> field(@Nonnull
                                                                String fieldName,
                                                                @Nonnull
                                                                TypeConverter<T,DomainT> typeConverter)

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

Type Parameters:

T - The type of the extension field when performing value comparisons.

DomainT - The type of the extension field as returned by the OData service.

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.

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Description copied from class: VdmEntity

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities). New ERP configuration context to apply to this entity

Overrides:

getErpConfigContext in class VdmEntity<PurCtrPartners>

Returns:

The stored ERP system context for executing queries, or null if no such context has been set.

setErpConfigContext

@Deprecated
public void setErpConfigContext(@Nullable
                                            ErpConfigContext erpConfigContext)

Deprecated. Use attachToService(String, ErpConfigContext) instead.

Description copied from class: VdmEntity

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

Overrides:

setErpConfigContext in class VdmEntity<PurCtrPartners>

Parameters:

erpConfigContext - New ERP configuration context to apply to this entity

setServicePathForFetch

protected void setServicePathForFetch(@Nullable
                                      String servicePathForFetch)

Description copied from class: VdmEntity

The service path only used for the fetch commands of this entity.

Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.

Overrides:

setServicePathForFetch in class VdmEntity<PurCtrPartners>

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nullable
                            ErpConfigContext configContext)

Description copied from class: VdmEntity

Sets the service path and ERP configuration context for the fetch commands of this entity. Ensures that both are set to some value by using defaults if null values are provided in the arguments. Existing values are preserved if null values are provided in the arguments. Also applies to any associated entities (navigation properties) that were previously fetched.

Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.

Overrides:

attachToService in class VdmEntity<PurCtrPartners>

Parameters:

servicePath - Optional parameter. New service path to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the service path has never been set, then the service path will be set to the default defined in the corresponding service interface.

configContext - Optional parameter. New ERP configuration context to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the ERP configuration context has never been set, then the ERP configuration context will be set to a new instance of ErpConfigContext.

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<PurCtrPartners>

builder

public static PurCtrPartners.PurCtrPartnersBuilder builder()

getPurchaseContract

@Nullable
public String getPurchaseContract()

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

Original property name from the Odata EDM: PurchaseContract

Returns:

Alphanumeric key uniquely identifying the document.

getPurchaseContractItem

@Nullable
public String getPurchaseContractItem()

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

Original property name from the Odata EDM: PurchaseContractItem

Returns:

Specifies the number that uniquely identifies an item in .

getPurchasingOrganization

@Nullable
public String getPurchasingOrganization()

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

Original property name from the Odata EDM: PurchasingOrganization

Returns:

Denotes the purchasing organization.

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.

getPlant

@Nullable
public String getPlant()

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

Original property name from the Odata EDM: Plant

Returns:

Key uniquely identifying a plant.

getSupplierSubrange

@Nullable
public String getSupplierSubrange()

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

Original property name from the Odata EDM: SupplierSubrange

For each supplier sub-range:The master data is kept on a common basisCertain conditions applyIn the supplier master, you can create different purchasing data and different partner functions for each supplier sub-range.You can also maintain and change the conditions for each supplier sub-range. You assign a material to a supplier sub-range in the info record.In the supplier master, you can maintain different data for particular supplier sub-ranges, such as ordering addresses or terms of payment, for example.When creating a purchase order with a known supplier, different data is only determined if the supplier sub-range is entered in the initial screen.Your supplier Smith in Houston has two sub-ranges: paint and glue.All materials from the "paint" sub-range are ordered in Houston.You have maintained an alternative ordering address in Detroit for the "glue" sub-range.If you order materials from the "glue" sub-range, the supplier sub-range finds the Detroit ordering address.

Returns:

Subdivision of a supplier's overall product range according to various criteria.

getPartnerCounter

@Nullable
public String getPartnerCounter()

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

Original property name from the Odata EDM: PartnerCounter

When you create a sales order for a particular customer, there may be more than one ship-to party defined. The different ship-to parties are numbered sequentially.

Returns:

The sequential number that the system applies when there is more than one partner for a particular partner function.

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.

getDefaultPartner

@Nullable
public Boolean getDefaultPartner()

Constraints: none

Original property name from the Odata EDM: DefaultPartner

When you enter more than one partner for a particular partner function (for example, you define three different ship-to parties), you can select one partner as the default. During sales or purchasing processing, if you have defined multiple partners for a partner function, the system prompts you to choose just one partner. The system presents the default partner as the first choice in the pop-up window.

Returns:

Specifies a partner as the default for a particular partner function.

toString

public String toString()

Overrides:

toString in class VdmObject<PurCtrPartners>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<PurCtrPartners>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<PurCtrPartners>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<PurCtrPartners>