com.hpe.adm.nga.sdk.entities.get

Class GetTypedEntities<T extends TypedEntityModel,E extends GetTypedEntities,F extends TypedEntityList.AvailableFields,G extends TypedEntityList.SortableFields>

java.lang.Object

com.hpe.adm.nga.sdk.entities.TypedEntityList.TypedEntityRequest<T>

com.hpe.adm.nga.sdk.entities.get.GetTypedEntities<T,E,F,G>

Type Parameters:

T - The type of the entity model

E - The implementing subclass of this class

F - The type of TypedEntityList.AvailableFields

G - The type of TypedEntityList.SortableFields

public abstract class GetTypedEntities<T extends TypedEntityModel,E extends GetTypedEntities,F extends TypedEntityList.AvailableFields,G extends TypedEntityList.SortableFields>
extends TypedEntityList.TypedEntityRequest<T>

The generic super class for the context of get for typed entities.

See Also:

for the non typed version

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GetTypedEntities(Class<T> typedEntityModelClass, OctaneHttpClient octaneHttpClient, String baseDomain)

Method Summary

Modifier and Type	Method and Description
E	addFields(F... fields) Adds fields of type F
E	addOrderBy(G sortableField, boolean asc) Add OrderBy parameters
OctaneCollection<T>	execute() Carries out the execution and returns the entities
OctaneCollection<T>	execute(APIMode header) Carries out the execution and returns the entities, using a custom api mode
E	limit(int limit) Add Limit parameter
E	offset(int offset) Add offset parameter
E	query(Query query)

Methods inherited from class com.hpe.adm.nga.sdk.entities.TypedEntityList.TypedEntityRequest

getEntityInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

GetTypedEntities

protected GetTypedEntities(Class<T> typedEntityModelClass,
                           OctaneHttpClient octaneHttpClient,
                           String baseDomain)

Method Detail

execute

public final OctaneCollection<T> execute()

Carries out the execution and returns the entities

Returns:

The entities

execute

public final OctaneCollection<T> execute(APIMode header)

Carries out the execution and returns the entities, using a custom api mode

Returns:

The entities

addFields

public final E addFields(F... fields)

Adds fields of type F

Parameters:

fields - Array of fields

Returns:

this instance

limit

public final E limit(int limit)

Add Limit parameter

Parameters:

limit - The entity limit

Returns:

this instance

offset

public final E offset(int offset)

Add offset parameter

Parameters:

offset - The entity limit offset

Returns:

this instance

addOrderBy

public final E addOrderBy(G sortableField,
                          boolean asc)

Add OrderBy parameters

Parameters:

sortableField - The string which determines how the entities should be ordered

asc - - true=ascending/false=descending

Returns:

this instance

query

public final E query(Query query)

Parameters:

query - The query to use

Returns:

this instance