Package com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.budgetperiod

Class BudgetPeriod

java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<BudgetPeriod>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.budgetperiod.BudgetPeriod
public class BudgetPeriod extends VdmEntity<BudgetPeriod>
Budget Period

Original entity name from the Odata EDM: BudgetPeriod_Type

  • Field Details

    • ALL_FIELDS

      public static final BudgetPeriodSelectable ALL_FIELDS
      Selector for all available fields of BudgetPeriod.

    • BUDGET_PERIOD

      public static final BudgetPeriodField<String> BUDGET_PERIOD
      Use with available fluent helpers to apply the BudgetPeriod field to query operations.

    • VALIDITY_START_DATE

      public static final BudgetPeriodField<LocalDateTime> VALIDITY_START_DATE
      Use with available fluent helpers to apply the ValidityStartDate field to query operations.

    • VALIDITY_END_DATE

      public static final BudgetPeriodField<LocalDateTime> VALIDITY_END_DATE
      Use with available fluent helpers to apply the ValidityEndDate field to query operations.

    • BUDGET_PERIOD_EXPIRATION_DATE

      public static final BudgetPeriodField<LocalDateTime> BUDGET_PERIOD_EXPIRATION_DATE
      Use with available fluent helpers to apply the BudgetPeriodExpirationDate field to query operations.

    • BUDGET_PERIOD_REVERSAL_DATE

      public static final BudgetPeriodField<LocalDateTime> BUDGET_PERIOD_REVERSAL_DATE
      Use with available fluent helpers to apply the BudgetPeriodReversalDate field to query operations.

    • BUDGET_PERIOD_AUTHZN_GRP

      public static final BudgetPeriodField<String> BUDGET_PERIOD_AUTHZN_GRP
      Use with available fluent helpers to apply the BudgetPeriodAuthznGrp field to query operations.

    • BUDGET_PERIOD_PERIODICITY

      public static final BudgetPeriodField<String> BUDGET_PERIOD_PERIODICITY
      Use with available fluent helpers to apply the BudgetPeriodPeriodicity field to query operations.

    • BUDGET_PERIOD_NAME

      public static final BudgetPeriodField<String> BUDGET_PERIOD_NAME
      Use with available fluent helpers to apply the BudgetPeriodName field to query operations.

    • TO_TEXT

      public static final BudgetPeriodLink<BudgetPeriodCoreText> TO_TEXT
      Use with available fluent helpers to apply the to_Text navigation property to query operations.

  • Constructor Details

  • Method Details

    • getType

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

    • setBudgetPeriod

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

      Original property name from the Odata EDM: BudgetPeriod

      Parameters:
      budgetPeriod - Budget Period

    • setValidityStartDate

      public void setValidityStartDate(@Nullable LocalDateTime validityStartDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: ValidityStartDate

      Parameters:
      validityStartDate - Budget Period Valid From

    • setValidityEndDate

      public void setValidityEndDate(@Nullable LocalDateTime validityEndDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: ValidityEndDate

      Parameters:
      validityEndDate - Budget Period Valid To

    • setBudgetPeriodExpirationDate

      public void setBudgetPeriodExpirationDate(@Nullable LocalDateTime budgetPeriodExpirationDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: BudgetPeriodExpirationDate

      Parameters:
      budgetPeriodExpirationDate - Budget Period Expiration Date

    • setBudgetPeriodReversalDate

      public void setBudgetPeriodReversalDate(@Nullable LocalDateTime budgetPeriodReversalDate)
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: BudgetPeriodReversalDate

      Parameters:
      budgetPeriodReversalDate - Budget Period Reversal Date

    • setBudgetPeriodAuthznGrp

      public void setBudgetPeriodAuthznGrp(@Nullable String budgetPeriodAuthznGrp)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: BudgetPeriodAuthznGrp

      Parameters:
      budgetPeriodAuthznGrp - Budget Period Authorization Group

    • setBudgetPeriodPeriodicity

      public void setBudgetPeriodPeriodicity(@Nullable String budgetPeriodPeriodicity)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: BudgetPeriodPeriodicity

      Parameters:
      budgetPeriodPeriodicity - Frequency for Budget Period

    • setBudgetPeriodName

      public void setBudgetPeriodName(@Nullable String budgetPeriodName)
      Constraints: Not nullable, Maximum length: 35

      Original property name from the Odata EDM: BudgetPeriodName

      Parameters:
      budgetPeriodName - Budget Period Name

    • getEntityCollection

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • field

      @Nonnull public static <T> BudgetPeriodField<T> field(@Nonnull String fieldName, @Nonnull Class<T> fieldType)
      Use with available fluent helpers to apply an extension field to query operations.
      Type Parameters:
      T - The type of the extension field when performing value comparisons.
      Parameters:
      fieldName - The name of the extension field as returned by the OData service.
      fieldType - The Java type to use for the extension field when performing value comparisons.
      Returns:
      A representation of an extension field from this entity.

    • field

      @Nonnull public static <T, DomainT> BudgetPeriodField<T> field(@Nonnull String fieldName, @Nonnull TypeConverter<T,DomainT> typeConverter)
      Use with available fluent helpers to apply an extension field to query operations.
      Type Parameters:
      T - The type of the extension field when performing value comparisons.
      DomainT - The type of the extension field as returned by the OData service.
      Parameters:
      typeConverter - A TypeConverter<T, DomainT> instance whose first generic type matches the Java type of the field
      fieldName - The name of the extension field as returned by the OData service.
      Returns:
      A representation of an extension field from this entity, holding a reference to the given TypeConverter.

    • getDestinationForFetch

      @Nullable public HttpDestinationProperties getDestinationForFetch()
      Overrides:
      getDestinationForFetch in class VdmEntity<BudgetPeriod>

    • setServicePathForFetch

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

    • attachToService

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • fetchText

      @Nonnull public List<BudgetPeriodCoreText> fetchText()
      Fetches the BudgetPeriodCoreText entities (one to many) associated with this entity. This corresponds to the OData navigation property to_Text.

      Please note: This method will not cache or persist the query results.

      Returns:
      List containing one or more associated BudgetPeriodCoreText entities. If no entities are associated then an empty list is returned.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

    • getTextOrFetch

      @Nonnull public List<BudgetPeriodCoreText> getTextOrFetch()
      Retrieval of associated BudgetPeriodCoreText entities (one to many). This corresponds to the OData navigation property to_Text.

      If the navigation property to_Text of a queried BudgetPeriod is operated lazily, an ODataException can be thrown in case of an OData query error.

      Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.

      Returns:
      List of associated BudgetPeriodCoreText entities.
      Throws:
      com.sap.cloud.sdk.datamodel.odata.client.exception.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

    • getTextIfPresent

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

      If the navigation property for an entity BudgetPeriod has not been resolved yet, this method will not query further information. Instead its Option result state will be empty.

      Returns:
      If the information for navigation property to_Text is already loaded, the result will contain the BudgetPeriodCoreText entities. If not, an Option with result state empty is returned.

    • setText

      public void setText(@Nonnull List<BudgetPeriodCoreText> value)
      Overwrites the list of associated BudgetPeriodCoreText entities for the loaded navigation property to_Text.

      If the navigation property to_Text of a queried BudgetPeriod 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 BudgetPeriodCoreText entities.

    • addText

      public void addText(BudgetPeriodCoreText... entity)
      Adds elements to the list of associated BudgetPeriodCoreText entities. This corresponds to the OData navigation property to_Text.

      If the navigation property to_Text of a queried BudgetPeriod 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 BudgetPeriodCoreText entities.

    • builder

      @Nonnull public static BudgetPeriod.BudgetPeriodBuilder builder()

    • getBudgetPeriod

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

      Original property name from the Odata EDM: BudgetPeriod

      Returns:
      Budget Period

    • getValidityStartDate

      @Nullable public LocalDateTime getValidityStartDate()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: ValidityStartDate

      Returns:
      Budget Period Valid From

    • getValidityEndDate

      @Nullable public LocalDateTime getValidityEndDate()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: ValidityEndDate

      Returns:
      Budget Period Valid To

    • getBudgetPeriodExpirationDate

      @Nullable public LocalDateTime getBudgetPeriodExpirationDate()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: BudgetPeriodExpirationDate

      Returns:
      Budget Period Expiration Date

    • getBudgetPeriodReversalDate

      @Nullable public LocalDateTime getBudgetPeriodReversalDate()
      Constraints: Not nullable, Precision: 0

      Original property name from the Odata EDM: BudgetPeriodReversalDate

      Returns:
      Budget Period Reversal Date

    • getBudgetPeriodAuthznGrp

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

      Original property name from the Odata EDM: BudgetPeriodAuthznGrp

      Returns:
      Budget Period Authorization Group

    • getBudgetPeriodPeriodicity

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

      Original property name from the Odata EDM: BudgetPeriodPeriodicity

      Returns:
      Frequency for Budget Period

    • getBudgetPeriodName

      @Nullable public String getBudgetPeriodName()
      Constraints: Not nullable, Maximum length: 35

      Original property name from the Odata EDM: BudgetPeriodName

      Returns:
      Budget Period Name

    • toString

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

    • equals

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

    • canEqual

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

    • hashCode

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