com.sap.cloud.sdk.datamodel.odatav4.core

Class StructuredPropertyCollection<EntityT extends VdmEntity<?>,TargetT extends VdmObject<?>>

java.lang.Object

com.sap.cloud.sdk.datamodel.odatav4.core.StructuredPropertyCollection<EntityT,TargetT>

Type Parameters:

EntityT - Entity this property is part of.

TargetT - Entity type of the collection this property references to.

Direct Known Subclasses:

ComplexProperty.Collection, NavigationProperty.Collection

public abstract class StructuredPropertyCollection<EntityT extends VdmEntity<?>,TargetT extends VdmObject<?>>
extends Object

Abstract class representing the query capabilities of a collection of structured properties of EntityT with a type of TargetT.

Constructor Summary

Constructors

Constructor and Description
StructuredPropertyCollection()

Method Summary

Modifier and Type	Method and Description
StructuredPropertyCollectionQuery<EntityT,TargetT>	filter(FilterableBoolean<TargetT>... filters) Filter on properties of EntityT.
StructuredPropertyCollectionQuery<EntityT,TargetT>	orderBy(FieldOrdering<TargetT>... ordering) Sort the set of returned entities by non-complex fields.
StructuredPropertyCollectionQuery<EntityT,TargetT>	search(SearchExpression expression) Request modifier to return the set of entities corresponding to the specified boolean expression.
StructuredPropertyCollectionQuery<EntityT,TargetT>	search(String search) Request modifier to return the set of entities that contain the specified value.
StructuredPropertyCollectionQuery<EntityT,TargetT>	select(Property<TargetT>... fields) Query modifier to limit which field values of the entity EntityT get fetched and populated.
StructuredPropertyCollectionQuery<EntityT,TargetT>	skip(int skip) Determine the how many first N entities of the result set should be skipped.
StructuredPropertyCollectionQuery<EntityT,TargetT>	top(int top) Limit the number of results of this request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.client.expression.FieldReference

getExpression, getFieldName, of

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.client.expression.Expressions.Operand

getExpression

Constructor Detail

StructuredPropertyCollection

public StructuredPropertyCollection()

Method Detail

select

@SafeVarargs
 @Nonnull
public final StructuredPropertyCollectionQuery<EntityT,TargetT> select(@Nonnull
                                                                                              Property<TargetT>... fields)

Query modifier to limit which field values of the entity EntityT get fetched and populated. Navigational properties supplied here will be expanded. If this method is called at least once, then only the specified fields will be fetched and populated. If none of the select methods is called, then all fields will be fetched and populated. Calling this multiple times will combine the set(s) of fields of each call.

Parameters:

fields - Properties of EntityT to be selected.

Returns:

This request object with the added selections.

filter

@SafeVarargs
 @Nonnull
public final StructuredPropertyCollectionQuery<EntityT,TargetT> filter(@Nonnull
                                                                                              FilterableBoolean<TargetT>... filters)

Filter on properties of EntityT.

Parameters:

filters - Filter expressions to be added to the request.

Returns:

This request object with the added filters.

top

@Nonnull
public StructuredPropertyCollectionQuery<EntityT,TargetT> top(int top)

Limit the number of results of this request.

Parameters:

top - The maximum amount of elements this request shall return.

Returns:

This request with the top parameter set.

skip

@Nonnull
public StructuredPropertyCollectionQuery<EntityT,TargetT> skip(int skip)

Determine the how many first N entities of the result set should be skipped. If this method is never called, then the full list will be returned from the first entity. If this method is called multiple times, then only the value of the last call will be used.

Parameters:

skip - The amount of elements this request will skip.

Returns:

This request with the skip parameter set.

orderBy

@SafeVarargs
 @Nonnull
 @Beta
public final StructuredPropertyCollectionQuery<EntityT,TargetT> orderBy(@Nonnull
                                                                                                      FieldOrdering<TargetT>... ordering)

Sort the set of returned entities by non-complex fields.

Parameters:

ordering - Fields to sort by.

Returns:

This request with the orderBy parameter set.

search

@Nonnull
public StructuredPropertyCollectionQuery<EntityT,TargetT> search(@Nonnull
                                                                          String search)

Request modifier to return the set of entities that contain the specified value. If this method is never called, then all the accessible entities will be returned.

Parameters:

search - A string value as the search criteria.

Returns:

The same fluent helper with this request modifier applied.

search

@Nonnull
public StructuredPropertyCollectionQuery<EntityT,TargetT> search(@Nonnull
                                                                          SearchExpression expression)

Request modifier to return the set of entities corresponding to the specified boolean expression. If this method is never called, then all the accessible entities will be returned.

Parameters:

expression - SearchExpression as the search criteria

Returns:

The same fluent helper with this request modifier applied.