org.aludratest.hpalm.service
Interface HpAlmInteraction

All Superinterfaces:

org.aludratest.service.Action, org.aludratest.service.Interaction

All Known Implementing Classes:

HpAlmInteractionImpl

public interface HpAlmInteraction
extends org.aludratest.service.Interaction

Method Summary

Entity	createEntity(EntityType entityType, Entity value) Creates a new entity of the given type.
void	deleteEntity(EntityType entityType, long id) Deletes the given entity.
EntityCollection	getAllEntities(EntityType entityType) Returns a collection with all entities of a given entity type.
ServerTime	getServerTime() Returns the server time of the HP ALM server.
Entity	getSingleEntity(EntityType entityType, long id) Returns a single entity of the given type with the given ID.
EntityCollection	queryEntities(EntityType entityType, String query) Executes a complex query in HP ALM for entities of a given type.
void	updateEntity(EntityType entityType, long id, Entity value) Updates the given entity.

Methods inherited from interface org.aludratest.service.Action

createAttachments, createDebugAttachments, setSystemConnector

Method Detail

getServerTime

ServerTime getServerTime()

Returns the server time of the HP ALM server.

Returns:

The server time of the HP ALM server.

getAllEntities

EntityCollection getAllEntities(EntityType entityType)

Returns a collection with all entities of a given entity type.

Parameters:

entityType - Entity type to retrieve the entities from.

Returns:

Collection with all entities of this type. This collection may or may not be paging, i.e. after N elements, a new query to the HP ALM server could automatically be issued to retrieve next N elements.

getSingleEntity

Entity getSingleEntity(EntityType entityType,
                       long id)

Returns a single entity of the given type with the given ID.

Parameters:

entityType - Type of the entity.

id - ID of the entity.

Returns:

The entity.

createEntity

Entity createEntity(EntityType entityType,
                    Entity value)

Creates a new entity of the given type. The entity object must have all desired (and required) values set, but must not have an ID set. The method returns the newly created entity object, which can e.g. be queried for the generated ID.

Parameters:

entityType - Type of the entity to create.

value - Entity containing all required values. Do not use this object after a call to this method.

Returns:

The created entity. Use this result for further operations on this entity.

updateEntity

void updateEntity(EntityType entityType,
                  long id,
                  Entity value)

Updates the given entity.

Parameters:

entityType - Type of the entity to update.

id - ID of the entity to update.

value - Entity object containing all fields for the entity.

deleteEntity

void deleteEntity(EntityType entityType,
                  long id)

Deletes the given entity.

Parameters:

entityType - Type of the entity to delete.

id - ID of the entity to delete.

queryEntities

EntityCollection queryEntities(EntityType entityType,
                               String query)

Executes a complex query in HP ALM for entities of a given type.

Parameters:

entityType - Type of the entities to query.

query - A complex HP ALM query. See HP ALM REST API documentation for query syntax.

Returns:

Collection with all entities matching the query (maybe none). This collection may or may not be paging, i.e. after N elements, a new query to the HP ALM server could automatically be issued to retrieve next N elements.