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

Class Project

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>

com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<Project>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.masterdataforgroupreporting.Project

public class Project
extends VdmEntity<Project>

Consolidation - Combined Project

Original entity name from the Odata EDM: ProjectType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ProjectField<String>	ADDITIONAL_MASTER_DATA_SOURCE Use with available fluent helpers to apply the AdditionalMasterDataSource field to query operations.
static ProjectSelectable	ALL_FIELDS Selector for all available fields of Project.
static ProjectField<String>	PROJECT Use with available fluent helpers to apply the Project field to query operations.
static ProjectField<String>	PROJECT_TEXT Use with available fluent helpers to apply the Project_Text field to query operations.
static ProjectLink<ProjectHier>	TO_CNSLDTN_PROJECT_HIER Use with available fluent helpers to apply the to_CnsldtnProjectHier navigation property to query operations.
static ProjectLink<ProjectText>	TO_CNSLDTN_PROJECT_T Use with available fluent helpers to apply the to_CnsldtnProjectT navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
Project()
Project(String project, String project_Text, String additionalMasterDataSource, List<ProjectHier> toCnsldtnProjectHier, List<ProjectText> toCnsldtnProjectT)

Method Summary

Modifier and Type	Method and Description
void	addCnsldtnProjectHier(ProjectHier... entity) Adds elements to the list of associated ProjectHier entities.
void	addCnsldtnProjectT(ProjectText... entity) Adds elements to the list of associated ProjectText entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static Project.ProjectBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<ProjectHier>	fetchCnsldtnProjectHier() Fetches the ProjectHier entities (one to many) associated with this entity.
List<ProjectText>	fetchCnsldtnProjectT() Fetches the ProjectText entities (one to many) associated with this entity.
static <T> ProjectField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> ProjectField<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	getAdditionalMasterDataSource() Constraints: Not nullable, Maximum length: 10
io.vavr.control.Option<List<ProjectHier>>	getCnsldtnProjectHierIfPresent() Retrieval of associated ProjectHier entities (one to many).
List<ProjectHier>	getCnsldtnProjectHierOrFetch() Retrieval of associated ProjectHier entities (one to many).
io.vavr.control.Option<List<ProjectText>>	getCnsldtnProjectTIfPresent() Retrieval of associated ProjectText entities (one to many).
List<ProjectText>	getCnsldtnProjectTOrFetch() Retrieval of associated ProjectText entities (one to many).
protected String	getDefaultServicePath() Used by fluent helpers and navigation property methods to construct OData queries.
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection() Used by fluent helpers and navigation property methods to construct OData queries.
protected Map<String,Object>	getKey()
String	getProject_Text() Constraints: Not nullable, Maximum length: 40
String	getProject() (Key Field) Constraints: Not nullable, Maximum length: 24
Class<Project>	getType()
int	hashCode()
void	setAdditionalMasterDataSource(String additionalMasterDataSource) Constraints: Not nullable, Maximum length: 10
void	setCnsldtnProjectHier(List<ProjectHier> value) Overwrites the list of associated ProjectHier entities for the loaded navigation property to_CnsldtnProjectHier.
void	setCnsldtnProjectT(List<ProjectText> value) Overwrites the list of associated ProjectText entities for the loaded navigation property to_CnsldtnProjectT.
void	setProject_Text(String project_Text) Constraints: Not nullable, Maximum length: 40
void	setProject(String project) (Key Field) Constraints: Not nullable, Maximum length: 24
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
protected Map<String,Object>	toMapOfFields()
protected Map<String,Object>	toMapOfNavigationProperties()
String	toString()

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

getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.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 ProjectSelectable ALL_FIELDS

Selector for all available fields of Project.

PROJECT

public static final ProjectField<String> PROJECT

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

PROJECT_TEXT

public static final ProjectField<String> PROJECT_TEXT

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

ADDITIONAL_MASTER_DATA_SOURCE

public static final ProjectField<String> ADDITIONAL_MASTER_DATA_SOURCE

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

TO_CNSLDTN_PROJECT_HIER

public static final ProjectLink<ProjectHier> TO_CNSLDTN_PROJECT_HIER

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

TO_CNSLDTN_PROJECT_T

public static final ProjectLink<ProjectText> TO_CNSLDTN_PROJECT_T

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

Constructor Detail

Project

public Project()

Project

public Project(@Nullable
               String project,
               @Nullable
               String project_Text,
               @Nullable
               String additionalMasterDataSource,
               List<ProjectHier> toCnsldtnProjectHier,
               List<ProjectText> toCnsldtnProjectT)

Method Detail

getType

@Nonnull
public Class<Project> getType()

Specified by:

getType in class VdmObject<Project>

