org.bonitasoft.engine.api.impl.transaction

Class AbstractGetEntity<C extends Serializable,S extends org.bonitasoft.engine.persistence.PersistentObject>

java.lang.Object

org.bonitasoft.engine.api.impl.transaction.AbstractGetEntity<C,S>

Type Parameters:

C - The client object

S - The server object

All Implemented Interfaces:

org.bonitasoft.engine.commons.transaction.TransactionContent, org.bonitasoft.engine.commons.transaction.TransactionContentWithResult<List<C>>

Direct Known Subclasses:

AbstractGetProcessDeploymentInfo

public abstract class AbstractGetEntity<C extends Serializable,S extends org.bonitasoft.engine.persistence.PersistentObject>
extends Object
implements org.bonitasoft.engine.commons.transaction.TransactionContentWithResult<List<C>>

Abstract class to allow to search server object and convert them to client object

Author:

Celine Souchet

Constructor Summary

Constructors

Constructor and Description
AbstractGetEntity(SearchEntityDescriptor searchDescriptor, int fromIndex, int numberOfResults, Sort sort)

Method Summary

Methods

Modifier and Type	Method and Description
abstract List<C>	convertToClientObjects(List<S> serverObjects) Must convert server objects in client objects here
void	execute()
abstract List<S>	executeGet(org.bonitasoft.engine.persistence.QueryOptions queryOptions) Execute the search here
List<C>	getResult()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGetEntity

public AbstractGetEntity(SearchEntityDescriptor searchDescriptor,
                 int fromIndex,
                 int numberOfResults,
                 Sort sort)

Parameters:

searchDescriptor - The descriptor corresponding to the searched object

fromIndex - The specified position to begin the search

numberOfResults - The number of elements to return

sort - How to sort the result

Method Detail

execute

public void execute()
             throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Specified by:

execute in interface org.bonitasoft.engine.commons.transaction.TransactionContent

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

executeGet

public abstract List<S> executeGet(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                                                                                       throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Execute the search here

Parameters:

queryOptions - The query options to execute the search with

Returns:

The searched result

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

convertToClientObjects

public abstract List<C> convertToClientObjects(List<S> serverObjects)

Must convert server objects in client objects here

Parameters:

serverObjects - The server object to convert

Returns:

The list of the client objects

getResult

public List<C> getResult()

Specified by:

getResult in interface org.bonitasoft.engine.commons.transaction.TransactionContentWithResult<List<C extends Serializable>>