MarkupRequest.java

/*
 * Copyright 2003-2005 The Apache Software Foundation.
 * 
 * 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.apache.wsrp4j.commons.consumer.interfaces.request;

import oasis.names.tc.wsrp.v1.types.MarkupContext;

/**
 * This is the abstraction for a render request at a integrated
 * remote portlet at the consumer side.
 * 
 * @version $Id: MarkupRequest.java 374672 2006-02-03 14:10:58Z cziegeler $
 */
public interface MarkupRequest extends WSRPBaseRequest {

    /**
     * Get the markup context if there is cached markup for this portlet 
     * instance or null in case of an empty markup cache.
     * 
     * @return The cached markup context
     **/
    MarkupContext getCachedMarkup();
}