Returns:

The class of this object.

setProject

public void setProject(@Nullable
                       String project)

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

Original property name from the Odata EDM: Project

Parameters:

project - Key identifying a project definition.

setProject_Text

public void setProject_Text(@Nullable
                            String project_Text)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: Project_Text

Parameters:

project_Text - Project Definition Description

setAdditionalMasterDataSource

public void setAdditionalMasterDataSource(@Nullable
                                          String additionalMasterDataSource)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: AdditionalMasterDataSource

Parameters:

additionalMasterDataSource - Master Data Source

getEntityCollection

protected String getEntityCollection()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Specified by:

getEntityCollection in class VdmEntity<Project>

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<Project>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<Project>

fromMap

protected void fromMap(Map<String,Object> inputValues)

Overrides:

fromMap in class VdmObject<Project>

field

@Nonnull
public static <T> ProjectField<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> ProjectField<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.

getDestinationForFetch

@Nullable
public HttpDestinationProperties getDestinationForFetch()

Description copied from class: VdmEntity

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

Overrides:

getDestinationForFetch in class VdmEntity<Project>

Returns:

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

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

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nonnull
                            HttpDestinationProperties destination)

Description copied from class: VdmEntity

Sets the service path and destination for the fetch commands of this entity. 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<Project>

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.

destination - New destination to apply to this entity and any associated entities that were previously fetched.

getDefaultServicePath

protected String getDefaultServicePath()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Overrides:

getDefaultServicePath in class VdmEntity<Project>

Returns:

Default context path to the OData service. In other words, everything in between the protocol://hostname:port and the OData resource name (entity set, $metadata, etc.)

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<Project>

fetchCnsldtnProjectHier

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

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

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

Returns:

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

getCnsldtnProjectHierOrFetch

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

Retrieval of associated ProjectHier entities (one to many). This corresponds to the OData navigation property to_CnsldtnProjectHier.

If the navigation property to_CnsldtnProjectHier of a queried Project 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 ProjectHier 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.

getCnsldtnProjectHierIfPresent

@Nonnull
public io.vavr.control.Option<List<ProjectHier>> getCnsldtnProjectHierIfPresent()

Retrieval of associated ProjectHier entities (one to many). This corresponds to the OData navigation property to_CnsldtnProjectHier.

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

setCnsldtnProjectHier

public void setCnsldtnProjectHier(@Nonnull
                                  List<ProjectHier> value)

Overwrites the list of associated ProjectHier entities for the loaded navigation property to_CnsldtnProjectHier.

If the navigation property to_CnsldtnProjectHier of a queried Project 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 ProjectHier entities.

addCnsldtnProjectHier

public void addCnsldtnProjectHier(ProjectHier... entity)

Adds elements to the list of associated ProjectHier entities. This corresponds to the OData navigation property to_CnsldtnProjectHier.

If the navigation property to_CnsldtnProjectHier of a queried Project 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 ProjectHier entities.

fetchCnsldtnProjectT

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

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

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

Returns:

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

getCnsldtnProjectTOrFetch

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

Retrieval of associated ProjectText entities (one to many). This corresponds to the OData navigation property to_CnsldtnProjectT.

If the navigation property to_CnsldtnProjectT of a queried Project 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 ProjectText 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.

getCnsldtnProjectTIfPresent

@Nonnull
public io.vavr.control.Option<List<ProjectText>> getCnsldtnProjectTIfPresent()

Retrieval of associated ProjectText entities (one to many). This corresponds to the OData navigation property to_CnsldtnProjectT.

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

setCnsldtnProjectT

public void setCnsldtnProjectT(@Nonnull
                               List<ProjectText> value)

Overwrites the list of associated ProjectText entities for the loaded navigation property to_CnsldtnProjectT.

If the navigation property to_CnsldtnProjectT of a queried Project 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 ProjectText entities.

addCnsldtnProjectT

public void addCnsldtnProjectT(ProjectText... entity)

Adds elements to the list of associated ProjectText entities. This corresponds to the OData navigation property to_CnsldtnProjectT.

If the navigation property to_CnsldtnProjectT of a queried Project 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 ProjectText entities.

builder

public static Project.ProjectBuilder builder()

getProject

@Nullable
public String getProject()

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

Original property name from the Odata EDM: Project

Returns:

Key identifying a project definition.

getProject_Text

@Nullable
public String getProject_Text()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: Project_Text

Returns:

Project Definition Description

getAdditionalMasterDataSource

@Nullable
public String getAdditionalMasterDataSource()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: AdditionalMasterDataSource

Returns:

Master Data Source

toString

public String toString()

Overrides:

toString in class VdmObject<Project>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<Project>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<Project>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<Project>