com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.commercialprojectdetail

Class Workpackage

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.commercialprojectdetail.Workpackage

public class Workpackage
extends VdmEntity<Workpackage>

Original entity name from the Odata EDM: Workpackage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Workpackage.WorkpackageBuilder Helper class to allow for fluent creation of Workpackage instances.

Field Summary

Fields

Modifier and Type	Field and Description
static WorkpackageSelectable	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<ZonedDateTime>	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<LocalDateTime>	WP_END_DATE Use with available fluent helpers to apply the WPEndDate field to query operations.
static WorkpackageField<LocalDateTime>	WP_START_DATE Use with available fluent helpers to apply the WPStartDate field to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
Workpackage()
Workpackage(ZonedDateTime changedOn, String projectID, String changedBy, String workPackageID, String workPackageName, LocalDateTime wPStartDate, LocalDateTime wPEndDate, String projectName, List<WorkItem> toWorkItemSet, List<PlanData> toPlanDataSet)

Method Summary

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.
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
static Workpackage.WorkpackageBuilder	builder()
protected boolean	canEqual(Object other)
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.
static <T,DomainT> WorkpackageField<T>	field(String fieldName, TypeConverter<T,DomainT> typeConverter) Use with available fluent helpers to apply an extension field to query operations.
protected void	fromMap(Map<String,Object> inputValues)
String	getChangedBy() Constraints: Not nullable, Maximum length: 12
ZonedDateTime	getChangedOn() Constraints: Not nullable, Precision: 7
protected String	getDefaultServicePath()
protected String	getEntityCollection()
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
protected Map<String,Object>	getKey()
Optional<List<PlanData>>	getPlanDataSetIfPresent() Retrieval of associated PlanData entities (one to many).
List<PlanData>	getPlanDataSetOrFetch() 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()
Optional<List<WorkItem>>	getWorkItemSetIfPresent() Retrieval of associated WorkItem entities (one to many).
List<WorkItem>	getWorkItemSetOrFetch() 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
LocalDateTime	getWPEndDate() Constraints: Not nullable, Precision: 7
LocalDateTime	getWPStartDate() Constraints: Not nullable, Precision: 7
int	hashCode()
void	setChangedBy(String changedBy) Constraints: Not nullable, Maximum length: 12
void	setChangedOn(ZonedDateTime changedOn) Constraints: Not nullable, Precision: 7
void	setErpConfigContext(ErpConfigContext erpConfigContext) Deprecated. Use attachToService(String, ErpConfigContext) instead.
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
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
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(LocalDateTime wPEndDate) Constraints: Not nullable, Precision: 7
void	setWPStartDate(LocalDateTime wPStartDate) Constraints: Not nullable, Precision: 7
protected Map<String,Object>	toMapOfFields()
protected Map<String,Object>	toMapOfNavigationProperties()
String	toString()

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

getEndpointUrl, getServicePathForFetch, getVersionIdentifier, setVersionIdentifier

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

getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final WorkpackageSelectable ALL_FIELDS

Selector for all available fields of Workpackage.

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_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

public Workpackage()

Workpackage

public Workpackage(@Nullable
                   ZonedDateTime changedOn,
                   @Nullable
                   String projectID,
                   @Nullable
                   String changedBy,
                   @Nullable
                   String workPackageID,
                   @Nullable
                   String workPackageName,
                   @Nullable
                   LocalDateTime wPStartDate,
                   @Nullable
                   LocalDateTime wPEndDate,
                   @Nullable
                   String projectName,
                   List<WorkItem> toWorkItemSet,
                   List<PlanData> toPlanDataSet)

Method Detail

getType

@Nonnull
public Class<Workpackage> getType()

Specified by:

getType in class VdmObject<Workpackage>

Returns:

The class of this object.

setChangedOn

public void setChangedOn(@Nullable
                         ZonedDateTime changedOn)

Constraints: Not nullable, Precision: 7

Original property name from the Odata EDM: ChangedOn

Parameters:

changedOn - Draft Last 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 - Identifies a master project.

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 - Plan Item

setWorkPackageName

public void setWorkPackageName(@Nullable
                               String workPackageName)

Constraints: Not nullable, Maximum length: 60

Original property name from the Odata EDM: WorkPackageName

Parameters:

workPackageName - Plan Item Description

setWPStartDate

public void setWPStartDate(@Nullable
                           LocalDateTime wPStartDate)

