org.apache.jetspeed.om.registry
Interface RegistryEntry

All Known Subinterfaces:
CachedParameter, ClientEntry, MediaTypeEntry, Parameter, PortletControlEntry, PortletControllerEntry, PortletEntry, PortletInfoEntry, SkinEntry
All Known Implementing Classes:
BaseCachedParameter, BaseClientEntry, BaseMediaTypeEntry, BaseParameter, BasePortletControlEntry, BasePortletControllerEntry, BasePortletEntry, BaseRegistryEntry, BaseSkinEntry

public interface RegistryEntry

RegistryEntry is the base interface that objects must implement in order to be used with the Registry service.

Version:
$Id: RegistryEntry.java,v 1.12 2005/03/21 18:21:37 sgala Exp $
Author:
RaphaŽl Luta, Kevin A. Burton

Method Summary
 java.lang.String getDescription()
           
 long getId()
           
 MetaInfo getMetaInfo()
           
 java.lang.String getName()
           
 Security getSecurity()
           
 SecurityReference getSecurityRef()
          Getter for property securityRef.
 java.lang.String getTitle()
           
 boolean isHidden()
          Test if this entry should be visible in a list of the registry contents
 void setDescription(java.lang.String description)
          Sets the description for the portlet entry
 void setHidden(boolean hidden)
          Modify the visibility status of this entry
 void setMetaInfo(MetaInfo metainfo)
          Set the metainfo properties for this entry
 void setName(java.lang.String name)
          Changes the name of this entry
 void setSecurity(Security security)
          Set the security properties for this entry
 void setSecurityRef(SecurityReference securityRef)
          Setter for property securityRef.
 void setTitle(java.lang.String title)
          Sets the title of the portlet entry
 

Method Detail

getId

public long getId()
Returns:
the id of this entry. This value should be unique within its registry class.

getName

public java.lang.String getName()
Returns:
the name of this entry. This value should be unique within its registry class.

setName

public void setName(java.lang.String name)
Changes the name of this entry

Parameters:
name - the new name for this entry

getTitle

public java.lang.String getTitle()
Returns:
the entry title in the default locale for this entry, if set

setTitle

public void setTitle(java.lang.String title)
Sets the title of the portlet entry

Parameters:
title - the new title for the entry

getDescription

public java.lang.String getDescription()
Returns:
the entry description in the default locale for this entry, if set

setDescription

public void setDescription(java.lang.String description)
Sets the description for the portlet entry

Parameters:
description - the new description for the entry

getSecurity

public Security getSecurity()
Returns:
the security properties for this entry

setSecurity

public void setSecurity(Security security)
Set the security properties for this entry

Parameters:
security - the new security properties

getMetaInfo

public MetaInfo getMetaInfo()
Returns:
the metainfo properties for this entry

setMetaInfo

public void setMetaInfo(MetaInfo metainfo)
Set the metainfo properties for this entry

Parameters:
metainfo - the new metainfo properties

isHidden

public boolean isHidden()
Test if this entry should be visible in a list of the registry contents

Returns:
true if the entry should be hidden

setHidden

public void setHidden(boolean hidden)
Modify the visibility status of this entry

Parameters:
hidden - the new status. If true, the entry will not be displayed in a registry list

getSecurityRef

public SecurityReference getSecurityRef()
Getter for property securityRef.

Returns:
Value of property securityRef.

setSecurityRef

public void setSecurityRef(SecurityReference securityRef)
Setter for property securityRef.

Parameters:
securityRef - New value of property securityRef.


Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.