CachedPortletResultHolder.java

/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * 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 the
 * following location:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>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.apereo.portal.portlet.container.cache;

import java.io.Serializable;

/**
 * Defines a cached portlet results
 *
 * @param <T>
 */
public interface CachedPortletResultHolder<T extends Serializable> {
    /** @return The portlet result */
    T getPortletResult();

    /** @return The time-since-epoch timestamp when the cached data will expire */
    long getExpirationTime();

    /** @return The ETag if set by the portlet */
    String getEtag();

    /** @return The time the result was cached */
    long getTimeStored();
}