/* ======================================================================
   Parts Copyright 2006 University of Leeds, Oxford University, University of the Highlands and Islands.

   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 org.bodington.server;

import org.bodington.server.resources.Resource;

/**
 * Interface that should be implemented by classes wanting to contain quota 
 * information.
 * @author buckett
 */
public interface Quota
{
    /**
     * Get the quota that is allowed.
     * @return The quota limit.
     */
    public long getQuota();
    
    /**
     * Get the current quota usage.
     * @return The quota usage.
     */
    public long getUsage();
    
    /**
     * Return the resource that actually has the quota set.
     * @return The resource with the quota set.
     */
    public Resource getResource();


}
