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

Class GetEntities

java.lang.Object

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

public class GetEntities
extends Object

This class hold the GetEntities objects and serve all functions concern to REST GetEntities.
As of Octane version 12.60.60 only a limited number of fields are returned by default. Therefore the addFields(String...) method should be used. @see here for more information

Field Summary

Fields

Modifier and Type	Field and Description
protected OctaneRequest	octaneRequest

Constructor Summary

Constructors

Constructor and Description
GetEntities(OctaneHttpClient octaneHttpClient, String urlDomain)

Method Summary

Modifier and Type	Method and Description
GetEntities	addFields(String... fields) Add Fields parameters
GetEntities	addOrderBy(String orderBy, boolean asc) Add OrderBy parameters
GetEntities	addPath(String path) Append a new path element, for special cases
OctaneCollection<EntityModel>	execute() 1.
OctaneCollection<EntityModel>	execute(APIMode apiMode) 1.
GetEntities	limit(int limit) Add Limit parameter
GetEntities	offset(int offset) Add offset parameter
GetEntities	query(Query query)

Methods inherited from class java.lang.Object

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

Field Detail

octaneRequest

protected final OctaneRequest octaneRequest

Constructor Detail

GetEntities

public GetEntities(OctaneHttpClient octaneHttpClient,
                   String urlDomain)

Method Detail

execute

public OctaneCollection<EntityModel> execute()

1. Request GetEntities Execution
2. Parse response to a new Collection object

Returns:

a collection of entities models that have been retrieved

execute

public OctaneCollection<EntityModel> execute(APIMode apiMode)

1. Request GetEntities Execution
using a custom api mode value 2. Parse response to a new Collection object

Returns:

a collection of entities models that have been retrieved

addFields

public GetEntities addFields(String... fields)

Add Fields parameters

Parameters:

fields - An array of fields that will be part of the HTTP Request

Returns:

GetEntities Object with new Fields parameters

limit

public GetEntities limit(int limit)

Add Limit parameter

Parameters:

limit - The entity limit

Returns:

GetEntities Object with new limit parameter

offset

public GetEntities offset(int offset)

Add offset parameter

Parameters:

offset - The entity limit offset

Returns:

GetEntities Object with new offset parameter

addOrderBy

public GetEntities addOrderBy(String orderBy,
                              boolean asc)

Add OrderBy parameters

Parameters:

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

asc - - true=ascending/false=descending

Returns:

GetEntities Object with new OrderBy parameters

query

public GetEntities query(Query query)

Parameters:

query - The query to use

Returns:

The object

addPath

public GetEntities addPath(String path)

Append a new path element, for special cases

Parameters:

path - The new path section to be added

Returns:

this