Constraints: Not nullable, Precision: 7

Original property name from the Odata EDM: WPStartDate

Provides the planning horizon. By default, the dates are taken from the assigned master project.

Parameters:

wPStartDate - Raw Text

setWPEndDate

public void setWPEndDate(@Nullable
                         LocalDateTime wPEndDate)

Constraints: Not nullable, Precision: 7

Original property name from the Odata EDM: WPEndDate

Provides the planning horizon. By default, the dates are taken from the assigned master project.

Parameters:

wPEndDate - Raw Text

setProjectName

public void setProjectName(@Nullable
                           String projectName)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: ProjectName

Parameters:

projectName - Customer 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>

Returns:

The compound key of this object.

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 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.

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Description copied from class: VdmEntity

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities). New ERP configuration context to apply to this entity

Overrides:

getErpConfigContext in class VdmEntity<Workpackage>

Returns:

The stored ERP system context for executing queries, or null if no such context has been set.

setErpConfigContext

@Deprecated
public void setErpConfigContext(@Nullable
                                            ErpConfigContext erpConfigContext)

Deprecated. Use attachToService(String, ErpConfigContext) instead.

Description copied from class: VdmEntity

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Overrides:

setErpConfigContext in class VdmEntity<Workpackage>

Parameters:

erpConfigContext - New ERP configuration context to apply to this entity

setServicePathForFetch

protected void setServicePathForFetch(@Nullable
                                      String servicePathForFetch)

Description copied from class: VdmEntity

The service path only used for the fetch commands of this entity.

Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.

Overrides:

setServicePathForFetch in class VdmEntity<Workpackage>

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nullable
                            ErpConfigContext configContext)

Description copied from class: VdmEntity

Sets the service path and ERP configuration context for the fetch commands of this entity. Ensures that both are set to some value by using defaults if null values are provided in the arguments. Existing values are preserved if null values are provided in the arguments. Also applies to any associated entities (navigation properties) that were previously fetched.

Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.

Overrides:

attachToService in class VdmEntity<Workpackage>

Parameters:

servicePath - Optional parameter. New service path to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the service path has never been set, then the service path will be set to the default defined in the corresponding service interface.

configContext - Optional parameter. New ERP configuration context to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the ERP configuration context has never been set, then the ERP configuration context will be set to a new instance of ErpConfigContext.

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<Workpackage>

toMapOfNavigationProperties

@Nonnull
protected Map<String,Object> toMapOfNavigationProperties()

Overrides:

toMapOfNavigationProperties in class VdmObject<Workpackage>

fetchWorkItemSet

@Nonnull
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

@Nonnull
public List<WorkItem> getWorkItemSetOrFetch()
                                              throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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.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.

getWorkItemSetIfPresent

@Nonnull
public Optional<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 Optional 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 Optional 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()
                                         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

@Nonnull
public List<PlanData> getPlanDataSetOrFetch()
                                              throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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.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.

getPlanDataSetIfPresent

@Nonnull
public Optional<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 Optional 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 Optional 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

public static Workpackage.WorkpackageBuilder builder()

getChangedOn

@Nullable
public ZonedDateTime getChangedOn()

Constraints: Not nullable, Precision: 7

Original property name from the Odata EDM: ChangedOn

Returns:

Draft Last Changed On

getProjectID

@Nullable
public String getProjectID()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: ProjectID

Returns:

Identifies a master project.

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:

Plan Item

getWorkPackageName

@Nullable
public String getWorkPackageName()

Constraints: Not nullable, Maximum length: 60

Original property name from the Odata EDM: WorkPackageName

Returns:

Plan Item Description

getWPStartDate

@Nullable
public LocalDateTime getWPStartDate()

Constraints: Not nullable, Precision: 7

Original property name from the Odata EDM: WPStartDate

Provides the planning horizon. By default, the dates are taken from the assigned master project.

Returns:

Raw Text

getWPEndDate

@Nullable
public LocalDateTime getWPEndDate()

Constraints: Not nullable, Precision: 7

Original property name from the Odata EDM: WPEndDate

Provides the planning horizon. By default, the dates are taken from the assigned master project.

Returns:

Raw Text

getProjectName

@Nullable
public String getProjectName()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: ProjectName

Returns:

Customer Project Name

toString

public String toString()

Overrides:

toString in class VdmObject<Workpackage>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<Workpackage>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<Workpackage>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<Workpackage>