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

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

public class WorkPackage
extends VdmEntity<WorkPackage>

WorkPackage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkPackage.WorkPackageBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static WorkPackageSelectable	ALL_FIELDS Selector for all available fields of WorkPackage.
static WorkPackageField<String>	DESCRIPTION Use with available fluent helpers to apply the Description field to query operations.
static WorkPackageField<String>	PROJECT_ID Use with available fluent helpers to apply the ProjectID field to query operations.
static WorkPackageLink<Demand>	TO_DEMAND_SET Use with available fluent helpers to apply the DemandSet 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(String projectID, String description, String workPackageID, String workPackageName, Calendar wPStartDate, Calendar wPEndDate, ErpConfigContext erpConfigContext, List<WorkItem> toWorkItemSet, List<Demand> toDemandSet)

Method Summary

Modifier and Type	Method and Description
void	addDemandSet(Demand... entity) Adds elements to the list of associated Demand entities.
void	addWorkItemSet(WorkItem... entity) Adds elements to the list of associated WorkItem entities.
static WorkPackage.WorkPackageBuilder	builder()
boolean	equals(Object o)
List<Demand>	fetchDemandSet() Fetches the Demand 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.
List<Demand>	getDemandSetOrFetch() Retrieval of associated Demand entities (one to many).
com.google.common.base.Optional<List<Demand>>	getDemandSetOrNull() Retrieval of associated Demand entities (one to many).
String	getDescription() Constraints: none
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
String	getProjectID() (Key Field) 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() (Key Field) Constraints: Not nullable, Maximum length: 60
Calendar	getWPEndDate() Constraints: Not nullable, Precision: 7
Calendar	getWPStartDate() Constraints: Not nullable, Precision: 7
int	hashCode()
void	setDemandSet(List<Demand> value) Overwrites the list of associated Demand entities for the loaded navigation property DemandSet.
void	setDescription(String description) Constraints: none
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setProjectID(String projectID) (Key Field) 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) (Key Field) 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 WorkPackageSelectable ALL_FIELDS

Selector for all available fields of WorkPackage.

PROJECT_ID

public static final WorkPackageField<String> PROJECT_ID

Use with available fluent helpers to apply the ProjectID field to query operations.

DESCRIPTION

public static final WorkPackageField<String> DESCRIPTION

Use with available fluent helpers to apply the Description 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.

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_DEMAND_SET

public static final WorkPackageLink<Demand> TO_DEMAND_SET

Use with available fluent helpers to apply the DemandSet navigation property to query operations.

Constructor Detail

WorkPackage

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

WorkPackage

@ConstructorProperties(value={"projectID","description","workPackageID","workPackageName","wPStartDate","wPEndDate","erpConfigContext","toWorkItemSet","toDemandSet"})
 @Generated(value="lombok")
public WorkPackage(@Nullable
                                                                                                                                                                                                                      String projectID,
                                                                                                                                                                                                                      @Nullable
                                                                                                                                                                                                                      String description,
                                                                                                                                                                                                                      @Nullable
                                                                                                                                                                                                                      String workPackageID,
                                                                                                                                                                                                                      @Nullable
                                                                                                                                                                                                                      String workPackageName,
                                                                                                                                                                                                                      @Nullable
                                                                                                                                                                                                                      Calendar wPStartDate,
                                                                                                                                                                                                                      @Nullable
                                                                                                                                                                                                                      Calendar wPEndDate,
                                                                                                                                                                                                                      @Nullable
                                                                                                                                                                                                                      ErpConfigContext erpConfigContext,
                                                                                                                                                                                                                      List<WorkItem> toWorkItemSet,
                                                                                                                                                                                                                      List<Demand> toDemandSet)

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.

fetchDemandSet

public List<Demand> fetchDemandSet()
                            throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the Demand entities (one to many) associated with this entity. This corresponds to the OData navigation property DemandSet.

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

Returns:

List containing one or more associated Demand 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.

getDemandSetOrFetch

public List<Demand> getDemandSetOrFetch()
                                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated Demand entities (one to many).

If the navigation property DemandSet 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 Demand 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.

getDemandSetOrNull

public com.google.common.base.Optional<List<Demand>> getDemandSetOrNull()

Retrieval of associated Demand entities (one to many).

If the navigation property DemandSet 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 DemandSet is already loaded, the result will contain the Demand entities. If not, a null value state is returned.

setDemandSet

public void setDemandSet(@NonNull
                         List<Demand> value)

Overwrites the list of associated Demand entities for the loaded navigation property DemandSet.

If the navigation property DemandSet 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 Demand entities.

addDemandSet

public void addDemandSet(Demand... entity)

Adds elements to the list of associated Demand entities.

If the navigation property DemandSet 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 Demand entities.

builder

@Generated(value="lombok")
public static WorkPackage.WorkPackageBuilder builder()

getProjectID

@Nullable
 @Generated(value="lombok")
public String getProjectID()

(Key Field) Constraints: Not nullable, Maximum length: 40

Returns:

Identifies a master project.

getDescription

@Nullable
 @Generated(value="lombok")
public String getDescription()

Constraints: none

Returns:

Work Package Desc.

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()

(Key Field) 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

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.

setProjectID

@Generated(value="lombok")
public void setProjectID(@Nullable
                                                    String projectID)

(Key Field) Constraints: Not nullable, Maximum length: 40

Parameters:

projectID -

setDescription

@Generated(value="lombok")
public void setDescription(@Nullable
                                                      String description)

Constraints: none

Parameters:

description -

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)

(Key Field) 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 -

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>