QueryInterface.java

/**
 * Licensed to the Austrian Association for Software Tool Integration (AASTI)
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. The AASTI licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.openengsb.core.ekb.api;

import java.util.List;
import java.util.UUID;

import org.openengsb.core.api.model.CommitMetaInfo;
import org.openengsb.core.api.model.CommitQueryRequest;
import org.openengsb.core.api.model.QueryRequest;

/**
 * The query interface provides the functions to access the data stored in the EDB.
 */
public interface QueryInterface {

    /**
     * Loads the most actual tool data from the given oid
     */
    <T> T getModel(Class<T> model, String oid);

    /**
     * Loads the history (all saved versions) of the tool data from the given oid
     */
    <T> List<T> getModelHistory(Class<T> model, String oid);

    /**
     * Loads the history (all saved versions) of the tool data from the given oid for the given time range
     */
    <T> List<T> getModelHistoryForTimeRange(Class<T> model, String oid, Long from, Long to);

    /**
     * Queries for models which are fitting to the parameters given by the query request object.
     */
    <T> List<T> query(Class<T> model, QueryRequest request);

    /**
     * Queries for models which are fitting to the parameters given by the query string.
     */
    <T> List<T> queryByString(Class<T> model, String query);
    
    /**
     * Queries for models which are fitting to the parameters given by the query string and the given timestamp.
     */
    <T> List<T> queryByStringAndTimestamp(Class<T> model, String query, String timestamp);

    /**
     * Queries for active models of the given model type. Active models mean models which are in the newest version.
     */
    <T> List<T> queryForActiveModels(Class<T> model);

    /**
     * Parses the given query string and creates the fitting query request object for it. Throws an EKBException in case
     * the query is invalid.
     */
    QueryRequest parseQueryString(String query) throws EKBException;

    /**
     * Returns the most recent revision number of the EDB
     */
    UUID getCurrentRevisionNumber();
    
    /**
     * Returns the revision of the last commit performed in the EDB under the given contextId.
     */
    UUID getLastRevisionNumberOfContext(String contextId);

    /**
     * Returns a list of commit meta information of all commits which are matching the given request.
     */
    List<CommitMetaInfo> queryForCommits(CommitQueryRequest request) throws EKBException;

    /**
     * Loads the EKBCommit object with the given revision from the data source.
     */
    EKBCommit loadCommit(String revision) throws EKBException;
}