PersistenceQuery.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF 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.apache.isis.core.runtime.system.persistence;

import org.apache.isis.applib.query.Query;
import org.apache.isis.core.metamodel.spec.ObjectSpecification;

/**
 * Defines a criteria for including instances in set, corresponds to
 * {@link Query} in the applib.
 */
public interface PersistenceQuery {

    /**
     * The type of instances in the resulting set.
     */
    ObjectSpecification getSpecification();
    
    /**
     * The index of the first record to return, 0 means the first.
     * @return
     */
    public long getStart() ;
    /**
     * The number of records to return, 0 means all.
     * @return
     */
    public long getCount() ;
}