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

Class BusinessPlace

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<BusinessPlace>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.brazilbusinessplace.BusinessPlace

public class BusinessPlace
extends VdmEntity<BusinessPlace>

Business Place

Original entity name from the Odata EDM: BusinessPlace

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BusinessPlace.BusinessPlaceBuilder Helper class to allow for fluent creation of BusinessPlace instances.

Field Summary

Fields

Modifier and Type	Field and Description
static BusinessPlaceSelectable	ALL_FIELDS Selector for all available fields of BusinessPlace.
static BusinessPlaceField<String>	BRANCH Use with available fluent helpers to apply the Branch field to query operations.
static BusinessPlaceField<String>	BUS_PLACE_MUNICIPAL_TAX_NUMBER Use with available fluent helpers to apply the BusPlaceMunicipalTaxNumber field to query operations.
static BusinessPlaceField<String>	BUSINESS_PLACE_STATE_TAX_NUMBER Use with available fluent helpers to apply the BusinessPlaceStateTaxNumber field to query operations.
static BusinessPlaceField<String>	COMPANY_CODE Use with available fluent helpers to apply the CompanyCode field to query operations.
static BusinessPlaceLink<SmtpNumbers>	TO_EMAILS Use with available fluent helpers to apply the to_emails navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
BusinessPlace()
BusinessPlace(BranchAddress branchAddress, BranchDetail branchDetail, String branch, String companyCode, String businessPlaceStateTaxNumber, String busPlaceMunicipalTaxNumber, List<SmtpNumbers> toEmails)

Method Summary

Modifier and Type	Method and Description
void	addEmails(SmtpNumbers... entity) Adds elements to the list of associated SmtpNumbers entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static BusinessPlace.BusinessPlaceBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<SmtpNumbers>	fetchEmails() Fetches the SmtpNumbers entities (one to many) associated with this entity.
static <T> BusinessPlaceField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> BusinessPlaceField<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	getBranch() (Key Field) Constraints: Not nullable, Maximum length: 4
BranchAddress	getBranchAddress() Constraints: Not nullable
BranchDetail	getBranchDetail() Constraints: Not nullable
String	getBusinessPlaceStateTaxNumber() Constraints: Not nullable, Maximum length: 18
String	getBusPlaceMunicipalTaxNumber() Constraints: Not nullable, Maximum length: 20
String	getCompanyCode() (Key Field) Constraints: Not nullable, Maximum length: 4
protected String	getDefaultServicePath() Used by fluent helpers and navigation property methods to construct OData queries.
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
io.vavr.control.Option<List<SmtpNumbers>>	getEmailsIfPresent() Retrieval of associated SmtpNumbers entities (one to many).
List<SmtpNumbers>	getEmailsOrFetch() Retrieval of associated SmtpNumbers entities (one to many).
protected String	getEntityCollection() Used by fluent helpers and navigation property methods to construct OData queries.
protected Map<String,Object>	getKey()
Class<BusinessPlace>	getType()
int	hashCode()
void	setBranch(String branch) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setBranchAddress(BranchAddress branchAddress) Constraints: Not nullable
void	setBranchDetail(BranchDetail branchDetail) Constraints: Not nullable
void	setBusinessPlaceStateTaxNumber(String businessPlaceStateTaxNumber) Constraints: Not nullable, Maximum length: 18
void	setBusPlaceMunicipalTaxNumber(String busPlaceMunicipalTaxNumber) Constraints: Not nullable, Maximum length: 20
void	setCompanyCode(String companyCode) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setEmails(List<SmtpNumbers> value) Overwrites the list of associated SmtpNumbers entities for the loaded navigation property to_emails.
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
protected Map<String,Object>	toMapOfFields()
protected Map<String,Object>	toMapOfNavigationProperties()
String	toString()

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

getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.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 BusinessPlaceSelectable ALL_FIELDS

Selector for all available fields of BusinessPlace.

BRANCH

public static final BusinessPlaceField<String> BRANCH

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

COMPANY_CODE

public static final BusinessPlaceField<String> COMPANY_CODE

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

BUSINESS_PLACE_STATE_TAX_NUMBER

public static final BusinessPlaceField<String> BUSINESS_PLACE_STATE_TAX_NUMBER

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

BUS_PLACE_MUNICIPAL_TAX_NUMBER

public static final BusinessPlaceField<String> BUS_PLACE_MUNICIPAL_TAX_NUMBER

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

TO_EMAILS

public static final BusinessPlaceLink<SmtpNumbers> TO_EMAILS

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

Constructor Detail

BusinessPlace

public BusinessPlace()

BusinessPlace

public BusinessPlace(@Nullable
                     BranchAddress branchAddress,
                     @Nullable
                     BranchDetail branchDetail,
                     @Nullable
                     String branch,
                     @Nullable
                     String companyCode,
                     @Nullable
                     String businessPlaceStateTaxNumber,
                     @Nullable
                     String busPlaceMunicipalTaxNumber,
                     List<SmtpNumbers> toEmails)

Method Detail

getType

@Nonnull
public Class<BusinessPlace> getType()

Specified by:

getType in class VdmObject<BusinessPlace>

Returns:

The class of this object.

setBranchAddress

public void setBranchAddress(@Nullable
                             BranchAddress branchAddress)

Constraints: Not nullable

Original property name from the Odata EDM: BranchAddress

Parameters:

branchAddress - The branchAddress to set.

setBranchDetail

public void setBranchDetail(@Nullable
                            BranchDetail branchDetail)

