java.lang.Object
com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odatav4.core.VdmEntity<ContractMarketingHeader>
com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.productionrevenueaccountingcontractmarketingcost.ContractMarketingHeader
All Implemented Interfaces:
VdmEntitySet

public class ContractMarketingHeader extends VdmEntity<ContractMarketingHeader> implements VdmEntitySet
PRA Contract Mktg Cost Header CVew

Original entity name from the Odata EDM: ContractMarketingHeader_Type

  • Field Details

  • Constructor Details

  • Method Details

    • getType

      @Nonnull public Class<ContractMarketingHeader> getType()
      Specified by:
      getType in class VdmObject<ContractMarketingHeader>
    • setPRAContract

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

      Original property name from the Odata EDM: PRAContract

      Parameters:
      pRAContract - Contract Number
    • setMeasurementPoint

      public void setMeasurementPoint(@Nullable String measurementPoint)
      (Key Field) Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: MeasurementPoint

      Parameters:
      measurementPoint - Measurement point number
    • setWell

      public void setWell(@Nullable String well)
      (Key Field) Constraints: Not nullable, Maximum length: 15

      Original property name from the Odata EDM: Well

      Parameters:
      well - Well ID number
    • setWellCompletion

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

      Original property name from the Odata EDM: WellCompletion

      Parameters:
      wellCompletion - Well Completion Number
    • setPRAMaterial

      public void setPRAMaterial(@Nullable String pRAMaterial)
      (Key Field) Constraints: Not nullable, Maximum length: 18

      Original property name from the Odata EDM: PRAMaterial

      Parameters:
      pRAMaterial - Material Number
    • setEffectiveFromDate

      public void setEffectiveFromDate(@Nullable LocalDate effectiveFromDate)
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: EffectiveFromDate

      Parameters:
      effectiveFromDate - Effective from date
    • setEffectiveToDate

      public void setEffectiveToDate(@Nullable LocalDate effectiveToDate)
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: EffectiveToDate

      Parameters:
      effectiveToDate - Effective To Date
    • setContractMarketingCostControl

      public void setContractMarketingCostControl(@Nullable String contractMarketingCostControl)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: ContractMarketingCostControl

      Parameters:
      contractMarketingCostControl - Contract Marketing Cost Control
    • setCreatedByUser

      public void setCreatedByUser(@Nullable String createdByUser)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: CreatedByUser

      Parameters:
      createdByUser - Name of Person Responsible for Creating the Object
    • setPRACreationDateTime

      public void setPRACreationDateTime(@Nullable OffsetDateTime pRACreationDateTime)
      Constraints: Nullable

      Original property name from the Odata EDM: PRACreationDateTime

      Parameters:
      pRACreationDateTime - UTC Time Stamp in Short Form (YYYYMMDDhhmmss)
    • setOriginTransaction

      public void setOriginTransaction(@Nullable String originTransaction)
      Constraints: Not nullable, Maximum length: 32

      Original property name from the Odata EDM: OriginTransaction

      Parameters:
      originTransaction - Source Transaction ID
    • set_Messages

      public void set_Messages(@Nullable Collection<SAP__Message> _Messages)
      Constraints: Not nullable

      Original property name from the Odata EDM: SAP__Messages

      Parameters:
      _Messages - The _Messages to set.
    • getEntityCollection

      protected String getEntityCollection()
      Specified by:
      getEntityCollection in class VdmEntity<ContractMarketingHeader>
    • getKey

      @Nonnull protected ODataEntityKey getKey()
      Overrides:
      getKey in class VdmObject<ContractMarketingHeader>
    • toMapOfFields

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

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

      protected String getDefaultServicePath()
      Overrides:
      getDefaultServicePath in class VdmEntity<ContractMarketingHeader>
    • toMapOfNavigationProperties

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

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

      If the navigation property for an entity ContractMarketingHeader 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 _PRAContrMarketingDetTP is already loaded, the result will contain the ContractMarketingDetail entities. If not, an Option with result state empty is returned.
    • setPRAContrMarketingDetTP

      public void setPRAContrMarketingDetTP(@Nonnull List<ContractMarketingDetail> value)
      Overwrites the list of associated ContractMarketingDetail entities for the loaded navigation property _PRAContrMarketingDetTP.

      If the navigation property _PRAContrMarketingDetTP of a queried ContractMarketingHeader 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 ContractMarketingDetail entities.
    • addPRAContrMarketingDetTP

      public void addPRAContrMarketingDetTP(ContractMarketingDetail... entity)
      Adds elements to the list of associated ContractMarketingDetail entities. This corresponds to the OData navigation property _PRAContrMarketingDetTP.

      If the navigation property _PRAContrMarketingDetTP of a queried ContractMarketingHeader 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 ContractMarketingDetail entities.
    • updateContractMarketingHeader

      @Nonnull public static BoundAction.CollectionToCollection<ContractMarketingHeader,UpdateWithPRAKeysResult_Type> updateContractMarketingHeader(@Nonnull String pRAContract, @Nonnull String measurementPoint, @Nonnull String well, @Nonnull String wellCompletion, @Nonnull String pRAMaterial, @Nullable LocalDate effectiveFromDate, @Nullable LocalDate effectiveToDate, @Nonnull String contractMarketingCostControl, @Nonnull Collection<D_PRAContrMktgCostDetUpdtP> _PRAContrMarketingDetTP)
      Action that can be applied to a collection of entities of this class.

      Parameters:
      pRAMaterial - Constraints: Not nullable, Maximum length: 40

      Original parameter name from the Odata EDM: PRAMaterial

      pRAContract - Constraints: Not nullable, Maximum length: 10

      Original parameter name from the Odata EDM: PRAContract

      _PRAContrMarketingDetTP - Constraints: Not nullable

      Original parameter name from the Odata EDM: _PRAContrMarketingDetTP

      effectiveToDate - Constraints: Nullable

      Original parameter name from the Odata EDM: EffectiveToDate

      well - Constraints: Not nullable, Maximum length: 15

      Original parameter name from the Odata EDM: Well

      contractMarketingCostControl - Constraints: Not nullable, Maximum length: 12

      Original parameter name from the Odata EDM: ContractMarketingCostControl

      effectiveFromDate - Constraints: Nullable

      Original parameter name from the Odata EDM: EffectiveFromDate

      measurementPoint - Constraints: Not nullable, Maximum length: 20

      Original parameter name from the Odata EDM: MeasurementPoint

      wellCompletion - Constraints: Not nullable, Maximum length: 5

      Original parameter name from the Odata EDM: WellCompletion

      Returns:
      Action object prepared with the given parameters to be applied to a collection of entities of this class.

      To execute it use the service.forEntity(entity).applyAction(thisAction) API.
    • builder

    • getPRAContract

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

      Original property name from the Odata EDM: PRAContract

      Returns:
      Contract Number
    • getMeasurementPoint

      @Nullable public String getMeasurementPoint()
      (Key Field) Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: MeasurementPoint

      Returns:
      Measurement point number
    • getWell

      @Nullable public String getWell()
      (Key Field) Constraints: Not nullable, Maximum length: 15

      Original property name from the Odata EDM: Well

      Returns:
      Well ID number
    • getWellCompletion

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

      Original property name from the Odata EDM: WellCompletion

      Returns:
      Well Completion Number
    • getPRAMaterial

      @Nullable public String getPRAMaterial()
      (Key Field) Constraints: Not nullable, Maximum length: 18

      Original property name from the Odata EDM: PRAMaterial

      Returns:
      Material Number
    • getEffectiveFromDate

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

      Original property name from the Odata EDM: EffectiveFromDate

      Returns:
      Effective from date
    • getEffectiveToDate

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

      Original property name from the Odata EDM: EffectiveToDate

      Returns:
      Effective To Date
    • getContractMarketingCostControl

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

      Original property name from the Odata EDM: ContractMarketingCostControl

      Returns:
      Contract Marketing Cost Control
    • getCreatedByUser

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

      Original property name from the Odata EDM: CreatedByUser

      Returns:
      Name of Person Responsible for Creating the Object
    • getPRACreationDateTime

      @Nullable public OffsetDateTime getPRACreationDateTime()
      Constraints: Nullable

      Original property name from the Odata EDM: PRACreationDateTime

      Returns:
      UTC Time Stamp in Short Form (YYYYMMDDhhmmss)
    • getOriginTransaction

      @Nullable public String getOriginTransaction()
      Constraints: Not nullable, Maximum length: 32

      Original property name from the Odata EDM: OriginTransaction

      Returns:
      Source Transaction ID
    • get_Messages

      @Nullable public Collection<SAP__Message> get_Messages()
      Constraints: Not nullable

      Original property name from the Odata EDM: SAP__Messages

      Returns:
      The _Messages contained in this VdmEntity.
    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class VdmObject<ContractMarketingHeader>
    • equals

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

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

      public int hashCode()
      Overrides:
      hashCode in class VdmEntity<ContractMarketingHeader>
    • getOdataType

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