org.greencheek.related.searching.requestprocessing.SearchResponseContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of related-searching Show documentation

The newest version!

/*
 *
 *  * Licensed to Relateit under one or more contributor
 *  * license agreements. See the NOTICE file distributed with
 *  * this work for additional information regarding copyright
 *  * ownership. Relateit 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.greencheek.related.searching.requestprocessing;

/**
 * Represents the class through which we can send results to the
 * user that submitted the search request.
 */
public interface SearchResponseContext {

    /**
     * The type of response context that
     * we are sending results to.
     * @return
     */
    Class getContextType();

    /**
     * The context, to which we will be sending results.
     * @return
     */
    T getSearchResponseContext();

    /**
     * close, in whatever way, appropriate for the held context object.
     */
    public void close();

    /**
     * creation nano timestamp; used for timing the time is takes to complete
     * requests.
     *
     * If the creation time is not supported, then return -1
     */
    public long getCreationTime();
}