java.lang.Object
com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<Workpackage>
com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail.Workpackage

public class Workpackage extends VdmEntity<Workpackage>
Work Packages

Original entity name from the Odata EDM: Workpackage

  • Field Details

    • ALL_FIELDS

      public static final WorkpackageSelectable ALL_FIELDS
      Selector for all available fields of Workpackage.
    • WORK_PACKAGE_UNIT_TEXT

      public static final WorkpackageField<String> WORK_PACKAGE_UNIT_TEXT
      Use with available fluent helpers to apply the WorkPackageUnitText field to query operations.
    • WORK_PACKAGE_TYPE

      public static final WorkpackageField<String> WORK_PACKAGE_TYPE
      Use with available fluent helpers to apply the WorkPackageType field to query operations.
    • UNIT_OF_MEASURE

      public static final WorkpackageField<String> UNIT_OF_MEASURE
      Use with available fluent helpers to apply the UnitOfMeasure field to query operations.
    • QUANTITY

      public static final WorkpackageField<String> QUANTITY
      Use with available fluent helpers to apply the Quantity field to query operations.
    • CHANGED_ON

      public static final WorkpackageField<ZonedDateTime> CHANGED_ON
      Use with available fluent helpers to apply the ChangedOn field to query operations.
    • PROJECT_ID

      public static final WorkpackageField<String> PROJECT_ID
      Use with available fluent helpers to apply the ProjectID field to query operations.
    • CHANGED_BY

      public static final WorkpackageField<String> CHANGED_BY
      Use with available fluent helpers to apply the ChangedBy field to query operations.
    • WORK_PACKAGE_ID

      public static final WorkpackageField<String> WORK_PACKAGE_ID
      Use with available fluent helpers to apply the WorkPackageID field to query operations.
    • WORK_PACKAGE_NAME

      public static final WorkpackageField<String> WORK_PACKAGE_NAME
      Use with available fluent helpers to apply the WorkPackageName field to query operations.
    • WP_START_DATE

      public static final WorkpackageField<LocalDateTime> WP_START_DATE
      Use with available fluent helpers to apply the WPStartDate field to query operations.
    • WP_END_DATE

      public static final WorkpackageField<LocalDateTime> WP_END_DATE
      Use with available fluent helpers to apply the WPEndDate field to query operations.
    • PROJECT_NAME

      public static final WorkpackageField<String> PROJECT_NAME
      Use with available fluent helpers to apply the ProjectName field to query operations.
    • TO_WORK_PACKAGE_FUNCTION_SET

      public static final WorkpackageLink<WorkPackageFunction> TO_WORK_PACKAGE_FUNCTION_SET
      Use with available fluent helpers to apply the WorkPackageFunctionSet navigation property to query operations.
    • TO_WORK_ITEM_SET

      public static final WorkpackageLink<WorkItem> TO_WORK_ITEM_SET
      Use with available fluent helpers to apply the WorkItemSet navigation property to query operations.
    • TO_PLAN_DATA_SET

      public static final WorkpackageLink<PlanData> TO_PLAN_DATA_SET
      Use with available fluent helpers to apply the PlanDataSet navigation property to query operations.
  • Constructor Details

  • Method Details

    • getType

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

      public void setWorkPackageUnitText(@Nullable String workPackageUnitText)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: WorkPackageUnitText

      Parameters:
      workPackageUnitText - Work Package Unit Text
    • setWorkPackageType

      public void setWorkPackageType(@Nullable String workPackageType)
      Constraints: Not nullable, Maximum length: 1

      Original property name from the Odata EDM: WorkPackageType

      Parameters:
      workPackageType - Work Package Type
    • setUnitOfMeasure

      public void setUnitOfMeasure(@Nullable String unitOfMeasure)
      Constraints: Not nullable, Maximum length: 30

      Original property name from the Odata EDM: UnitOfMeasure

      Parameters:
      unitOfMeasure - Unit Of Measure
    • setQuantity

      public void setQuantity(@Nullable String quantity)
      Constraints: Not nullable, Maximum length: 15

      Original property name from the Odata EDM: Quantity

      Parameters:
      quantity - Quantity
    • setChangedOn

      public void setChangedOn(@Nullable ZonedDateTime changedOn)
      Constraints: Not nullable, Precision: 7

      Original property name from the Odata EDM: ChangedOn

      Parameters:
      changedOn - Changed on
    • setProjectID

      public void setProjectID(@Nullable String projectID)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: ProjectID

      Parameters:
      projectID - Project ID
    • setChangedBy

      public void setChangedBy(@Nullable String changedBy)
      Constraints: Not nullable, Maximum length: 12

      Original property name from the Odata EDM: ChangedBy

      Parameters:
      changedBy - Changed By
    • setWorkPackageID

      public void setWorkPackageID(@Nullable String workPackageID)
      (Key Field) Constraints: Not nullable, Maximum length: 50

      Original property name from the Odata EDM: WorkPackageID

      Parameters:
      workPackageID - Work Package ID
    • setWorkPackageName

      public void setWorkPackageName(@Nullable String workPackageName)
      Constraints: Not nullable, Maximum length: 60

      Original property name from the Odata EDM: WorkPackageName

      Parameters:
      workPackageName - Work Package Name
    • setWPStartDate

      public void setWPStartDate(@Nullable LocalDateTime wPStartDate)
      Constraints: Not nullable, Precision: 7

      Original property name from the Odata EDM: WPStartDate

      Parameters:
      wPStartDate - Work Package Start Date
    • setWPEndDate

      public void setWPEndDate(@Nullable LocalDateTime wPEndDate)
      Constraints: Not nullable, Precision: 7

      Original property name from the Odata EDM: WPEndDate

      Parameters:
      wPEndDate - Work Package EndDate
    • setProjectName

      public void setProjectName(@Nullable String projectName)
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: ProjectName

      Parameters:
      projectName - Project Name
    • getEntityCollection

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

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

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

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

      @Nonnull public static <T> WorkpackageField<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> WorkpackageField<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<Workpackage>
    • setServicePathForFetch

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

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

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

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

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

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

      Returns:
      List containing one or more associated WorkPackageFunction 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.
    • getWorkPackageFunctionSetOrFetch

      @Nonnull public List<WorkPackageFunction> getWorkPackageFunctionSetOrFetch()
      Retrieval of associated WorkPackageFunction entities (one to many). This corresponds to the OData navigation property WorkPackageFunctionSet.

      If the navigation property WorkPackageFunctionSet of a queried Workpackage 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 WorkPackageFunction 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.
    • getWorkPackageFunctionSetIfPresent

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

      If the navigation property for an entity Workpackage 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 WorkPackageFunctionSet is already loaded, the result will contain the WorkPackageFunction entities. If not, an Option with result state empty is returned.
    • setWorkPackageFunctionSet

      public void setWorkPackageFunctionSet(@Nonnull List<WorkPackageFunction> value)
      Overwrites the list of associated WorkPackageFunction entities for the loaded navigation property WorkPackageFunctionSet.

      If the navigation property WorkPackageFunctionSet of a queried Workpackage 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 WorkPackageFunction entities.
    • addWorkPackageFunctionSet

      public void addWorkPackageFunctionSet(WorkPackageFunction... entity)
      Adds elements to the list of associated WorkPackageFunction entities. This corresponds to the OData navigation property WorkPackageFunctionSet.

      If the navigation property WorkPackageFunctionSet of a queried Workpackage 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 WorkPackageFunction entities.
    • fetchWorkItemSet

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

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

      Returns:
      List containing one or more associated WorkItem 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.
    • getWorkItemSetOrFetch

      @Nonnull public List<WorkItem> getWorkItemSetOrFetch()
      Retrieval of associated WorkItem entities (one to many). This corresponds to the OData navigation property WorkItemSet.

      If the navigation property WorkItemSet of a queried Workpackage 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 WorkItem 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.
    • getWorkItemSetIfPresent

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

      If the navigation property for an entity Workpackage 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 WorkItemSet is already loaded, the result will contain the WorkItem entities. If not, an Option with result state empty is returned.
    • setWorkItemSet

      public void setWorkItemSet(@Nonnull List<WorkItem> value)
      Overwrites the list of associated WorkItem entities for the loaded navigation property WorkItemSet.

      If the navigation property WorkItemSet of a queried Workpackage 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 WorkItem entities.
    • addWorkItemSet

      public void addWorkItemSet(WorkItem... entity)
      Adds elements to the list of associated WorkItem entities. This corresponds to the OData navigation property WorkItemSet.

      If the navigation property WorkItemSet of a queried Workpackage 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 WorkItem entities.
    • fetchPlanDataSet

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

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

      Returns:
      List containing one or more associated PlanData 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.
    • getPlanDataSetOrFetch

      @Nonnull public List<PlanData> getPlanDataSetOrFetch()
      Retrieval of associated PlanData entities (one to many). This corresponds to the OData navigation property PlanDataSet.

      If the navigation property PlanDataSet of a queried Workpackage 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 PlanData 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.
    • getPlanDataSetIfPresent

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

      If the navigation property for an entity Workpackage 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 PlanDataSet is already loaded, the result will contain the PlanData entities. If not, an Option with result state empty is returned.
    • setPlanDataSet

      public void setPlanDataSet(@Nonnull List<PlanData> value)
      Overwrites the list of associated PlanData entities for the loaded navigation property PlanDataSet.

      If the navigation property PlanDataSet of a queried Workpackage 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 PlanData entities.
    • addPlanDataSet

      public void addPlanDataSet(PlanData... entity)
      Adds elements to the list of associated PlanData entities. This corresponds to the OData navigation property PlanDataSet.

      If the navigation property PlanDataSet of a queried Workpackage 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 PlanData entities.
    • builder

      @Nonnull public static Workpackage.WorkpackageBuilder builder()
    • getWorkPackageUnitText

      @Nullable public String getWorkPackageUnitText()
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: WorkPackageUnitText

      Returns:
      Work Package Unit Text
    • getWorkPackageType

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

      Original property name from the Odata EDM: WorkPackageType

      Returns:
      Work Package Type
    • getUnitOfMeasure

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

      Original property name from the Odata EDM: UnitOfMeasure

      Returns:
      Unit Of Measure
    • getQuantity

      @Nullable public String getQuantity()
      Constraints: Not nullable, Maximum length: 15

      Original property name from the Odata EDM: Quantity

      Returns:
      Quantity
    • getChangedOn

      @Nullable public ZonedDateTime getChangedOn()
      Constraints: Not nullable, Precision: 7

      Original property name from the Odata EDM: ChangedOn

      Returns:
      Changed on
    • getProjectID

      @Nullable public String getProjectID()
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: ProjectID

      Returns:
      Project ID
    • getChangedBy

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

      Original property name from the Odata EDM: ChangedBy

      Returns:
      Changed By
    • getWorkPackageID

      @Nullable public String getWorkPackageID()
      (Key Field) Constraints: Not nullable, Maximum length: 50

      Original property name from the Odata EDM: WorkPackageID

      Returns:
      Work Package ID
    • getWorkPackageName

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

      Original property name from the Odata EDM: WorkPackageName

      Returns:
      Work Package Name
    • getWPStartDate

      @Nullable public LocalDateTime getWPStartDate()
      Constraints: Not nullable, Precision: 7

      Original property name from the Odata EDM: WPStartDate

      Returns:
      Work Package Start Date
    • getWPEndDate

      @Nullable public LocalDateTime getWPEndDate()
      Constraints: Not nullable, Precision: 7

      Original property name from the Odata EDM: WPEndDate

      Returns:
      Work Package EndDate
    • getProjectName

      @Nullable public String getProjectName()
      Constraints: Not nullable, Maximum length: 40

      Original property name from the Odata EDM: ProjectName

      Returns:
      Project Name
    • toString

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

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

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

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