Workpackage (SAP S/4HANA Cloud SDK - Parent POM 1.6.0 API)

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

public class Workpackage
extends VdmEntity<Workpackage>

Workpackage

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Workpackage.WorkpackageBuilder

Nested Classes
Modifier and Type	Class and Description
`static class`	`Workpackage.WorkpackageBuilder`

Field Summary

Fields
Modifier and Type	Field and Description
`static EntityFieldAll<Workpackage>`	`ALL_FIELDS` Selector for all available fields of Workpackage.
`static WorkpackageField<String>`	`CHANGED_BY` Use with available fluent helpers to apply the ChangedBy field to query operations.
`static WorkpackageField<Calendar>`	`CHANGED_ON` Use with available fluent helpers to apply the ChangedOn field to query operations.
`static WorkpackageField<String>`	`PROJECT_ID` Use with available fluent helpers to apply the ProjectID field to query operations.
`static WorkpackageField<String>`	`PROJECT_NAME` Use with available fluent helpers to apply the ProjectName field to query operations.
`static WorkpackageLink<PlanData>`	`TO_PLAN_DATA_SET` Use with available fluent helpers to apply the PlanDataSet navigation property to query operations.
`static WorkpackageLink<WorkItem>`	`TO_WORK_ITEM_SET` Use with available fluent helpers to apply the WorkItemSet navigation property to query operations.
`static WorkpackageField<String>`	`WORK_PACKAGE_ID` Use with available fluent helpers to apply the WorkPackageID field to query operations.
`static WorkpackageField<String>`	`WORK_PACKAGE_NAME` Use with available fluent helpers to apply the WorkPackageName field to query operations.
`static WorkpackageField<Calendar>`	`WP_END_DATE` Use with available fluent helpers to apply the WPEndDate field to query operations.
`static WorkpackageField<Calendar>`	`WP_START_DATE` Use with available fluent helpers to apply the WPStartDate field to query operations.

Constructor Summary

