/**
* Copyright (c) 2006-2011 Floggy Open Source Group. All rights reserved.
*
* 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 net.sourceforge.floggy.persistence;
/**
* An interface representing a search result. The
* <code>PolymorphicObjectSet</code> logically maintains a sequence of the
* object's IDs. It is possible to iterate over all objects (or a subset, if an
* optional object filter has been supplied) using the
* <code>get(int index)</code> method. <br>
* <br>
* <code>
* PersistableManager pm = PersistableManager.getInstance();<br>
* PolymorphicObjectSet os = manager.polymorphicFind(Customer.class, null, null);<br>
* for(int i = 0; i < os.size(); i++) {<br>
* Customer customer = (Customer) os.get(i);<br>
* ...<br>
* }
* </code><br>
* <br>
* By using an optional <code>Filter</code>, only the objects that matches
* the provided filter will be avaiable in this set.<br>
* <br>
* By using an optional <code>Comparator</code>, the order of the objects in
* this set will be determined by the comparator.
*
* @see PersistableManager#polymorphicFind(Class, Filter, boolean)
* @see Filter
* @see Comparator
*
* @since 1.4.0
* @author Thiago Moreira
*/
public interface PolymorphicObjectSet extends ObjectSet {
}