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

Class Phase

java.lang.Object
com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odatav4.core.VdmEntity<Phase>
com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.statutoryreportingtask.Phase
All Implemented Interfaces:
VdmEntitySet
public class Phase extends VdmEntity<Phase> implements VdmEntitySet
Statutory Reporting Phase

Original entity name from the Odata EDM: Phase_Type

  • Field Details

  • Constructor Details

    • Phase

      public Phase()

    • Phase

      public Phase(@Nullable UUID statryRptPhaseUUID, @Nullable UUID statryRptTaskUUID, @Nullable String statryRptgEntity, @Nullable String statryRptCategory, @Nullable String statryRptCatPhase, @Nullable LocalDate statryRptDueDate, @Nullable String statryRptPhaseStatus, @Nullable Collection<SAP__Message> _Messages, List<Activity> to_Activity, @Nullable Task to_Task)

  • Method Details

    • getType

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

    • setStatryRptPhaseUUID

      public void setStatryRptPhaseUUID(@Nullable UUID statryRptPhaseUUID)
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: StatryRptPhaseUUID

      Parameters:
      statryRptPhaseUUID - NodeID

    • setStatryRptTaskUUID

      public void setStatryRptTaskUUID(@Nullable UUID statryRptTaskUUID)
      Constraints: Not nullable

      Original property name from the Odata EDM: StatryRptTaskUUID

      Parameters:
      statryRptTaskUUID - NodeID

    • setStatryRptgEntity

      public void setStatryRptgEntity(@Nullable String statryRptgEntity)
      Constraints: Not nullable, Maximum length: 10

      Original property name from the Odata EDM: StatryRptgEntity

      Parameters:
      statryRptgEntity - Reporting Entity

    • setStatryRptCategory

      public void setStatryRptCategory(@Nullable String statryRptCategory)
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: StatryRptCategory

      Parameters:
      statryRptCategory - Report Category ID

    • setStatryRptCatPhase

      public void setStatryRptCatPhase(@Nullable String statryRptCatPhase)
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: StatryRptCatPhase

      Parameters:
      statryRptCatPhase - Report Category Phase

    • setStatryRptDueDate

      public void setStatryRptDueDate(@Nullable LocalDate statryRptDueDate)
      Constraints: Nullable

      Original property name from the Odata EDM: StatryRptDueDate

      Parameters:
      statryRptDueDate - Due Date

    • setStatryRptPhaseStatus

      public void setStatryRptPhaseStatus(@Nullable String statryRptPhaseStatus)
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: StatryRptPhaseStatus

      Parameters:
      statryRptPhaseStatus - Activity Status

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • getActivityIfPresent

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

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

    • setActivity

      public void setActivity(@Nonnull List<Activity> value)
      Overwrites the list of associated Activity entities for the loaded navigation property _Activity.

      If the navigation property _Activity of a queried Phase 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 Activity entities.

    • addActivity

      public void addActivity(Activity... entity)
      Adds elements to the list of associated Activity entities. This corresponds to the OData navigation property _Activity.

      If the navigation property _Activity of a queried Phase 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 Activity entities.

    • getTaskIfPresent

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

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

    • setTask

      public void setTask(Task value)
      Overwrites the associated Task entity for the loaded navigation property _Task.
      Parameters:
      value - New Task entity.

    • skipStatryRptPhase

      @Nonnull public static BoundAction.SingleToSingle<Phase,Phase> skipStatryRptPhase()
      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 Phase.PhaseBuilder builder()

    • getStatryRptPhaseUUID

      @Nullable public UUID getStatryRptPhaseUUID()
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: StatryRptPhaseUUID

      Returns:
      NodeID

    • getStatryRptTaskUUID

      @Nullable public UUID getStatryRptTaskUUID()
      Constraints: Not nullable

      Original property name from the Odata EDM: StatryRptTaskUUID

      Returns:
      NodeID

    • getStatryRptgEntity

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

      Original property name from the Odata EDM: StatryRptgEntity

      Returns:
      Reporting Entity

    • getStatryRptCategory

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

      Original property name from the Odata EDM: StatryRptCategory

      Returns:
      Report Category ID

    • getStatryRptCatPhase

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

      Original property name from the Odata EDM: StatryRptCatPhase

      Returns:
      Report Category Phase

    • getStatryRptDueDate

      @Nullable public LocalDate getStatryRptDueDate()
      Constraints: Nullable

      Original property name from the Odata EDM: StatryRptDueDate

      Returns:
      Due Date

    • getStatryRptPhaseStatus

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

      Original property name from the Odata EDM: StatryRptPhaseStatus

      Returns:
      Activity Status

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

    • equals

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

    • canEqual

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

    • hashCode

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

    • getOdataType

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