Constructors
Constructor and Description
`Workpackage()`
`Workpackage(Calendar changedOn, String projectID, String changedBy, String workPackageID, String workPackageName, Calendar wPStartDate, Calendar wPEndDate, String projectName, ErpConfigContext erpConfigContext, List<WorkItem> toWorkItemSet, List<PlanData> toPlanDataSet)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPlanDataSet(PlanData... entity)` Adds elements to the list of associated PlanData entities.
`void`	`addWorkItemSet(WorkItem... entity)` Adds elements to the list of associated WorkItem entities.
`static Workpackage.WorkpackageBuilder`	`builder()`
`boolean`	`equals(Object o)`
`List<PlanData>`	`fetchPlanDataSet()` Fetches the PlanData entities (one to many) associated with this entity.
`List<WorkItem>`	`fetchWorkItemSet()` Fetches the WorkItem entities (one to many) associated with this entity.
`static <T> WorkpackageField<T>`	`field(String fieldName, Class<T> fieldType)` Use with available fluent helpers to apply an extension field to query operations.
`String`	`getChangedBy()` Constraints: Not nullable, Maximum length: 12
`Calendar`	`getChangedOn()` Constraints: Not nullable, Precision: 7
`ErpConfigContext`	`getErpConfigContext()` Convienence field for reusing the same ERP system context with multiple queries (e.g.
`List<PlanData>`	`getPlanDataSetOrFetch()` Retrieval of associated PlanData entities (one to many).
`com.google.common.base.Optional<List<PlanData>>`	`getPlanDataSetOrNull()` Retrieval of associated PlanData entities (one to many).
`String`	`getProjectID()` Constraints: Not nullable, Maximum length: 40
`String`	`getProjectName()` Constraints: Not nullable, Maximum length: 40
`Class<Workpackage>`	`getType()`
`List<WorkItem>`	`getWorkItemSetOrFetch()` Retrieval of associated WorkItem entities (one to many).
`com.google.common.base.Optional<List<WorkItem>>`	`getWorkItemSetOrNull()` Retrieval of associated WorkItem entities (one to many).
`String`	`getWorkPackageID()` (Key Field) Constraints: Not nullable, Maximum length: 50
`String`	`getWorkPackageName()` Constraints: Not nullable, Maximum length: 60
`Calendar`	`getWPEndDate()` Constraints: Not nullable, Precision: 7
`Calendar`	`getWPStartDate()` Constraints: Not nullable, Precision: 7
`int`	`hashCode()`
`void`	`setChangedBy(String changedBy)` Constraints: Not nullable, Maximum length: 12
`void`	`setChangedOn(Calendar changedOn)` Constraints: Not nullable, Precision: 7
`void`	`setErpConfigContext(ErpConfigContext erpConfigContext)` Convienence field for reusing the same ERP system context with multiple queries (e.g.
`void`	`setPlanDataSet(List<PlanData> value)` Overwrites the list of associated PlanData entities for the loaded navigation property PlanDataSet.
`void`	`setProjectID(String projectID)` Constraints: Not nullable, Maximum length: 40
`void`	`setProjectName(String projectName)` Constraints: Not nullable, Maximum length: 40
`void`	`setWorkItemSet(List<WorkItem> value)` Overwrites the list of associated WorkItem entities for the loaded navigation property WorkItemSet.
`void`	`setWorkPackageID(String workPackageID)` (Key Field) Constraints: Not nullable, Maximum length: 50
`void`	`setWorkPackageName(String workPackageName)` Constraints: Not nullable, Maximum length: 60
`void`	`setWPEndDate(Calendar wPEndDate)` Constraints: Not nullable, Precision: 7
`void`	`setWPStartDate(Calendar wPStartDate)` Constraints: Not nullable, Precision: 7
`String`	`toString()`

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject
getCustomField, getCustomField, getCustomFieldNames, getCustomFields, hasCustomField, hasCustomField, setCustomField, setCustomField

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Field Detail
- ALL_FIELDS
```
public static final EntityFieldAll<Workpackage> ALL_FIELDS
```
  Selector for all available fields of Workpackage.
- CHANGED_ON
```
public static final WorkpackageField<Calendar> 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<Calendar> WP_START_DATE
```
  Use with available fluent helpers to apply the WPStartDate field to query operations.
- WP_END_DATE
```
public static final WorkpackageField<Calendar> 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_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 Detail

Workpackage

@Generated(value="lombok")
public Workpackage()

Workpackage

@ConstructorProperties(value={"changedOn","projectID","changedBy","workPackageID","workPackageName","wPStartDate","wPEndDate","projectName","erpConfigContext","toWorkItemSet","toPlanDataSet"})
 @Generated(value="lombok")
public Workpackage(@Nullable
                                                                                                                                                                                                                                                Calendar changedOn,
                                                                                                                                                                                                                                                @Nullable
                                                                                                                                                                                                                                                String projectID,
                                                                                                                                                                                                                                                @Nullable
                                                                                                                                                                                                                                                String changedBy,
                                                                                                                                                                                                                                                @Nullable
                                                                                                                                                                                                                                                String workPackageID,
                                                                                                                                                                                                                                                @Nullable
                                                                                                                                                                                                                                                String workPackageName,
                                                                                                                                                                                                                                                @Nullable
                                                                                                                                                                                                                                                Calendar wPStartDate,
                                                                                                                                                                                                                                                @Nullable
                                                                                                                                                                                                                                                Calendar wPEndDate,
                                                                                                                                                                                                                                                @Nullable
                                                                                                                                                                                                                                                String projectName,
                                                                                                                                                                                                                                                @Nullable
                                                                                                                                                                                                                                                ErpConfigContext erpConfigContext,
                                                                                                                                                                                                                                                List<WorkItem> toWorkItemSet,
                                                                                                                                                                                                                                                List<PlanData> toPlanDataSet)

Method Detail
- getType
```
public Class<Workpackage> getType()
```
  Specified by:
  
  getType in class VdmObject<Workpackage>
  
  Returns:
  
  The class of this object.
- field
```
public static <T> WorkpackageField<T> field(String fieldName,
                                            Class<T> fieldType)
```
  Use with available fluent helpers to apply an extension field to query operations.
  
  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.
- fetchWorkItemSet
```
public List<WorkItem> fetchWorkItemSet()
                                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
  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.odatav2.connectivity.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
```
public List<WorkItem> getWorkItemSetOrFetch()
                                     throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
  Retrieval of associated WorkItem entities (one to many).
  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.odatav2.connectivity.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.
- getWorkItemSetOrNull
```
public com.google.common.base.Optional<List<WorkItem>> getWorkItemSetOrNull()
```
  Retrieval of associated WorkItem entities (one to many).
  If the navigation property WorkItemSet for an entity Workpackage has not been resolved yet, this method will not query further information. Instead its Optional result state will be null.
  
  Returns:
  
  If the information for navigation property WorkItemSet is already loaded, the result will contain the WorkItem entities. If not, a null value state 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.
  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
```
public List<PlanData> fetchPlanDataSet()
                                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
  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.odatav2.connectivity.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
```
public List<PlanData> getPlanDataSetOrFetch()
                                     throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
  Retrieval of associated PlanData entities (one to many).
  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.odatav2.connectivity.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.
- getPlanDataSetOrNull
```
public com.google.common.base.Optional<List<PlanData>> getPlanDataSetOrNull()
```
  Retrieval of associated PlanData entities (one to many).
  If the navigation property PlanDataSet for an entity Workpackage has not been resolved yet, this method will not query further information. Instead its Optional result state will be null.
  
  Returns:
  
  If the information for navigation property PlanDataSet is already loaded, the result will contain the PlanData entities. If not, a null value state 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.
  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
```
@Generated(value="lombok")
public static Workpackage.WorkpackageBuilder builder()
```
- getChangedOn
```
@Nullable
 @Generated(value="lombok")
public Calendar getChangedOn()
```
  Constraints: Not nullable, Precision: 7
  
  Returns:
  
  Draft Last Changed On
- getProjectID
```
@Nullable
 @Generated(value="lombok")
public String getProjectID()
```
  Constraints: Not nullable, Maximum length: 40
  
  Returns:
  
  Identifies a master project.
- getChangedBy
```
@Nullable
 @Generated(value="lombok")
public String getChangedBy()
```
  Constraints: Not nullable, Maximum length: 12
  
  Returns:
  
  Changed By
- getWorkPackageID
```
@Nullable
 @Generated(value="lombok")
public String getWorkPackageID()
```
  (Key Field) Constraints: Not nullable, Maximum length: 50
  
  Returns:
  
  Plan Item
- getWorkPackageName
```
@Nullable
 @Generated(value="lombok")
public String getWorkPackageName()
```
  Constraints: Not nullable, Maximum length: 60
  
  Returns:
  
  Plan Item Description
- getWPStartDate
```
@Nullable
 @Generated(value="lombok")
public Calendar getWPStartDate()
```
  Constraints: Not nullable, Precision: 7
  Provides the planning horizon. By default, the dates are taken from the assigned master project.
  
  Returns:
  
  Raw Text
- getWPEndDate
```
@Nullable
 @Generated(value="lombok")
public Calendar getWPEndDate()
```
  Constraints: Not nullable, Precision: 7
  Provides the planning horizon. By default, the dates are taken from the assigned master project.
  
  Returns:
  
  Raw Text
- getProjectName
```
@Nullable
 @Generated(value="lombok")
public String getProjectName()
```
  Constraints: Not nullable, Maximum length: 40
  
  Returns:
  
  Customer Project Name
- getErpConfigContext
```
@Nullable
 @Generated(value="lombok")
public ErpConfigContext getErpConfigContext()
```
  Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
  
  Returns:
  
  The stored ERP system context for executing queries, or null if no such context has been set.
- setChangedOn
```
@Generated(value="lombok")
public void setChangedOn(@Nullable
                                                    Calendar changedOn)
```
  Constraints: Not nullable, Precision: 7
  
  Parameters:
  
  changedOn -
- setProjectID
```
@Generated(value="lombok")
public void setProjectID(@Nullable
                                                    String projectID)
```
  Constraints: Not nullable, Maximum length: 40
  
  Parameters:
  
  projectID -
- setChangedBy
```
@Generated(value="lombok")
public void setChangedBy(@Nullable
                                                    String changedBy)
```
  Constraints: Not nullable, Maximum length: 12
  
  Parameters:
  
  changedBy -
- setWorkPackageID
```
@Generated(value="lombok")
public void setWorkPackageID(@Nullable
                                                        String workPackageID)
```
  (Key Field) Constraints: Not nullable, Maximum length: 50
  
  Parameters:
  
  workPackageID -
- setWorkPackageName
```
@Generated(value="lombok")
public void setWorkPackageName(@Nullable
                                                          String workPackageName)
```
  Constraints: Not nullable, Maximum length: 60
  
  Parameters:
  
  workPackageName -
- setWPStartDate
```
@Generated(value="lombok")
public void setWPStartDate(@Nullable
                                                      Calendar wPStartDate)
```
  Constraints: Not nullable, Precision: 7
  Provides the planning horizon. By default, the dates are taken from the assigned master project.
  
  Parameters:
  
  wPStartDate -
- setWPEndDate
```
@Generated(value="lombok")
public void setWPEndDate(@Nullable
                                                    Calendar wPEndDate)
```
  Constraints: Not nullable, Precision: 7
  Provides the planning horizon. By default, the dates are taken from the assigned master project.
  
  Parameters:
  
  wPEndDate -
- setProjectName
```
@Generated(value="lombok")
public void setProjectName(@Nullable
                                                      String projectName)
```
  Constraints: Not nullable, Maximum length: 40
  
  Parameters:
  
  projectName -
- setErpConfigContext
```
@Generated(value="lombok")
public void setErpConfigContext(@Nullable
                                                           ErpConfigContext erpConfigContext)
```
  Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
  
  Parameters:
  
  erpConfigContext -
- toString
```
@Generated(value="lombok")
public String toString()
```
  Overrides:
  
  toString in class VdmObject<Workpackage>
- equals
```
@Generated(value="lombok")
public boolean equals(Object o)
```
  Overrides:
  
  equals in class VdmObject<Workpackage>
- hashCode
```
@Generated(value="lombok")
public int hashCode()
```
  Overrides:
  
  hashCode in class VdmObject<Workpackage>

Class Workpackage

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject

Methods inherited from class java.lang.Object

Field Detail

ALL_FIELDS

CHANGED_ON

PROJECT_ID

CHANGED_BY

WORK_PACKAGE_ID

WORK_PACKAGE_NAME

WP_START_DATE

WP_END_DATE

PROJECT_NAME

TO_WORK_ITEM_SET

TO_PLAN_DATA_SET

Constructor Detail

Workpackage

Workpackage

Method Detail

getType

field

fetchWorkItemSet

getWorkItemSetOrFetch

getWorkItemSetOrNull

setWorkItemSet

addWorkItemSet

fetchPlanDataSet

getPlanDataSetOrFetch

getPlanDataSetOrNull

setPlanDataSet

addPlanDataSet

builder

getChangedOn

getProjectID

getChangedBy

getWorkPackageID

getWorkPackageName

getWPStartDate

getWPEndDate

getProjectName

getErpConfigContext

setChangedOn

setProjectID

setChangedBy

setWorkPackageID

setWorkPackageName

setWPStartDate

setWPEndDate

setProjectName

setErpConfigContext

toString

equals

hashCode