/*
* #%L
* carewebframework
* %%
* Copyright (C) 2008 - 2016 Regenstrief Institute, Inc.
* %%
* Licensed 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.
*
* This Source Code Form is also subject to the terms of the Health-Related
* Additional Disclaimer of Warranty and Limitation of Liability available at
*
* http://www.carewebframework.org/licensing/disclaimer.
*
* #L%
*/
package org.carewebframework.api.query;
import java.util.List;
/**
* Results and metadata returned by an IDataService implementation.
*
* @param <T> Class of query result.
*/
public interface IQueryResult<T> {
enum CompletionStatus {
COMPLETED, ABORTED, ERROR
};
/**
* Returns the completion status of the query.
*
* @return The completion status.
*/
CompletionStatus getStatus();
/**
* Returns the list of results produced by a query.
*
* @return Results produced by a query.
*/
List<T> getResults();
/**
* Provides access to metadata produced by a query.
*
* @param key Key of metadata element.
* @return Request metadata element, or null if not found.
*/
Object getMetadata(String key);
}