View Javadoc

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  // Jetspeed imports
20  import org.apache.jetspeed.om.SecurityReference;
21  
22  
23  /***
24   * An Entry is a representation of a Portlet within a configuration
25   * Document.
26   * An Entry is always associated to a parent Registry entry as well as
27   * some layout constraints and local parameters if required.
28   * 
29   * @author <a href="mailto:raphael@apache.org">RaphaŽl Luta</a>
30   * @version $Id: Entry.java,v 1.4 2004/02/23 03:05:01 jford Exp $
31   */
32  public interface Entry extends IdentityElement
33  {
34  
35      /*** @return the entry name from which this one is derived */
36      public String getParent();
37                                  
38      /***
39       * Sets the ancestor for this Entry.
40       * @param parent the new ancestor entry name. This name should
41       * be defined in the Registry
42       */
43      public void setParent( String parent );
44          
45      /*** Getter for property securityRef.
46       * @return Value of property securityRef.
47       */
48      public SecurityReference getSecurityRef();
49      
50      /*** Setter for property securityRef.
51       * @param securityRef New value of property securityRef.
52       */
53      public void setSecurityRef(SecurityReference securityRef);
54      
55  }