/*
 * 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.usergrid.persistence.collection;

import java.util.Collection;

import org.apache.usergrid.persistence.model.entity.Id;


/**
 * Represents a set of entities
 */
public interface EntitySet {

    /**
     * Get the entity from the result set
     * @param entityId
     * @return
     */
    MvccEntity getEntity( Id entityId );

    /**
     * Get all entities in the set
     * @return
     */
    Collection<MvccEntity> getEntities();

    /**
     * Get the number of entities in this set
     * @return
     */
    int size();

    /**
     * Return true if the set is empty
     * @return
     */
    boolean isEmpty();
}