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

Class CABillgPln

java.lang.Object
com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odatav4.core.VdmEntity<CABillgPln>
com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.convergentinvoicingbillingplan.CABillgPln
All Implemented Interfaces:
VdmEntitySet
public class CABillgPln extends VdmEntity<CABillgPln> implements VdmEntitySet
Billing Plan

Original entity name from the Odata EDM: CABillgPln_Type

  • Field Details

  • Constructor Details

    • CABillgPln

      public CABillgPln()

    • CABillgPln

      public CABillgPln(@Nullable String cABillgPlnNumber, @Nullable String cABillgPlnCategory, @Nullable String cABillgPlnType, @Nullable String cABillgPlnStatus, @Nullable LocalDate cABillgPlnStartDate, @Nullable LocalDate cABillgPlnEndDate, @Nullable LocalDate cABillgPlnLastRequestDate, @Nullable LocalDate cABillgPlnNextRequestDate, @Nullable String cABillgPlnDescription, @Nullable String cABillgPlnExternalReference, @Nullable String logicalSystem, @Nullable String cAApplicationArea, @Nullable String businessPartner, @Nullable String contractAccount, @Nullable String cAInvcgMasterDataType, @Nullable String cAContract, @Nullable UUID cAProviderContractItemUUID, @Nullable String cASubApplication, @Nullable String cAMasterAgreement, @Nullable String cAInvcgOffsettingReferenceKey, @Nullable String cABillgPlnCreatedByUser, @Nullable LocalDate cABillgPlnCreationDate, @Nullable LocalTime cABillgPlnCreationTime, @Nullable String cABillgPlnChangedByUser, @Nullable LocalDate cABillgPlnChangeDate, @Nullable LocalTime cABillgPlnChangeTime, @Nullable String cABillgPlnCreationMode, @Nullable String cABillgPlnNumberBllbleItm, @Nullable LocalDate cABillgPlnCompletionDate, @Nullable Boolean cABillgPlnIsTemplate, @Nullable Collection<SAP__Message> _Messages, List<CABillgPlnItem> to_CABillgPlnItem)

  • Method Details

    • getType

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

    • setCABillgPlnNumber

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

      Original property name from the Odata EDM: CABillgPlnNumber

      Parameters:
      cABillgPlnNumber - Billing Plan Number

    • setCABillgPlnCategory

      public void setCABillgPlnCategory(@Nullable String cABillgPlnCategory)
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: CABillgPlnCategory

      Parameters:
      cABillgPlnCategory - Billing Plan Category

    • setCABillgPlnType

      public void setCABillgPlnType(@Nullable String cABillgPlnType)
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: CABillgPlnType

      Parameters:
      cABillgPlnType - Billing Plan Type

    • setCABillgPlnStatus

      public void setCABillgPlnStatus(@Nullable String cABillgPlnStatus)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: CABillgPlnStatus

      Parameters:
      cABillgPlnStatus - Status of Billing Plan

    • setCABillgPlnStartDate

      public void setCABillgPlnStartDate(@Nullable LocalDate cABillgPlnStartDate)
      Constraints: Nullable

      Original property name from the Odata EDM: CABillgPlnStartDate

      Parameters:
      cABillgPlnStartDate - Valid From

    • setCABillgPlnEndDate

      public void setCABillgPlnEndDate(@Nullable LocalDate cABillgPlnEndDate)
      Constraints: Nullable

      Original property name from the Odata EDM: CABillgPlnEndDate

      Parameters:
      cABillgPlnEndDate - Valid To

    • setCABillgPlnLastRequestDate

      public void setCABillgPlnLastRequestDate(@Nullable LocalDate cABillgPlnLastRequestDate)
      Constraints: Nullable

      Original property name from the Odata EDM: CABillgPlnLastRequestDate

      Parameters:
      cABillgPlnLastRequestDate - Last Reqest Date for Billing Plan Items

    • setCABillgPlnNextRequestDate

      public void setCABillgPlnNextRequestDate(@Nullable LocalDate cABillgPlnNextRequestDate)
      Constraints: Nullable

      Original property name from the Odata EDM: CABillgPlnNextRequestDate

      Parameters:
      cABillgPlnNextRequestDate - Next Request Date of Billing Plan Items

    • setCABillgPlnDescription

      public void setCABillgPlnDescription(@Nullable String cABillgPlnDescription)
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: CABillgPlnDescription

      Parameters:
      cABillgPlnDescription - Description of Billing Plan

    • setCABillgPlnExternalReference

      public void setCABillgPlnExternalReference(@Nullable String cABillgPlnExternalReference)
      Constraints: Not nullable, Maximum length: 32

      Original property name from the Odata EDM: CABillgPlnExternalReference

      Parameters:
      cABillgPlnExternalReference - External Reference of Billing Plan

    • setLogicalSystem

      public void setLogicalSystem(@Nullable String logicalSystem)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: LogicalSystem

      Parameters:
      logicalSystem - Logical System

    • setCAApplicationArea

      public void setCAApplicationArea(@Nullable String cAApplicationArea)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: CAApplicationArea

      Parameters:
      cAApplicationArea - Application area

    • setBusinessPartner

      public void setBusinessPartner(@Nullable String businessPartner)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: BusinessPartner

      Parameters:
      businessPartner - Business Partner Number

    • setContractAccount

      public void setContractAccount(@Nullable String contractAccount)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: ContractAccount

      Parameters:
      contractAccount - Contract Account Number

    • setCAInvcgMasterDataType

      public void setCAInvcgMasterDataType(@Nullable String cAInvcgMasterDataType)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: CAInvcgMasterDataType

      Parameters:
      cAInvcgMasterDataType - Type of Master Record for Convergent Invoicing

    • setCAContract

      public void setCAContract(@Nullable String cAContract)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: CAContract

      Parameters:
      cAContract - Reference Specifications from Contract

    • setCAProviderContractItemUUID

      public void setCAProviderContractItemUUID(@Nullable UUID cAProviderContractItemUUID)
      Constraints: Nullable

      Original property name from the Odata EDM: CAProviderContractItemUUID

      Parameters:
      cAProviderContractItemUUID - External GUID of Provider Contract Items

    • setCASubApplication

      public void setCASubApplication(@Nullable String cASubApplication)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: CASubApplication

      Parameters:
      cASubApplication - Subapplication in Contract Accounts Receivable and Payable

    • setCAMasterAgreement

      public void setCAMasterAgreement(@Nullable String cAMasterAgreement)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: CAMasterAgreement

      Parameters:
      cAMasterAgreement - Identification of Master Agreement

    • setCAInvcgOffsettingReferenceKey

      public void setCAInvcgOffsettingReferenceKey(@Nullable String cAInvcgOffsettingReferenceKey)
      Constraints: Not nullable, Maximum length: 20

      Original property name from the Odata EDM: CAInvcgOffsettingReferenceKey

      Parameters:
      cAInvcgOffsettingReferenceKey - Offsetting Reference Key

    • setCABillgPlnCreatedByUser

      public void setCABillgPlnCreatedByUser(@Nullable String cABillgPlnCreatedByUser)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: CABillgPlnCreatedByUser

      Parameters:
      cABillgPlnCreatedByUser - User Who Created the Billing Plan

    • setCABillgPlnCreationDate

      public void setCABillgPlnCreationDate(@Nullable LocalDate cABillgPlnCreationDate)
      Constraints: Nullable

      Original property name from the Odata EDM: CABillgPlnCreationDate

      Parameters:
      cABillgPlnCreationDate - Creation Date of Billing Plan

    • setCABillgPlnCreationTime

      public void setCABillgPlnCreationTime(@Nullable LocalTime cABillgPlnCreationTime)
      Constraints: Not nullable

      Original property name from the Odata EDM: CABillgPlnCreationTime

      Parameters:
      cABillgPlnCreationTime - Time At Which the Billing Plan Was Created

    • setCABillgPlnChangedByUser

      public void setCABillgPlnChangedByUser(@Nullable String cABillgPlnChangedByUser)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: CABillgPlnChangedByUser

      Parameters:
      cABillgPlnChangedByUser - User Who Changed the Billing Plan

    • setCABillgPlnChangeDate

      public void setCABillgPlnChangeDate(@Nullable LocalDate cABillgPlnChangeDate)
      Constraints: Nullable

      Original property name from the Odata EDM: CABillgPlnChangeDate

      Parameters:
      cABillgPlnChangeDate - Change Date of Billing Plan

    • setCABillgPlnChangeTime

      public void setCABillgPlnChangeTime(@Nullable LocalTime cABillgPlnChangeTime)
      Constraints: Not nullable

      Original property name from the Odata EDM: CABillgPlnChangeTime

      Parameters:
      cABillgPlnChangeTime - Time at Which the Billing Plan Was Changed

    • setCABillgPlnCreationMode

      public void setCABillgPlnCreationMode(@Nullable String cABillgPlnCreationMode)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: CABillgPlnCreationMode

      Parameters:
      cABillgPlnCreationMode - Creation Mode of Billing Plan

    • setCABillgPlnNumberBllbleItm

      public void setCABillgPlnNumberBllbleItm(@Nullable String cABillgPlnNumberBllbleItm)
      Constraints: Not nullable, Maximum length: 8

      Original property name from the Odata EDM: CABillgPlnNumberBllbleItm

      Parameters:
      cABillgPlnNumberBllbleItm - Number of Billable Items for the Billing Plan

    • setCABillgPlnCompletionDate

      public void setCABillgPlnCompletionDate(@Nullable LocalDate cABillgPlnCompletionDate)
      Constraints: Nullable

      Original property name from the Odata EDM: CABillgPlnCompletionDate

      Parameters:
      cABillgPlnCompletionDate - Completion Date

    • setCABillgPlnIsTemplate

      public void setCABillgPlnIsTemplate(@Nullable Boolean cABillgPlnIsTemplate)
      Constraints: Not nullable

      Original property name from the Odata EDM: CABillgPlnIsTemplate

      Parameters:
      cABillgPlnIsTemplate - Billing Plan Template

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • getCABillgPlnItemIfPresent

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

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

    • setCABillgPlnItem

      public void setCABillgPlnItem(@Nonnull List<CABillgPlnItem> value)
      Overwrites the list of associated CABillgPlnItem entities for the loaded navigation property _CABillgPlnItem.

      If the navigation property _CABillgPlnItem of a queried CABillgPln 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 CABillgPlnItem entities.

    • addCABillgPlnItem

      public void addCABillgPlnItem(CABillgPlnItem... entity)
      Adds elements to the list of associated CABillgPlnItem entities. This corresponds to the OData navigation property _CABillgPlnItem.

      If the navigation property _CABillgPlnItem of a queried CABillgPln 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 CABillgPlnItem entities.

    • release

      @Nonnull public static BoundAction.SingleToSingle<CABillgPln,CABillgPln> release()
      Action that can be applied to any entity object of this class.

      Returns:
      Action object prepared with the given parameters to be applied to any entity object of this class.

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

    • reopenBillingPlan

      @Nonnull public static BoundAction.SingleToSingle<CABillgPln,CABillgPln> reopenBillingPlan()
      Action that can be applied to any entity object of this class.

      Returns:
      Action object prepared with the given parameters to be applied to any entity object of this class.

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

    • complete

      @Nonnull public static BoundAction.SingleToSingle<CABillgPln,CABillgPln> complete()
      Action that can be applied to any entity object of this class.

      Returns:
      Action object prepared with the given parameters to be applied to any entity object of this class.

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

    • builder

      @Nonnull public static CABillgPln.CABillgPlnBuilder builder()

    • getCABillgPlnNumber

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

      Original property name from the Odata EDM: CABillgPlnNumber

      Returns:
      Billing Plan Number

    • getCABillgPlnCategory

      @Nullable public String getCABillgPlnCategory()
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: CABillgPlnCategory

      Returns:
      Billing Plan Category

    • getCABillgPlnType

      @Nullable public String getCABillgPlnType()
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: CABillgPlnType

      Returns:
      Billing Plan Type

    • getCABillgPlnStatus

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

      Original property name from the Odata EDM: CABillgPlnStatus

      Returns:
      Status of Billing Plan

    • getCABillgPlnStartDate

      @Nullable public LocalDate getCABillgPlnStartDate()
      Constraints: Nullable

      Original property name from the Odata EDM: CABillgPlnStartDate

      Returns:
      Valid From

    • getCABillgPlnEndDate

      @Nullable public LocalDate getCABillgPlnEndDate()
      Constraints: Nullable

      Original property name from the Odata EDM: CABillgPlnEndDate

      Returns:
      Valid To

    • getCABillgPlnLastRequestDate

      @Nullable public LocalDate getCABillgPlnLastRequestDate()
      Constraints: Nullable

      Original property name from the Odata EDM: CABillgPlnLastRequestDate

      Returns:
      Last Reqest Date for Billing Plan Items

    • getCABillgPlnNextRequestDate

      @Nullable public LocalDate getCABillgPlnNextRequestDate()
      Constraints: Nullable

      Original property name from the Odata EDM: CABillgPlnNextRequestDate

      Returns:
      Next Request Date of Billing Plan Items

    • getCABillgPlnDescription

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

      Original property name from the Odata EDM: CABillgPlnDescription

      Returns:
      Description of Billing Plan

    • getCABillgPlnExternalReference

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

      Original property name from the Odata EDM: CABillgPlnExternalReference

      Returns:
      External Reference of Billing Plan

    • getLogicalSystem

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

      Original property name from the Odata EDM: LogicalSystem

      Returns:
      Logical System

    • getCAApplicationArea

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

      Original property name from the Odata EDM: CAApplicationArea

      Returns:
      Application area

    • getBusinessPartner

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

      Original property name from the Odata EDM: BusinessPartner

      Returns:
      Business Partner Number

    • getContractAccount

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

      Original property name from the Odata EDM: ContractAccount

      Returns:
      Contract Account Number

    • getCAInvcgMasterDataType

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

      Original property name from the Odata EDM: CAInvcgMasterDataType

      Returns:
      Type of Master Record for Convergent Invoicing

    • getCAContract

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

      Original property name from the Odata EDM: CAContract

      Returns:
      Reference Specifications from Contract

    • getCAProviderContractItemUUID

      @Nullable public UUID getCAProviderContractItemUUID()
      Constraints: Nullable

      Original property name from the Odata EDM: CAProviderContractItemUUID

      Returns:
      External GUID of Provider Contract Items

    • getCASubApplication

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

      Original property name from the Odata EDM: CASubApplication

      Returns:
      Subapplication in Contract Accounts Receivable and Payable

    • getCAMasterAgreement

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

      Original property name from the Odata EDM: CAMasterAgreement

      Returns:
      Identification of Master Agreement

    • getCAInvcgOffsettingReferenceKey

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

      Original property name from the Odata EDM: CAInvcgOffsettingReferenceKey

      Returns:
      Offsetting Reference Key

    • getCABillgPlnCreatedByUser

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

      Original property name from the Odata EDM: CABillgPlnCreatedByUser

      Returns:
      User Who Created the Billing Plan

    • getCABillgPlnCreationDate

      @Nullable public LocalDate getCABillgPlnCreationDate()
      Constraints: Nullable

      Original property name from the Odata EDM: CABillgPlnCreationDate

      Returns:
      Creation Date of Billing Plan

    • getCABillgPlnCreationTime

      @Nullable public LocalTime getCABillgPlnCreationTime()
      Constraints: Not nullable

      Original property name from the Odata EDM: CABillgPlnCreationTime

      Returns:
      Time At Which the Billing Plan Was Created

    • getCABillgPlnChangedByUser

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

      Original property name from the Odata EDM: CABillgPlnChangedByUser

      Returns:
      User Who Changed the Billing Plan

    • getCABillgPlnChangeDate

      @Nullable public LocalDate getCABillgPlnChangeDate()
      Constraints: Nullable

      Original property name from the Odata EDM: CABillgPlnChangeDate

      Returns:
      Change Date of Billing Plan

    • getCABillgPlnChangeTime

      @Nullable public LocalTime getCABillgPlnChangeTime()
      Constraints: Not nullable

      Original property name from the Odata EDM: CABillgPlnChangeTime

      Returns:
      Time at Which the Billing Plan Was Changed

    • getCABillgPlnCreationMode

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

      Original property name from the Odata EDM: CABillgPlnCreationMode

      Returns:
      Creation Mode of Billing Plan

    • getCABillgPlnNumberBllbleItm

      @Nullable public String getCABillgPlnNumberBllbleItm()
      Constraints: Not nullable, Maximum length: 8

      Original property name from the Odata EDM: CABillgPlnNumberBllbleItm

      Returns:
      Number of Billable Items for the Billing Plan

    • getCABillgPlnCompletionDate

      @Nullable public LocalDate getCABillgPlnCompletionDate()
      Constraints: Nullable

      Original property name from the Odata EDM: CABillgPlnCompletionDate

      Returns:
      Completion Date

    • getCABillgPlnIsTemplate

      @Nullable public Boolean getCABillgPlnIsTemplate()
      Constraints: Not nullable

      Original property name from the Odata EDM: CABillgPlnIsTemplate

      Returns:
      Billing Plan Template

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

    • equals

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

    • canEqual

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

    • hashCode

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

    • getOdataType

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