com.thesett.catalogue.model.PagingResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of catalogue-model Show documentation

A catalogue which is confugurable at the knowledge level to catalogue and organise any type of data and to provide structured access to it, free text querying of it and automatic data warehousing of events relating to it.

There is a newer version: 0.9.65

Show newest version

/*
 * Copyright The Sett Ltd, 2005 to 2014.
 *
 * 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.
 */
package com.thesett.catalogue.model;

import java.io.Serializable;
import java.util.List;

/**
 * PagingResult is used to encapsulate a list and a size as a single returnable object. It is intended to be used in
 * conjunction with paging of results of queries. {@link com.thesett.common.util.LazyPagingList} implementations of the
 * 'getBlock' method may call paging methods but these methods need to be able to tell the caller that the size of a
 * results set has changed since the last call as well as passing the actual page of results.
 *
 * 
 * CRC Card Responsibilities  Collaborations
 * 
 Encapsulate a list and a size.
 * 
 *
 * @author Rupert Smith
 */
public class PagingResult implements Serializable
{
    /** Holds the total size of the results set for all results. */
    public int size;

    /** Holds the list containing one page of results. */
    public List list;

    /**
     * Creates a return object encapsulating a size and a list.
     *
     * @param size The size.
     * @param list The list.
     */
    public PagingResult(int size, List list)
    {
        this.size = size;
        this.list = list;
    }
}