Package 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

  • Field Details

    • 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 Details

    • 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 Details

    • getType

      @Nonnull public Class<BusinessPlace> getType()
      Specified by:
      getType in class VdmObject<BusinessPlace>

    • 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 - 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 - Company Code

    • setBusinessPlaceStateTaxNumber

      public void setBusinessPlaceStateTaxNumber(@Nullable String businessPlaceStateTaxNumber)
      Constraints: Not nullable, Maximum length: 18

      Original property name from the Odata EDM: BusinessPlaceStateTaxNumber

      Parameters:
      businessPlaceStateTaxNumber - State Tax No.

    • 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()
      Specified by:
      getEntityCollection in class VdmEntity<BusinessPlace>

    • getKey

      @Nonnull protected Map<String,Object> getKey()
      Overrides:
      getKey in class VdmObject<BusinessPlace>

    • 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<T, DomainT> 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()
      Overrides:
      getDestinationForFetch in class VdmEntity<BusinessPlace>

    • setServicePathForFetch

      protected void setServicePathForFetch(@Nullable String servicePathForFetch)
      Overrides:
      setServicePathForFetch in class VdmEntity<BusinessPlace>

    • attachToService

      public void attachToService(@Nullable String servicePath, @Nonnull HttpDestinationProperties destination)
      Overrides:
      attachToService in class VdmEntity<BusinessPlace>

    • getDefaultServicePath

      protected String getDefaultServicePath()
      Overrides:
      getDefaultServicePath in class VdmEntity<BusinessPlace>

    • toMapOfNavigationProperties

      @Nonnull protected Map<String,Object> toMapOfNavigationProperties()
      Overrides:
      toMapOfNavigationProperties in class VdmObject<BusinessPlace>

    • fetchEmails

      @Nonnull public List<SmtpNumbers> fetchEmails()
      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.datamodel.odata.client.exception.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()
      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.datamodel.odata.client.exception.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:
      Business Place

    • getCompanyCode

      @Nullable public String getCompanyCode()
      (Key Field) Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: CompanyCode

      Returns:
      Company Code

    • getBusinessPlaceStateTaxNumber

      @Nullable public String getBusinessPlaceStateTaxNumber()
      Constraints: Not nullable, Maximum length: 18

      Original property name from the Odata EDM: BusinessPlaceStateTaxNumber

      Returns:
      State Tax No.

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

    • canEqual

      protected boolean canEqual(@Nullable Object other)
      Overrides:
      canEqual in class VdmEntity<BusinessPlace>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class VdmEntity<BusinessPlace>