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.registry;
18  
19  // Jetspeed imports
20  import org.apache.jetspeed.om.SecurityReference;
21  
22  /***
23   * RegistryEntry is the base interface that objects must implement in order
24   * to be used with the Registry service.
25   *
26   * @author <a href="mailto:raphael@apache.org">RaphaŽl Luta</a>
27   * @author <a href="mailto:burton@apache.org">Kevin A. Burton</a>
28   * @version $Id: RegistryEntry.java,v 1.11 2004/02/23 03:11:39 jford Exp $
29   */
30  public interface RegistryEntry
31  {
32      /***
33       * @return the id of this entry. This value should be unique within its
34       * registry class.
35       */
36      public long getId();
37  
38      /***
39       * @return the name of this entry. This value should be unique within its
40       * registry class.
41       */
42      public String getName();
43  
44      /***
45       * Changes the name of this entry
46       * @param name the new name for this entry
47       */
48      public void setName(String name);
49  
50      /***
51       * @return the entry title in the default locale for this entry, if set
52       */
53      public String getTitle();
54  
55      /***
56       * Sets the title of the portlet entry
57       * @param title the new title for the entry
58       */
59      public void setTitle(String title);
60  
61      /***
62       * @return the entry description in the default locale for this entry, if set
63       */
64      public String getDescription();
65  
66      /***
67       * Sets the description for the portlet entry
68       * @param description the new description for the entry
69       */
70      public void setDescription(String description);
71  
72      /***
73       * @return the security properties for this entry
74       */
75      public Security getSecurity();
76  
77      /***
78       * Set the security properties for this entry
79       * @param security the new security properties
80       */
81      public void setSecurity(Security security);
82  
83      /***
84       * @return the metainfo properties for this entry
85       */
86      public MetaInfo getMetaInfo();
87  
88      /***
89       * Set the metainfo properties for this entry
90       * @param metainfo the new metainfo properties
91       */
92      public void setMetaInfo(MetaInfo metainfo);
93  
94  
95      /***
96       * Test if this entry should be visible in a list of the registry contents
97       * @return true if the entry should be hidden
98       */
99      public boolean isHidden();
100 
101     /*** Modify the visibility status of this entry
102      * @param hidden the new status. If true, the entry will not be displayed in
103      * a registry list
104      */
105     public void setHidden(boolean hidden);
106 
107     /*** Getter for property securityRef.
108      * @return Value of property securityRef.
109      */
110     public SecurityReference getSecurityRef();
111 
112     /*** Setter for property securityRef.
113      * @param securityRef New value of property securityRef.
114      */
115     public void setSecurityRef(SecurityReference securityRef);
116 
117 }