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

Class Run

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

Original entity name from the Odata EDM: Run_Type

  • Field Details

  • Constructor Details

    • Run

      public Run()

    • Run

      public Run(@Nullable UUID statryRptRunUUID, @Nullable UUID statryRptActivityUUID, @Nullable UUID statryRptPhaseUUID, @Nullable UUID statryRptTaskUUID, @Nullable String statryRptgEntity, @Nullable String statryRptCategory, @Nullable String statryRptRunID, @Nullable String statryRptRunStatus, @Nullable String statryRptRunType, @Nullable OffsetDateTime statryRptSubmittedDateTime, @Nullable String statryRptCatPhase, @Nullable String statryRptDef, @Nullable LocalDate statryRptTaskPeriodStartDate, @Nullable LocalDate statryRptTaskPeriodEndDate, @Nullable LocalDate statryRptTaskDueDate, @Nullable String reportingYear, @Nullable String applicationJobName, @Nullable Collection<SAP__Message> _Messages, @Nullable Activity to_Activity, List<RunParameter> to_RunParameter, @Nullable Task to_Task)

  • Method Details

    • getType

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

    • setStatryRptRunUUID

      public void setStatryRptRunUUID(@Nullable UUID statryRptRunUUID)
      (Key Field) Constraints: Not nullable

      Original property name from the Odata EDM: StatryRptRunUUID

      Parameters:
      statryRptRunUUID - NodeID

    • setStatryRptActivityUUID

      public void setStatryRptActivityUUID(@Nullable UUID statryRptActivityUUID)
      Constraints: Not nullable

      Original property name from the Odata EDM: StatryRptActivityUUID

      Parameters:
      statryRptActivityUUID - NodeID

    • setStatryRptPhaseUUID

      public void setStatryRptPhaseUUID(@Nullable UUID statryRptPhaseUUID)
      Constraints: 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

    • setStatryRptRunID

      public void setStatryRptRunID(@Nullable String statryRptRunID)
      Constraints: Not nullable, Maximum length: 8

      Original property name from the Odata EDM: StatryRptRunID

      Parameters:
      statryRptRunID - Report Run ID

    • setStatryRptRunStatus

      public void setStatryRptRunStatus(@Nullable String statryRptRunStatus)
      Constraints: Not nullable, Maximum length: 3

      Original property name from the Odata EDM: StatryRptRunStatus

      Parameters:
      statryRptRunStatus - Report Run Status

    • setStatryRptRunType

      public void setStatryRptRunType(@Nullable String statryRptRunType)
      Constraints: Not nullable, Maximum length: 5

      Original property name from the Odata EDM: StatryRptRunType

      Parameters:
      statryRptRunType - Report Run Type

    • setStatryRptSubmittedDateTime

      public void setStatryRptSubmittedDateTime(@Nullable OffsetDateTime statryRptSubmittedDateTime)
      Constraints: Nullable

      Original property name from the Odata EDM: StatryRptSubmittedDateTime

      Parameters:
      statryRptSubmittedDateTime - Timestamp for Submission

    • 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

    • setStatryRptDef

      public void setStatryRptDef(@Nullable String statryRptDef)
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: StatryRptDef

      Parameters:
      statryRptDef - Report Definition

    • setStatryRptTaskPeriodStartDate

      public void setStatryRptTaskPeriodStartDate(@Nullable LocalDate statryRptTaskPeriodStartDate)
      Constraints: Nullable

      Original property name from the Odata EDM: StatryRptTaskPeriodStartDate

      Parameters:
      statryRptTaskPeriodStartDate - Reporting Period Start Date

    • setStatryRptTaskPeriodEndDate

      public void setStatryRptTaskPeriodEndDate(@Nullable LocalDate statryRptTaskPeriodEndDate)
      Constraints: Nullable

      Original property name from the Odata EDM: StatryRptTaskPeriodEndDate

      Parameters:
      statryRptTaskPeriodEndDate - Reporting Period End Date

    • setStatryRptTaskDueDate

      public void setStatryRptTaskDueDate(@Nullable LocalDate statryRptTaskDueDate)
      Constraints: Nullable

      Original property name from the Odata EDM: StatryRptTaskDueDate

      Parameters:
      statryRptTaskDueDate - Due Date

    • setReportingYear

      public void setReportingYear(@Nullable String reportingYear)
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: ReportingYear

      Parameters:
      reportingYear - Reporting Year

    • setApplicationJobName

      public void setApplicationJobName(@Nullable String applicationJobName)
      Constraints: Not nullable, Maximum length: 32

      Original property name from the Odata EDM: ApplicationJobName

      Parameters:
      applicationJobName - Background Job Name

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

    • getKey

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

    • toMapOfFields

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

    • fromMap

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

    • getDefaultServicePath

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

    • toMapOfNavigationProperties

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

    • getActivityIfPresent

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

      If the navigation property for an entity Run 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 entity. If not, an Option with result state empty is returned.

    • setActivity

      public void setActivity(Activity value)
      Overwrites the associated Activity entity for the loaded navigation property _Activity.
      Parameters:
      value - New Activity entity.

    • getRunParameterIfPresent

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

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

    • setRunParameter

      public void setRunParameter(@Nonnull List<RunParameter> value)
      Overwrites the list of associated RunParameter entities for the loaded navigation property _RunParameter.

      If the navigation property _RunParameter of a queried Run 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 RunParameter entities.

    • addRunParameter

      public void addRunParameter(RunParameter... entity)
      Adds elements to the list of associated RunParameter entities. This corresponds to the OData navigation property _RunParameter.

      If the navigation property _RunParameter of a queried Run 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 RunParameter 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 Run 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.

    • submitStatryRptToGovernment

      @Nonnull public static BoundAction.SingleToSingle<Run,Run> submitStatryRptToGovernment()
      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.

    • setStatryRptStatusToDeclined

      @Nonnull public static BoundAction.SingleToSingle<Run,Run> setStatryRptStatusToDeclined()
      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.

    • setStatryRptStatusToAccepted

      @Nonnull public static BoundAction.SingleToSingle<Run,Run> setStatryRptStatusToAccepted()
      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.

    • setStatryRptStatusToSubmitted

      @Nonnull public static BoundAction.SingleToSingle<Run,Run> setStatryRptStatusToSubmitted()
      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 Run.RunBuilder builder()

    • getStatryRptRunUUID

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

      Original property name from the Odata EDM: StatryRptRunUUID

      Returns:
      NodeID

    • getStatryRptActivityUUID

      @Nullable public UUID getStatryRptActivityUUID()
      Constraints: Not nullable

      Original property name from the Odata EDM: StatryRptActivityUUID

      Returns:
      NodeID

    • getStatryRptPhaseUUID

      @Nullable public UUID getStatryRptPhaseUUID()
      Constraints: 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

    • getStatryRptRunID

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

      Original property name from the Odata EDM: StatryRptRunID

      Returns:
      Report Run ID

    • getStatryRptRunStatus

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

      Original property name from the Odata EDM: StatryRptRunStatus

      Returns:
      Report Run Status

    • getStatryRptRunType

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

      Original property name from the Odata EDM: StatryRptRunType

      Returns:
      Report Run Type

    • getStatryRptSubmittedDateTime

      @Nullable public OffsetDateTime getStatryRptSubmittedDateTime()
      Constraints: Nullable

      Original property name from the Odata EDM: StatryRptSubmittedDateTime

      Returns:
      Timestamp for Submission

    • getStatryRptCatPhase

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

      Original property name from the Odata EDM: StatryRptCatPhase

      Returns:
      Report Category Phase

    • getStatryRptDef

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

      Original property name from the Odata EDM: StatryRptDef

      Returns:
      Report Definition

    • getStatryRptTaskPeriodStartDate

      @Nullable public LocalDate getStatryRptTaskPeriodStartDate()
      Constraints: Nullable

      Original property name from the Odata EDM: StatryRptTaskPeriodStartDate

      Returns:
      Reporting Period Start Date

    • getStatryRptTaskPeriodEndDate

      @Nullable public LocalDate getStatryRptTaskPeriodEndDate()
      Constraints: Nullable

      Original property name from the Odata EDM: StatryRptTaskPeriodEndDate

      Returns:
      Reporting Period End Date

    • getStatryRptTaskDueDate

      @Nullable public LocalDate getStatryRptTaskDueDate()
      Constraints: Nullable

      Original property name from the Odata EDM: StatryRptTaskDueDate

      Returns:
      Due Date

    • getReportingYear

      @Nullable public String getReportingYear()
      Constraints: Not nullable, Maximum length: 4

      Original property name from the Odata EDM: ReportingYear

      Returns:
      Reporting Year

    • getApplicationJobName

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

      Original property name from the Odata EDM: ApplicationJobName

      Returns:
      Background Job Name

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

    • equals

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

    • canEqual

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

    • hashCode

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

    • getOdataType

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