View Javadoc

1   /*
2    * Copyright 2003,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  /* 
17  
18   */
19  
20  package org.apache.pluto.om.portlet;
21  
22  /***
23   * <P>
24   * This interface provides access to a content type and its supported
25   * portlet modes.
26   * A content type is defined as part of a portlet application in the
27   * portlet.xml. It is accessible via the ServletDefinition as it is
28   * bound to the application code.<br>
29   * </P>
30   * <P>
31   * This interface defines the model as known from the MVC pattern.
32   * Its purpose is to provide read access to the data stored in the model.
33   * </P>
34   * 
35   */
36  public interface ContentType extends org.apache.pluto.om.Model
37  {
38  
39      /***
40       * Returns the content type
41       * The return value cannot be NULL.
42       * 
43       * @return the content type
44       */
45      public String getContentType();
46  
47      /***
48       * Returns all portlet modes for this content type
49       * 
50       * @return an iterator over <CODE>javax.portlet.PortletMode</CODE> objects
51       */
52      public java.util.Iterator getPortletModes();
53  
54  	/***
55  	 * Returns true if the given portlet mode is supported for this content type.
56  	 * @return boolean
57  	 */
58  	public boolean supportsPortletMode(javax.portlet.PortletMode portletMode);
59  }