KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > jetspeed > om > profile > Portlets


1 /*
2  * Copyright 2000-2001,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 package org.apache.jetspeed.om.profile;
18
19 // Java imports
20 import java.util.Iterator JavaDoc;
21
22 // Jetspeed imports
23 import org.apache.jetspeed.om.SecurityReference;
24
25 /**
26  * Portlets is collection of portlet entries and other portlet sets
27  * within a configuration Document.
28  *
29  * @author <a HREF="mailto:taylor@apache.org">David Sean Taylor</a>
30  * @version $Id: Portlets.java,v 1.7 2004/02/23 03:05:01 jford Exp $
31  */
32 public interface Portlets extends IdentityElement
33 {
34     public Controller getController();
35
36     public void setController(Controller controller);
37     
38     public void setSecurity(Security security);
39  
40     public Security getSecurity();
41
42     public int getEntryCount();
43
44     public int getPortletsCount();
45
46     public int getReferenceCount();
47
48     public Portlets getPortlets(int index)
49         throws java.lang.IndexOutOfBoundsException JavaDoc;
50
51     public Entry getEntry(int index)
52         throws java.lang.IndexOutOfBoundsException JavaDoc;
53
54     public Reference getReference(int index)
55         throws java.lang.IndexOutOfBoundsException JavaDoc;
56
57     public Entry removeEntry(int index);
58
59     public Portlets removePortlets(int index);
60
61     public Reference removeReference(int index);
62
63     public Iterator JavaDoc getEntriesIterator();
64   
65     public Iterator JavaDoc getPortletsIterator();
66
67     public Iterator JavaDoc getReferenceIterator();
68
69     public void addEntry(Entry entry)
70         throws java.lang.IndexOutOfBoundsException JavaDoc;
71
72     public void addPortlets(Portlets portlets)
73         throws java.lang.IndexOutOfBoundsException JavaDoc;
74
75     public void addReference(Reference ref)
76         throws java.lang.IndexOutOfBoundsException JavaDoc;
77
78     public Entry[] getEntriesArray();
79
80     public Portlets[] getPortletsArray();
81
82     public Reference[] getReferenceArray();
83
84     /** Getter for property securityRef.
85      * @return Value of property securityRef.
86      */
87     public SecurityReference getSecurityRef();
88   
89     /** Setter for property securityRef.
90      * @param securityRef New value of property securityRef.
91      */
92     public void setSecurityRef(SecurityReference securityRef);
93
94     
95     /**
96      * @return Portlets parent <code>Portlets</code> object for this Portlets collection
97      * <code>null</code> if it is the root.
98      */
99     public Portlets getParentPortlets();
100     
101     /**
102      * @param Portlets Sets the parent <code>Portlets</code> collection for this Portlets collection
103      *
104      */
105     public void setParentPortlets(Portlets parent);
106 }
Popular Tags