Package com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.pradivisionofinterest

Class ScaleHdr

java.lang.Object
com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odatav4.core.VdmEntity<ScaleHdr>
com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.pradivisionofinterest.ScaleHdr
All Implemented Interfaces:
VdmEntitySet
public class ScaleHdr extends VdmEntity<ScaleHdr> implements VdmEntitySet
Sliding Scale Header

Original entity name from the Odata EDM: ScaleHdr_Type

  • Field Details

  • Constructor Details

    • ScaleHdr

      public ScaleHdr()

    • ScaleHdr

      public ScaleHdr(@Nullable String companyCode, @Nullable String pRAJointVenture, @Nullable String divisionOfInterest, @Nullable String pRACustomerSupplierCode, @Nullable String pRAOwner, @Nullable String ownerInterestType, @Nullable String ownerInterestSequence, @Nullable LocalDate dOIOwnerEffectiveFromDate, @Nullable String pRASlidingScaleNumber, @Nullable String pRASlidingScComprnOptrCode, @Nullable String pRASlidingScaleMethod, @Nullable String pRASlidingScaleRangeCode, @Nullable BigDecimal pRASlidingScaleGravityVal, @Nullable String pRADivisionOfInterestNmbr, @Nullable DOI to_PRAMaintDOIHierNode, @Nullable DOIOwner to_PRAMaintDOIOwnerHierNode, List<Scale> to_PRAMaintSlidingScaleHierNode)

  • Method Details

    • getType

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

    • 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

    • setPRAJointVenture

      public void setPRAJointVenture(@Nullable String pRAJointVenture)
      (Key Field) Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: PRAJointVenture

      Parameters:
      pRAJointVenture - Joint Venture

    • setDivisionOfInterest

      public void setDivisionOfInterest(@Nullable String divisionOfInterest)
      (Key Field) Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: DivisionOfInterest

      Parameters:
      divisionOfInterest - Division of Interest (DOI)

    • setPRACustomerSupplierCode

      public void setPRACustomerSupplierCode(@Nullable String pRACustomerSupplierCode)
      (Key Field) Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: PRACustomerSupplierCode

      Parameters:
      pRACustomerSupplierCode - Customer/Vendor Indicator

    • setPRAOwner

      public void setPRAOwner(@Nullable String pRAOwner)
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: PRAOwner

      Parameters:
      pRAOwner - PRA owner

    • setOwnerInterestType

      public void setOwnerInterestType(@Nullable String ownerInterestType)
      (Key Field) Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: OwnerInterestType

      Parameters:
      ownerInterestType - Participant Interest Type

    • setOwnerInterestSequence

      public void setOwnerInterestSequence(@Nullable String ownerInterestSequence)
      (Key Field) Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: OwnerInterestSequence

      Parameters:
      ownerInterestSequence - Owner Interest Sequence Number

    • setDOIOwnerEffectiveFromDate

      public void setDOIOwnerEffectiveFromDate(@Nullable LocalDate dOIOwnerEffectiveFromDate)
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: DOIOwnerEffectiveFromDate

      Parameters:
      dOIOwnerEffectiveFromDate - Effective from date

    • setPRASlidingScaleNumber

      public void setPRASlidingScaleNumber(@Nullable String pRASlidingScaleNumber)
      (Key Field) Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: PRASlidingScaleNumber

      Parameters:
      pRASlidingScaleNumber - Sliding scale number

    • setPRASlidingScComprnOptrCode

      public void setPRASlidingScComprnOptrCode(@Nullable String pRASlidingScComprnOptrCode)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: PRASlidingScComprnOptrCode

      Parameters:
      pRASlidingScComprnOptrCode - Less than / greater than / equal to code

    • setPRASlidingScaleMethod

      public void setPRASlidingScaleMethod(@Nullable String pRASlidingScaleMethod)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: PRASlidingScaleMethod

      Parameters:
      pRASlidingScaleMethod - Sliding scale method

    • setPRASlidingScaleRangeCode

      public void setPRASlidingScaleRangeCode(@Nullable String pRASlidingScaleRangeCode)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: PRASlidingScaleRangeCode

      Parameters:
      pRASlidingScaleRangeCode - Volume range code

    • setPRASlidingScaleGravityVal

      public void setPRASlidingScaleGravityVal(@Nullable BigDecimal pRASlidingScaleGravityVal)
      Constraints: Not nullable, Precision: 3, Scale: 1

      Original property name from the Odata EDM: PRASlidingScaleGravityVal

      Parameters:
      pRASlidingScaleGravityVal - Gravity quantity

    • setPRADivisionOfInterestNmbr

      public void setPRADivisionOfInterestNmbr(@Nullable String pRADivisionOfInterestNmbr)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: PRADivisionOfInterestNmbr

      Parameters:
      pRADivisionOfInterestNmbr - Division of Interest Number

    • getEntityCollection

      protected String getEntityCollection()
      Specified by:
      getEntityCollection in class VdmEntity<ScaleHdr>

    • getKey

      @Nonnull protected ODataEntityKey getKey()
      Overrides:
      getKey in class VdmObject<ScaleHdr>

    • toMapOfFields

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

    • fromMap

      protected void fromMap(Map<String,Object> inputValues)
      Overrides:
      fromMap in class VdmObject<ScaleHdr>

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • getPRAMaintDOIHierNodeIfPresent

      @Nonnull public io.vavr.control.Option<DOI> getPRAMaintDOIHierNodeIfPresent()
      Retrieval of associated DOI entity (one to one). This corresponds to the OData navigation property _PRAMaintDOIHierNode.

      If the navigation property for an entity ScaleHdr 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 _PRAMaintDOIHierNode is already loaded, the result will contain the DOI entity. If not, an Option with result state empty is returned.

    • setPRAMaintDOIHierNode

      public void setPRAMaintDOIHierNode(DOI value)
      Overwrites the associated DOI entity for the loaded navigation property _PRAMaintDOIHierNode.
      Parameters:
      value - New DOI entity.

    • getPRAMaintDOIOwnerHierNodeIfPresent

      @Nonnull public io.vavr.control.Option<DOIOwner> getPRAMaintDOIOwnerHierNodeIfPresent()
      Retrieval of associated DOIOwner entity (one to one). This corresponds to the OData navigation property _PRAMaintDOIOwnerHierNode.

      If the navigation property for an entity ScaleHdr 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 _PRAMaintDOIOwnerHierNode is already loaded, the result will contain the DOIOwner entity. If not, an Option with result state empty is returned.

    • setPRAMaintDOIOwnerHierNode

      public void setPRAMaintDOIOwnerHierNode(DOIOwner value)
      Overwrites the associated DOIOwner entity for the loaded navigation property _PRAMaintDOIOwnerHierNode.
      Parameters:
      value - New DOIOwner entity.

    • getPRAMaintSlidingScaleHierNodeIfPresent

      @Nonnull public io.vavr.control.Option<List<Scale>> getPRAMaintSlidingScaleHierNodeIfPresent()
      Retrieval of associated Scale entities (one to many). This corresponds to the OData navigation property _PRAMaintSlidingScaleHierNode.

      If the navigation property for an entity ScaleHdr 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 _PRAMaintSlidingScaleHierNode is already loaded, the result will contain the Scale entities. If not, an Option with result state empty is returned.

    • setPRAMaintSlidingScaleHierNode

      public void setPRAMaintSlidingScaleHierNode(@Nonnull List<Scale> value)
      Overwrites the list of associated Scale entities for the loaded navigation property _PRAMaintSlidingScaleHierNode.

      If the navigation property _PRAMaintSlidingScaleHierNode of a queried ScaleHdr 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 Scale entities.

    • addPRAMaintSlidingScaleHierNode

      public void addPRAMaintSlidingScaleHierNode(Scale... entity)
      Adds elements to the list of associated Scale entities. This corresponds to the OData navigation property _PRAMaintSlidingScaleHierNode.

      If the navigation property _PRAMaintSlidingScaleHierNode of a queried ScaleHdr 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 Scale entities.

    • builder

      @Nonnull public static ScaleHdr.ScaleHdrBuilder builder()

    • getCompanyCode

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

      Original property name from the Odata EDM: CompanyCode

      Returns:
      Company Code

    • getPRAJointVenture

      @Nullable public String getPRAJointVenture()
      (Key Field) Constraints: Not nullable, Maximum length: 6

      Original property name from the Odata EDM: PRAJointVenture

      Returns:
      Joint Venture

    • getDivisionOfInterest

      @Nullable public String getDivisionOfInterest()
      (Key Field) Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: DivisionOfInterest

      Returns:
      Division of Interest (DOI)

    • getPRACustomerSupplierCode

      @Nullable public String getPRACustomerSupplierCode()
      (Key Field) Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: PRACustomerSupplierCode

      Returns:
      Customer/Vendor Indicator

    • getPRAOwner

      @Nullable public String getPRAOwner()
      (Key Field) Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: PRAOwner

      Returns:
      PRA owner

    • getOwnerInterestType

      @Nullable public String getOwnerInterestType()
      (Key Field) Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: OwnerInterestType

      Returns:
      Participant Interest Type

    • getOwnerInterestSequence

      @Nullable public String getOwnerInterestSequence()
      (Key Field) Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: OwnerInterestSequence

      Returns:
      Owner Interest Sequence Number

    • getDOIOwnerEffectiveFromDate

      @Nullable public LocalDate getDOIOwnerEffectiveFromDate()
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: DOIOwnerEffectiveFromDate

      Returns:
      Effective from date

    • getPRASlidingScaleNumber

      @Nullable public String getPRASlidingScaleNumber()
      (Key Field) Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: PRASlidingScaleNumber

      Returns:
      Sliding scale number

    • getPRASlidingScComprnOptrCode

      @Nullable public String getPRASlidingScComprnOptrCode()
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: PRASlidingScComprnOptrCode

      Returns:
      Less than / greater than / equal to code

    • getPRASlidingScaleMethod

      @Nullable public String getPRASlidingScaleMethod()
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: PRASlidingScaleMethod

      Returns:
      Sliding scale method

    • getPRASlidingScaleRangeCode

      @Nullable public String getPRASlidingScaleRangeCode()
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: PRASlidingScaleRangeCode

      Returns:
      Volume range code

    • getPRASlidingScaleGravityVal

      @Nullable public BigDecimal getPRASlidingScaleGravityVal()
      Constraints: Not nullable, Precision: 3, Scale: 1

      Original property name from the Odata EDM: PRASlidingScaleGravityVal

      Returns:
      Gravity quantity

    • getPRADivisionOfInterestNmbr

      @Nullable public String getPRADivisionOfInterestNmbr()
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: PRADivisionOfInterestNmbr

      Returns:
      Division of Interest Number

    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class VdmObject<ScaleHdr>

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class VdmEntity<ScaleHdr>

    • canEqual

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

    • hashCode

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

    • getOdataType

      public String getOdataType()
      Specified by:
      getOdataType in class VdmObject<ScaleHdr>