Constraints: Not nullable

Original property name from the Odata EDM: BranchDetail

Parameters:

branchDetail - The branchDetail to set.

setBranch

public void setBranch(@Nullable
                      String branch)

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

Original property name from the Odata EDM: Branch

Parameters:

branch - Specifies the business place.

setCompanyCode

public void setCompanyCode(@Nullable
                           String companyCode)

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

Original property name from the Odata EDM: CompanyCode

Parameters:

companyCode - The company code is an organizational unit within financial accounting.

setBusinessPlaceStateTaxNumber

public void setBusinessPlaceStateTaxNumber(@Nullable
                                           String businessPlaceStateTaxNumber)

Constraints: Not nullable, Maximum length: 18

Original property name from the Odata EDM: BusinessPlaceStateTaxNumber

Parameters:

businessPlaceStateTaxNumber - Specifies the company's state tax number.

setBusPlaceMunicipalTaxNumber

public void setBusPlaceMunicipalTaxNumber(@Nullable
                                          String busPlaceMunicipalTaxNumber)

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: BusPlaceMunicipalTaxNumber

Parameters:

busPlaceMunicipalTaxNumber - Munic. Tax No.

getEntityCollection

protected String getEntityCollection()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Specified by:

getEntityCollection in class VdmEntity<BusinessPlace>

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<BusinessPlace>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<BusinessPlace>

fromMap

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

Overrides:

fromMap in class VdmObject<BusinessPlace>

field

@Nonnull
public static <T> BusinessPlaceField<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> BusinessPlaceField<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.

getDestinationForFetch

@Nullable
public HttpDestinationProperties getDestinationForFetch()

Description copied from class: VdmEntity

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

Overrides:

getDestinationForFetch in class VdmEntity<BusinessPlace>

Returns:

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

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

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nonnull
                            HttpDestinationProperties destination)

Description copied from class: VdmEntity

Sets the service path and destination for the fetch commands of this entity. 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<BusinessPlace>

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.

destination - New destination to apply to this entity and any associated entities that were previously fetched.

getDefaultServicePath

protected String getDefaultServicePath()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Overrides:

getDefaultServicePath in class VdmEntity<BusinessPlace>

Returns:

Default context path to the OData service. In other words, everything in between the protocol://hostname:port and the OData resource name (entity set, $metadata, etc.)

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<BusinessPlace>

fetchEmails

@Nonnull
public List<SmtpNumbers> fetchEmails()
                                       throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the SmtpNumbers entities (one to many) associated with this entity. This corresponds to the OData navigation property to_emails.

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

Returns:

List containing one or more associated SmtpNumbers entities. If no entities are associated then an empty list is returned.

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.

getEmailsOrFetch

@Nonnull
public List<SmtpNumbers> getEmailsOrFetch()
                                            throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated SmtpNumbers entities (one to many). This corresponds to the OData navigation property to_emails.

If the navigation property to_emails of a queried BusinessPlace 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 SmtpNumbers entities.

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.

getEmailsIfPresent

@Nonnull
public io.vavr.control.Option<List<SmtpNumbers>> getEmailsIfPresent()

Retrieval of associated SmtpNumbers entities (one to many). This corresponds to the OData navigation property to_emails.

If the navigation property for an entity BusinessPlace has not been resolved yet, this method will not query further information. Instead its Option result state will be empty.

Returns:

If the information for navigation property to_emails is already loaded, the result will contain the SmtpNumbers entities. If not, an Option with result state empty is returned.

setEmails

public void setEmails(@Nonnull
                      List<SmtpNumbers> value)

Overwrites the list of associated SmtpNumbers entities for the loaded navigation property to_emails.

If the navigation property to_emails of a queried BusinessPlace 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.

Parameters:

value - List of SmtpNumbers entities.

addEmails

public void addEmails(SmtpNumbers... entity)

Adds elements to the list of associated SmtpNumbers entities. This corresponds to the OData navigation property to_emails.

If the navigation property to_emails of a queried BusinessPlace 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.

Parameters:

entity - Array of SmtpNumbers entities.

builder

@Nonnull
public static BusinessPlace.BusinessPlaceBuilder builder()

getBranchAddress

@Nullable
public BranchAddress getBranchAddress()

Constraints: Not nullable

Original property name from the Odata EDM: BranchAddress

Returns:

The branchAddress contained in this entity.

getBranchDetail

@Nullable
public BranchDetail getBranchDetail()

Constraints: Not nullable

Original property name from the Odata EDM: BranchDetail

Returns:

The branchDetail contained in this entity.

getBranch

@Nullable
public String getBranch()

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

Original property name from the Odata EDM: Branch

Returns:

Specifies the business place.

getCompanyCode

@Nullable
public String getCompanyCode()

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

Original property name from the Odata EDM: CompanyCode

Returns:

The company code is an organizational unit within financial accounting.

getBusinessPlaceStateTaxNumber

@Nullable
public String getBusinessPlaceStateTaxNumber()

Constraints: Not nullable, Maximum length: 18

Original property name from the Odata EDM: BusinessPlaceStateTaxNumber

Returns:

Specifies the company's state tax number.

getBusPlaceMunicipalTaxNumber

@Nullable
public String getBusPlaceMunicipalTaxNumber()

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: BusPlaceMunicipalTaxNumber

Returns:

Munic. Tax No.

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<BusinessPlace>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<BusinessPlace>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<BusinessPlace>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BusinessPlace>