Cacheable.java

/***
 * Copyright (c) 2009 Caelum - www.caelum.com.br/opensource 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 br.com.caelum.vraptor.restfulie.resource;


/**
 * An interface that defines caching characteristics for a resource.<br/>
 * Annotations where avoided in order to provide programmatic support to
 * customization in a resource-by-resource instance basis, not at class level.
 *
 * @author guilherme silveira
 */
public interface Cacheable {

	/**
	 * Returns the maximum number of seconds this resource can be cached for.
	 *
	 * @return
	 */
	int getMaximumAge();

}