org.bonitasoft.engine.api.impl.transaction.AbstractGetEntity Maven / Gradle / Ivy
/**
* Copyright (C) 2015 BonitaSoft S.A.
* BonitaSoft, 32 rue Gustave Eiffel - 38000 Grenoble
* This library is free software; you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License as published by the Free Software Foundation
* version 2.1 of the License.
* This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
* Floor, Boston, MA 02110-1301, USA.
**/
package org.bonitasoft.engine.api.impl.transaction;
import java.io.Serializable;
import java.util.Collections;
import java.util.List;
import org.bonitasoft.engine.commons.exceptions.SBonitaException;
import org.bonitasoft.engine.commons.transaction.TransactionContentWithResult;
import org.bonitasoft.engine.persistence.OrderByOption;
import org.bonitasoft.engine.persistence.PersistentObject;
import org.bonitasoft.engine.persistence.QueryOptions;
import org.bonitasoft.engine.persistence.SBonitaReadException;
import org.bonitasoft.engine.search.Sort;
import org.bonitasoft.engine.search.descriptor.SearchEntityDescriptor;
/**
* Abstract class to allow to search server object and convert them to client object
*
* @author Celine Souchet
* @param
* The client object
* @param
* The server object
*/
public abstract class AbstractGetEntity implements TransactionContentWithResult> {
private final SearchEntityDescriptor searchDescriptor;
private final int numberOfResults;
private final int fromIndex;
private final Sort sort;
private List clientObjects;
/**
* @param searchDescriptor
* The descriptor corresponding to the searched object
* @param fromIndex
* The specified position to begin the search
* @param numberOfResults
* The number of elements to return
* @param sort
* How to sort the result
*/
public AbstractGetEntity(final SearchEntityDescriptor searchDescriptor, final int fromIndex, final int numberOfResults, final Sort sort) {
this.searchDescriptor = searchDescriptor;
this.numberOfResults = numberOfResults;
this.fromIndex = fromIndex;
this.sort = sort;
}
@Override
public void execute() throws SBonitaException {
if (searchDescriptor == null || sort == null) {
throw new SBonitaReadException("Sort and SearchDescriptor cannot be null");
}
final OrderByOption orderByOption = searchDescriptor.getEntityOrder(sort);
final QueryOptions searchOptions = new QueryOptions(fromIndex, numberOfResults, Collections.singletonList(orderByOption));
List serverObjects = executeGet(searchOptions);
clientObjects = convertToClientObjects(serverObjects);
}
/**
* Execute the search here
*
* @param queryOptions
* The query options to execute the search with
* @return The searched result
* @throws SBonitaException
*/
public abstract List executeGet(final QueryOptions queryOptions) throws SBonitaException;
/**
* Must convert server objects in client objects here
*
* @param serverObjects
* The server object to convert
* @return The list of the client objects
*/
public abstract List convertToClientObjects(final List serverObjects);
@Override
public List getResult() {
return clientObjects;
}
}