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

Class DOIOwner

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

Original entity name from the Odata EDM: DOIOwner_Type

  • Field Details

  • Constructor Details

    • DOIOwner

      public DOIOwner()

    • DOIOwner

      public DOIOwner(@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 LocalDate dOIOwnerEffectiveToDate, @Nullable String pRADivisionOfInterestNmbr, @Nullable Boolean ownerIsJntIntrstBilgEnabled, @Nullable BigDecimal netRevenueInterestRatio, @Nullable String suspenseReason, @Nullable String taxBasis, @Nullable String pRABearerGroup, @Nullable String pRAPayoutCode, @Nullable String ownerPaymentStatus, @Nullable String pRAEntitlementCode, @Nullable Boolean dOIOwnerIsSlidingScEnbld, @Nullable Boolean dOIOwnerIsPctOfProceedsEnbld, @Nullable Boolean dOIOwnerIsDualAcctgEnbld, @Nullable String pRALegalForm, @Nullable Boolean dOIOwnerHasAcctgEntrOvrrde, @Nullable String ownerInterestCategory, @Nullable LocalDate dOIOwnerMinRoyaltyDate, @Nullable String companyCodeCurrency, @Nullable BigDecimal dOIOwnerMinRoyaltyAmount, @Nullable String dOIOwnerAdvncArrearsPaytCode, @Nullable String dOIOwnerCarriedBearerGrpCode, @Nullable String dOIOwnerLeaseUsePaytCode, @Nullable String jntIntrstBilgPartner, @Nullable String dOIOwnerProdnPaytOwner, @Nullable Boolean dOIOwnrHasTakeInKindContrExprd, @Nullable Boolean dOIOwnerHasSettlmtDiversity, @Nullable String dOIOwnerLeaseID, @Nullable BigDecimal dOIOwnerNetMineralAcresVal, @Nullable BigDecimal grossRevenueInterestRatio, @Nullable String dOIOwnerRecdTitleBearerGrp, @Nullable String companyCodeName, @Nullable String divisionOfInterestName, @Nullable String pRACombinedProductCode, @Nullable String dOIOwnerName, @Nullable String ownerInterestTypeName, @Nullable String suspenseReasonName, @Nullable String taxBasisName, @Nullable String pRACombinedProductCodeName, @Nullable LocalDate divisionOfInterestStartDate, @Nullable String ownerPaymentStatusName, @Nullable String pRALegalFormName, @Nullable DOI to_PRAMaintDOIHierNode, List<DOITransfer> to_PRAMaintDOIOwnTransfHierNode, List<Mkex> to_PRAMaintMktgExemptHierNode, List<ScaleHdr> to_PRAMaintSlidingScHdrHierNode, List<Doex> to_PRAMaintStateTxExmptHierNode)

  • Method Details

    • getType

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

    • 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

    • setDOIOwnerEffectiveToDate

      public void setDOIOwnerEffectiveToDate(@Nullable LocalDate dOIOwnerEffectiveToDate)
      Constraints: Nullable

      Original property name from the Odata EDM: DOIOwnerEffectiveToDate

      Parameters:
      dOIOwnerEffectiveToDate - Effective To Date

    • 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

    • setOwnerIsJntIntrstBilgEnabled

      public void setOwnerIsJntIntrstBilgEnabled(@Nullable Boolean ownerIsJntIntrstBilgEnabled)
      Constraints: Not nullable

      Original property name from the Odata EDM: OwnerIsJntIntrstBilgEnabled

      Parameters:
      ownerIsJntIntrstBilgEnabled - Joint Interest Billing Offset Flag

    • setNetRevenueInterestRatio

      public void setNetRevenueInterestRatio(@Nullable BigDecimal netRevenueInterestRatio)
      Constraints: Not nullable, Precision: 9, Scale: 8

      Original property name from the Odata EDM: NetRevenueInterestRatio

      Parameters:
      netRevenueInterestRatio - Net Revenue Interest Percent

    • setSuspenseReason

      public void setSuspenseReason(@Nullable String suspenseReason)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: SuspenseReason

      Parameters:
      suspenseReason - Suspense Reason Code

    • setTaxBasis

      public void setTaxBasis(@Nullable String taxBasis)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: TaxBasis

      Parameters:
      taxBasis - Tax Free Code

    • setPRABearerGroup

      public void setPRABearerGroup(@Nullable String pRABearerGroup)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: PRABearerGroup

      Parameters:
      pRABearerGroup - Bearer Group Number

    • setPRAPayoutCode

      public void setPRAPayoutCode(@Nullable String pRAPayoutCode)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: PRAPayoutCode

      Parameters:
      pRAPayoutCode - Payout Code

    • setOwnerPaymentStatus

      public void setOwnerPaymentStatus(@Nullable String ownerPaymentStatus)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: OwnerPaymentStatus

      Parameters:
      ownerPaymentStatus - Pay Code

    • setPRAEntitlementCode

      public void setPRAEntitlementCode(@Nullable String pRAEntitlementCode)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: PRAEntitlementCode

      Parameters:
      pRAEntitlementCode - Entitlement Code

    • setDOIOwnerIsSlidingScEnbld

      public void setDOIOwnerIsSlidingScEnbld(@Nullable Boolean dOIOwnerIsSlidingScEnbld)
      Constraints: Not nullable

      Original property name from the Odata EDM: DOIOwnerIsSlidingScEnbld

      Parameters:
      dOIOwnerIsSlidingScEnbld - Sliding Scale Indicator Flag

    • setDOIOwnerIsPctOfProceedsEnbld

      public void setDOIOwnerIsPctOfProceedsEnbld(@Nullable Boolean dOIOwnerIsPctOfProceedsEnbld)
      Constraints: Not nullable

      Original property name from the Odata EDM: DOIOwnerIsPctOfProceedsEnbld

      Parameters:
      dOIOwnerIsPctOfProceedsEnbld - MMS Percent of Proceeds Flag

    • setDOIOwnerIsDualAcctgEnbld

      public void setDOIOwnerIsDualAcctgEnbld(@Nullable Boolean dOIOwnerIsDualAcctgEnbld)
      Constraints: Not nullable

      Original property name from the Odata EDM: DOIOwnerIsDualAcctgEnbld

      Parameters:
      dOIOwnerIsDualAcctgEnbld - Dual Accounting Flag

    • setPRALegalForm

      public void setPRALegalForm(@Nullable String pRALegalForm)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: PRALegalForm

      Parameters:
      pRALegalForm - Entity Code

    • setDOIOwnerHasAcctgEntrOvrrde

      public void setDOIOwnerHasAcctgEntrOvrrde(@Nullable Boolean dOIOwnerHasAcctgEntrOvrrde)
      Constraints: Not nullable

      Original property name from the Odata EDM: DOIOwnerHasAcctgEntrOvrrde

      Parameters:
      dOIOwnerHasAcctgEntrOvrrde - Accounting Entry Override Flag

    • setOwnerInterestCategory

      public void setOwnerInterestCategory(@Nullable String ownerInterestCategory)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: OwnerInterestCategory

      Parameters:
      ownerInterestCategory - Interest Category

    • setDOIOwnerMinRoyaltyDate

      public void setDOIOwnerMinRoyaltyDate(@Nullable LocalDate dOIOwnerMinRoyaltyDate)
      Constraints: Nullable

      Original property name from the Odata EDM: DOIOwnerMinRoyaltyDate

      Parameters:
      dOIOwnerMinRoyaltyDate - Minimum Royalty Date

    • setCompanyCodeCurrency

      public void setCompanyCodeCurrency(@Nullable String companyCodeCurrency)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: CompanyCodeCurrency

      Parameters:
      companyCodeCurrency - Currency Key

    • setDOIOwnerMinRoyaltyAmount

      public void setDOIOwnerMinRoyaltyAmount(@Nullable BigDecimal dOIOwnerMinRoyaltyAmount)
      Constraints: Not nullable, Precision: 7, Scale: 0

      Original property name from the Odata EDM: DOIOwnerMinRoyaltyAmount

      Parameters:
      dOIOwnerMinRoyaltyAmount - Minimum Royalty Amount

    • setDOIOwnerAdvncArrearsPaytCode

      public void setDOIOwnerAdvncArrearsPaytCode(@Nullable String dOIOwnerAdvncArrearsPaytCode)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: DOIOwnerAdvncArrearsPaytCode

      Parameters:
      dOIOwnerAdvncArrearsPaytCode - Advance Arrears Payment Code

    • setDOIOwnerCarriedBearerGrpCode

      public void setDOIOwnerCarriedBearerGrpCode(@Nullable String dOIOwnerCarriedBearerGrpCode)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: DOIOwnerCarriedBearerGrpCode

      Parameters:
      dOIOwnerCarriedBearerGrpCode - Carried bearer group code

    • setDOIOwnerLeaseUsePaytCode

      public void setDOIOwnerLeaseUsePaytCode(@Nullable String dOIOwnerLeaseUsePaytCode)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: DOIOwnerLeaseUsePaytCode

      Parameters:
      dOIOwnerLeaseUsePaytCode - Pay on Lease Use Fuel

    • setJntIntrstBilgPartner

      public void setJntIntrstBilgPartner(@Nullable String jntIntrstBilgPartner)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: JntIntrstBilgPartner

      Parameters:
      jntIntrstBilgPartner - JIB Partner

    • setDOIOwnerProdnPaytOwner

      public void setDOIOwnerProdnPaytOwner(@Nullable String dOIOwnerProdnPaytOwner)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: DOIOwnerProdnPaytOwner

      Parameters:
      dOIOwnerProdnPaytOwner - Production Payment Owner

    • setDOIOwnrHasTakeInKindContrExprd

      public void setDOIOwnrHasTakeInKindContrExprd(@Nullable Boolean dOIOwnrHasTakeInKindContrExprd)
      Constraints: Not nullable

      Original property name from the Odata EDM: DOIOwnrHasTakeInKindContrExprd

      Parameters:
      dOIOwnrHasTakeInKindContrExprd - MMS Reconciliation Flag

    • setDOIOwnerHasSettlmtDiversity

      public void setDOIOwnerHasSettlmtDiversity(@Nullable Boolean dOIOwnerHasSettlmtDiversity)
      Constraints: Not nullable

      Original property name from the Odata EDM: DOIOwnerHasSettlmtDiversity

      Parameters:
      dOIOwnerHasSettlmtDiversity - Owner Settlement Diversity Indicator

    • setDOIOwnerLeaseID

      public void setDOIOwnerLeaseID(@Nullable String dOIOwnerLeaseID)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: DOIOwnerLeaseID

      Parameters:
      dOIOwnerLeaseID - Lease ID for an owner

    • setDOIOwnerNetMineralAcresVal

      public void setDOIOwnerNetMineralAcresVal(@Nullable BigDecimal dOIOwnerNetMineralAcresVal)
      Constraints: Not nullable, Precision: 14, Scale: 6

      Original property name from the Odata EDM: DOIOwnerNetMineralAcresVal

      Parameters:
      dOIOwnerNetMineralAcresVal - Net Mineral Acres

    • setGrossRevenueInterestRatio

      public void setGrossRevenueInterestRatio(@Nullable BigDecimal grossRevenueInterestRatio)
      Constraints: Not nullable, Precision: 9, Scale: 8

      Original property name from the Odata EDM: GrossRevenueInterestRatio

      Parameters:
      grossRevenueInterestRatio - Gross Revenue Interest Decimal

    • setDOIOwnerRecdTitleBearerGrp

      public void setDOIOwnerRecdTitleBearerGrp(@Nullable String dOIOwnerRecdTitleBearerGrp)
      Constraints: Not nullable, Maximum length: 2

      Original property name from the Odata EDM: DOIOwnerRecdTitleBearerGrp

      Parameters:
      dOIOwnerRecdTitleBearerGrp - Record Title Bearer Group Number

    • setCompanyCodeName

      public void setCompanyCodeName(@Nullable String companyCodeName)
      Constraints: Not nullable, Maximum length: 25

      Original property name from the Odata EDM: CompanyCodeName

      Parameters:
      companyCodeName - Name of Company Code or Company

    • setDivisionOfInterestName

      public void setDivisionOfInterestName(@Nullable String divisionOfInterestName)
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: DivisionOfInterestName

      Parameters:
      divisionOfInterestName - Division of Interest Name

    • setPRACombinedProductCode

      public void setPRACombinedProductCode(@Nullable String pRACombinedProductCode)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: PRACombinedProductCode

      Parameters:
      pRACombinedProductCode - Combined product code

    • setDOIOwnerName

      public void setDOIOwnerName(@Nullable String dOIOwnerName)
      Constraints: Not nullable, Maximum length: 80

      Original property name from the Odata EDM: DOIOwnerName

      Parameters:
      dOIOwnerName - Name of Owner

    • setOwnerInterestTypeName

      public void setOwnerInterestTypeName(@Nullable String ownerInterestTypeName)
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: OwnerInterestTypeName

      Parameters:
      ownerInterestTypeName - Participant Interest Type Description

    • setSuspenseReasonName

      public void setSuspenseReasonName(@Nullable String suspenseReasonName)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: SuspenseReasonName

      Parameters:
      suspenseReasonName - Suspense Reason Description

    • setTaxBasisName

      public void setTaxBasisName(@Nullable String taxBasisName)
      Constraints: Not nullable, Maximum length: 50

      Original property name from the Odata EDM: TaxBasisName

      Parameters:
      taxBasisName - Tax Free Code Description

    • setPRACombinedProductCodeName

      public void setPRACombinedProductCodeName(@Nullable String pRACombinedProductCodeName)
      Constraints: Not nullable, Maximum length: 50

      Original property name from the Odata EDM: PRACombinedProductCodeName

      Parameters:
      pRACombinedProductCodeName - General Description - 50 Characters

    • setDivisionOfInterestStartDate

      public void setDivisionOfInterestStartDate(@Nullable LocalDate divisionOfInterestStartDate)
      Constraints: Nullable

      Original property name from the Odata EDM: DivisionOfInterestStartDate

      Parameters:
      divisionOfInterestStartDate - Start date

    • setOwnerPaymentStatusName

      public void setOwnerPaymentStatusName(@Nullable String ownerPaymentStatusName)
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: OwnerPaymentStatusName

      Parameters:
      ownerPaymentStatusName - Owner Pay Code Name

    • setPRALegalFormName

      public void setPRALegalFormName(@Nullable String pRALegalFormName)
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: PRALegalFormName

      Parameters:
      pRALegalFormName - Valuation Document Status Name

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • 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 DOIOwner 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.

    • getPRAMaintDOIOwnTransfHierNodeIfPresent

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

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

    • setPRAMaintDOIOwnTransfHierNode

      public void setPRAMaintDOIOwnTransfHierNode(@Nonnull List<DOITransfer> value)
      Overwrites the list of associated DOITransfer entities for the loaded navigation property _PRAMaintDOIOwnTransfHierNode.

      If the navigation property _PRAMaintDOIOwnTransfHierNode of a queried DOIOwner 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 DOITransfer entities.

    • addPRAMaintDOIOwnTransfHierNode

      public void addPRAMaintDOIOwnTransfHierNode(DOITransfer... entity)
      Adds elements to the list of associated DOITransfer entities. This corresponds to the OData navigation property _PRAMaintDOIOwnTransfHierNode.

      If the navigation property _PRAMaintDOIOwnTransfHierNode of a queried DOIOwner 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 DOITransfer entities.

    • getPRAMaintMktgExemptHierNodeIfPresent

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

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

    • setPRAMaintMktgExemptHierNode

      public void setPRAMaintMktgExemptHierNode(@Nonnull List<Mkex> value)
      Overwrites the list of associated Mkex entities for the loaded navigation property _PRAMaintMktgExemptHierNode.

      If the navigation property _PRAMaintMktgExemptHierNode of a queried DOIOwner 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 Mkex entities.

    • addPRAMaintMktgExemptHierNode

      public void addPRAMaintMktgExemptHierNode(Mkex... entity)
      Adds elements to the list of associated Mkex entities. This corresponds to the OData navigation property _PRAMaintMktgExemptHierNode.

      If the navigation property _PRAMaintMktgExemptHierNode of a queried DOIOwner 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 Mkex entities.

    • getPRAMaintSlidingScHdrHierNodeIfPresent

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

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

    • setPRAMaintSlidingScHdrHierNode

      public void setPRAMaintSlidingScHdrHierNode(@Nonnull List<ScaleHdr> value)
      Overwrites the list of associated ScaleHdr entities for the loaded navigation property _PRAMaintSlidingScHdrHierNode.

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

    • addPRAMaintSlidingScHdrHierNode

      public void addPRAMaintSlidingScHdrHierNode(ScaleHdr... entity)
      Adds elements to the list of associated ScaleHdr entities. This corresponds to the OData navigation property _PRAMaintSlidingScHdrHierNode.

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

    • getPRAMaintStateTxExmptHierNodeIfPresent

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

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

    • setPRAMaintStateTxExmptHierNode

      public void setPRAMaintStateTxExmptHierNode(@Nonnull List<Doex> value)
      Overwrites the list of associated Doex entities for the loaded navigation property _PRAMaintStateTxExmptHierNode.

      If the navigation property _PRAMaintStateTxExmptHierNode of a queried DOIOwner 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 Doex entities.

    • addPRAMaintStateTxExmptHierNode

      public void addPRAMaintStateTxExmptHierNode(Doex... entity)
      Adds elements to the list of associated Doex entities. This corresponds to the OData navigation property _PRAMaintStateTxExmptHierNode.

      If the navigation property _PRAMaintStateTxExmptHierNode of a queried DOIOwner 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 Doex entities.

    • builder

      @Nonnull public static DOIOwner.DOIOwnerBuilder 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

    • getDOIOwnerEffectiveToDate

      @Nullable public LocalDate getDOIOwnerEffectiveToDate()
      Constraints: Nullable

      Original property name from the Odata EDM: DOIOwnerEffectiveToDate

      Returns:
      Effective To Date

    • getPRADivisionOfInterestNmbr

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

      Original property name from the Odata EDM: PRADivisionOfInterestNmbr

      Returns:
      Division of Interest Number

    • getOwnerIsJntIntrstBilgEnabled

      @Nullable public Boolean getOwnerIsJntIntrstBilgEnabled()
      Constraints: Not nullable

      Original property name from the Odata EDM: OwnerIsJntIntrstBilgEnabled

      Returns:
      Joint Interest Billing Offset Flag

    • getNetRevenueInterestRatio

      @Nullable public BigDecimal getNetRevenueInterestRatio()
      Constraints: Not nullable, Precision: 9, Scale: 8

      Original property name from the Odata EDM: NetRevenueInterestRatio

      Returns:
      Net Revenue Interest Percent

    • getSuspenseReason

      @Nullable public String getSuspenseReason()
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: SuspenseReason

      Returns:
      Suspense Reason Code

    • getTaxBasis

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

      Original property name from the Odata EDM: TaxBasis

      Returns:
      Tax Free Code

    • getPRABearerGroup

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

      Original property name from the Odata EDM: PRABearerGroup

      Returns:
      Bearer Group Number

    • getPRAPayoutCode

      @Nullable public String getPRAPayoutCode()
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: PRAPayoutCode

      Returns:
      Payout Code

    • getOwnerPaymentStatus

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

      Original property name from the Odata EDM: OwnerPaymentStatus

      Returns:
      Pay Code

    • getPRAEntitlementCode

      @Nullable public String getPRAEntitlementCode()
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: PRAEntitlementCode

      Returns:
      Entitlement Code

    • getDOIOwnerIsSlidingScEnbld

      @Nullable public Boolean getDOIOwnerIsSlidingScEnbld()
      Constraints: Not nullable

      Original property name from the Odata EDM: DOIOwnerIsSlidingScEnbld

      Returns:
      Sliding Scale Indicator Flag

    • getDOIOwnerIsPctOfProceedsEnbld

      @Nullable public Boolean getDOIOwnerIsPctOfProceedsEnbld()
      Constraints: Not nullable

      Original property name from the Odata EDM: DOIOwnerIsPctOfProceedsEnbld

      Returns:
      MMS Percent of Proceeds Flag

    • getDOIOwnerIsDualAcctgEnbld

      @Nullable public Boolean getDOIOwnerIsDualAcctgEnbld()
      Constraints: Not nullable

      Original property name from the Odata EDM: DOIOwnerIsDualAcctgEnbld

      Returns:
      Dual Accounting Flag

    • getPRALegalForm

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

      Original property name from the Odata EDM: PRALegalForm

      Returns:
      Entity Code

    • getDOIOwnerHasAcctgEntrOvrrde

      @Nullable public Boolean getDOIOwnerHasAcctgEntrOvrrde()
      Constraints: Not nullable

      Original property name from the Odata EDM: DOIOwnerHasAcctgEntrOvrrde

      Returns:
      Accounting Entry Override Flag

    • getOwnerInterestCategory

      @Nullable public String getOwnerInterestCategory()
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: OwnerInterestCategory

      Returns:
      Interest Category

    • getDOIOwnerMinRoyaltyDate

      @Nullable public LocalDate getDOIOwnerMinRoyaltyDate()
      Constraints: Nullable

      Original property name from the Odata EDM: DOIOwnerMinRoyaltyDate

      Returns:
      Minimum Royalty Date

    • getCompanyCodeCurrency

      @Nullable public String getCompanyCodeCurrency()
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: CompanyCodeCurrency

      Returns:
      Currency Key

    • getDOIOwnerMinRoyaltyAmount

      @Nullable public BigDecimal getDOIOwnerMinRoyaltyAmount()
      Constraints: Not nullable, Precision: 7, Scale: 0

      Original property name from the Odata EDM: DOIOwnerMinRoyaltyAmount

      Returns:
      Minimum Royalty Amount

    • getDOIOwnerAdvncArrearsPaytCode

      @Nullable public String getDOIOwnerAdvncArrearsPaytCode()
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: DOIOwnerAdvncArrearsPaytCode

      Returns:
      Advance Arrears Payment Code

    • getDOIOwnerCarriedBearerGrpCode

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

      Original property name from the Odata EDM: DOIOwnerCarriedBearerGrpCode

      Returns:
      Carried bearer group code

    • getDOIOwnerLeaseUsePaytCode

      @Nullable public String getDOIOwnerLeaseUsePaytCode()
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: DOIOwnerLeaseUsePaytCode

      Returns:
      Pay on Lease Use Fuel

    • getJntIntrstBilgPartner

      @Nullable public String getJntIntrstBilgPartner()
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: JntIntrstBilgPartner

      Returns:
      JIB Partner

    • getDOIOwnerProdnPaytOwner

      @Nullable public String getDOIOwnerProdnPaytOwner()
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: DOIOwnerProdnPaytOwner

      Returns:
      Production Payment Owner

    • getDOIOwnrHasTakeInKindContrExprd

      @Nullable public Boolean getDOIOwnrHasTakeInKindContrExprd()
      Constraints: Not nullable

      Original property name from the Odata EDM: DOIOwnrHasTakeInKindContrExprd

      Returns:
      MMS Reconciliation Flag

    • getDOIOwnerHasSettlmtDiversity

      @Nullable public Boolean getDOIOwnerHasSettlmtDiversity()
      Constraints: Not nullable

      Original property name from the Odata EDM: DOIOwnerHasSettlmtDiversity

      Returns:
      Owner Settlement Diversity Indicator

    • getDOIOwnerLeaseID

      @Nullable public String getDOIOwnerLeaseID()
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: DOIOwnerLeaseID

      Returns:
      Lease ID for an owner

    • getDOIOwnerNetMineralAcresVal

      @Nullable public BigDecimal getDOIOwnerNetMineralAcresVal()
      Constraints: Not nullable, Precision: 14, Scale: 6

      Original property name from the Odata EDM: DOIOwnerNetMineralAcresVal

      Returns:
      Net Mineral Acres

    • getGrossRevenueInterestRatio

      @Nullable public BigDecimal getGrossRevenueInterestRatio()
      Constraints: Not nullable, Precision: 9, Scale: 8

      Original property name from the Odata EDM: GrossRevenueInterestRatio

      Returns:
      Gross Revenue Interest Decimal

    • getDOIOwnerRecdTitleBearerGrp

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

      Original property name from the Odata EDM: DOIOwnerRecdTitleBearerGrp

      Returns:
      Record Title Bearer Group Number

    • getCompanyCodeName

      @Nullable public String getCompanyCodeName()
      Constraints: Not nullable, Maximum length: 25

      Original property name from the Odata EDM: CompanyCodeName

      Returns:
      Name of Company Code or Company

    • getDivisionOfInterestName

      @Nullable public String getDivisionOfInterestName()
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: DivisionOfInterestName

      Returns:
      Division of Interest Name

    • getPRACombinedProductCode

      @Nullable public String getPRACombinedProductCode()
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: PRACombinedProductCode

      Returns:
      Combined product code

    • getDOIOwnerName

      @Nullable public String getDOIOwnerName()
      Constraints: Not nullable, Maximum length: 80

      Original property name from the Odata EDM: DOIOwnerName

      Returns:
      Name of Owner

    • getOwnerInterestTypeName

      @Nullable public String getOwnerInterestTypeName()
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: OwnerInterestTypeName

      Returns:
      Participant Interest Type Description

    • getSuspenseReasonName

      @Nullable public String getSuspenseReasonName()
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: SuspenseReasonName

      Returns:
      Suspense Reason Description

    • getTaxBasisName

      @Nullable public String getTaxBasisName()
      Constraints: Not nullable, Maximum length: 50

      Original property name from the Odata EDM: TaxBasisName

      Returns:
      Tax Free Code Description

    • getPRACombinedProductCodeName

      @Nullable public String getPRACombinedProductCodeName()
      Constraints: Not nullable, Maximum length: 50

      Original property name from the Odata EDM: PRACombinedProductCodeName

      Returns:
      General Description - 50 Characters

    • getDivisionOfInterestStartDate

      @Nullable public LocalDate getDivisionOfInterestStartDate()
      Constraints: Nullable

      Original property name from the Odata EDM: DivisionOfInterestStartDate

      Returns:
      Start date

    • getOwnerPaymentStatusName

      @Nullable public String getOwnerPaymentStatusName()
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: OwnerPaymentStatusName

      Returns:
      Owner Pay Code Name

    • getPRALegalFormName

      @Nullable public String getPRALegalFormName()
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: PRALegalFormName

      Returns:
      Valuation Document Status Name

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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

    • getOdataType

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