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 at7 * 8 * http://www.apache.org/licenses/LICENSE-2.09 * 10 * Unless required by applicable law or agreed to in writing, software11 * 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 and14 * limitations under the License.15 */1617packageorg.apache.jetspeed.om.registry;
1819// Jetspeed imports20import org.apache.jetspeed.om.SecurityReference;
2122/***23 * RegistryEntry is the base interface that objects must implement in order24 * 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 */30publicinterfaceRegistryEntry31 {
32/***33 * @return the id of this entry. This value should be unique within its34 * registry class.35 */36publiclong getId();
3738/***39 * @return the name of this entry. This value should be unique within its40 * registry class.41 */42public String getName();
4344/***45 * Changes the name of this entry46 * @param name the new name for this entry47 */48publicvoid setName(String name);
4950/***51 * @return the entry title in the default locale for this entry, if set52 */53public String getTitle();
5455/***56 * Sets the title of the portlet entry57 * @param title the new title for the entry58 */59publicvoid setTitle(String title);
6061/***62 * @return the entry description in the default locale for this entry, if set63 */64public String getDescription();
6566/***67 * Sets the description for the portlet entry68 * @param description the new description for the entry69 */70publicvoid setDescription(String description);
7172/***73 * @return the security properties for this entry74 */75publicSecurity getSecurity();
7677/***78 * Set the security properties for this entry79 * @param security the new security properties80 */81publicvoid setSecurity(Security security);
8283/***84 * @return the metainfo properties for this entry85 */86publicMetaInfo getMetaInfo();
8788/***89 * Set the metainfo properties for this entry90 * @param metainfo the new metainfo properties91 */92publicvoid setMetaInfo(MetaInfo metainfo);
939495/***96 * Test if this entry should be visible in a list of the registry contents97 * @return true if the entry should be hidden98 */99publicboolean isHidden();
100101/*** Modify the visibility status of this entry102 * @param hidden the new status. If true, the entry will not be displayed in103 * a registry list104 */105publicvoid setHidden(boolean hidden);
106107/*** Getter for property securityRef.108 * @return Value of property securityRef.109 */110publicSecurityReference getSecurityRef();
111112/*** Setter for property securityRef.113 * @param securityRef New value of property securityRef.114 */115publicvoid setSecurityRef(SecurityReference securityRef);
116117 }