org.apache.jetspeed.om.registry.base
Class BaseRegistryEntry

java.lang.Object
  extended byorg.apache.jetspeed.om.registry.base.BaseRegistryEntry
All Implemented Interfaces:
RegistryEntry, java.io.Serializable
Direct Known Subclasses:
BaseClientEntry, BaseMediaTypeEntry, BaseParameter, BasePortletInfoEntry, BaseSecurityEntry, BaseSkinEntry

public class BaseRegistryEntry
extends java.lang.Object
implements RegistryEntry, java.io.Serializable

Base simple bean-like implementation of the RegistryEntry interface suitable for Castor XML serialization.

Version:
$Id: BaseRegistryEntry.java,v 1.11 2005/03/21 18:21:37 sgala Exp $
Author:
RaphaŽl Luta
See Also:
Serialized Form

Field Summary
protected  int _hidden
           
protected  boolean hidden
           
protected  long id
           
protected  MetaInfo metaInfo
           
protected  java.lang.String name
           
protected  Security security
           
protected  SecurityReference securityRef
          Holds value of property securityRef.
 
Constructor Summary
BaseRegistryEntry()
           
BaseRegistryEntry(long id, java.lang.String name, int _hidden, java.lang.String title, java.lang.String description, java.lang.String image, java.lang.String role)
           
 
Method Summary
 boolean equals(java.lang.Object entry)
          Implements the equals operation so that 2 elements are equal if all their member values are equal.
 BaseMetaInfo getBaseMetaInfo()
          Required by Castor 0.8.11 XML serialization for retrieving the metainfo
 BaseSecurity getBaseSecurity()
          Required by Castor 0.8.11 XML serialization for retrieving the security object
 java.lang.String getDescription()
           
 boolean getHidden()
          Required by Castor 0.8.11 XML serialization for retrieving the visibility status
 long getId()
           
 MetaInfo getMetaInfo()
           
 java.lang.String getName()
           
 Security getSecurity()
           
 SecurityReference getSecurityRef()
          Getter for property securityId.
 java.lang.String getTitle()
           
 boolean isHidden()
          Test if this entry should be visible in a list of the registry contents
 void setBaseMetaInfo(BaseMetaInfo metaInfo)
          Required by Castor 0.8.11 XML serialization for setting the entry metainfo
 void setBaseSecurity(BaseSecurity security)
          Required by Castor 0.8.11 XML serialization for setting the security status
 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)
          Required by Castor 0.8.11 XML serialization for setting the entry metainfo
 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 securityId.
 void setTitle(java.lang.String title)
          Sets the title of the portlet entry
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

id

protected long id

name

protected java.lang.String name

metaInfo

protected MetaInfo metaInfo

security

protected Security security

hidden

protected boolean hidden

_hidden

protected int _hidden

securityRef

protected SecurityReference securityRef
Holds value of property securityRef.

Constructor Detail

BaseRegistryEntry

public BaseRegistryEntry()

BaseRegistryEntry

public BaseRegistryEntry(long id,
                         java.lang.String name,
                         int _hidden,
                         java.lang.String title,
                         java.lang.String description,
                         java.lang.String image,
                         java.lang.String role)
Method Detail

equals

public boolean equals(java.lang.Object entry)
Implements the equals operation so that 2 elements are equal if all their member values are equal.


getId

public long getId()
Specified by:
getId in interface RegistryEntry
Returns:
the id of this entry. This value should be unique within its registry class.
See Also:
RegistryEntry.getName()

getName

public java.lang.String getName()
Specified by:
getName in interface RegistryEntry
Returns:
the name of this entry. This value should be unique within its registry class.
See Also:
RegistryEntry.getName()

setName

public void setName(java.lang.String name)
Description copied from interface: RegistryEntry
Changes the name of this entry

Specified by:
setName in interface RegistryEntry
Parameters:
name - the new name for this entry
See Also:
RegistryEntry.setName(java.lang.String)

getTitle

public java.lang.String getTitle()
Specified by:
getTitle in interface RegistryEntry
Returns:
the entry title in the default locale for this entry, if set
See Also:
RegistryEntry.getTitle()

setTitle

public void setTitle(java.lang.String title)
Description copied from interface: RegistryEntry
Sets the title of the portlet entry

Specified by:
setTitle in interface RegistryEntry
Parameters:
title - the new title for the entry
See Also:
RegistryEntry.setTitle(java.lang.String)

getDescription

public java.lang.String getDescription()
Specified by:
getDescription in interface RegistryEntry
Returns:
the entry description in the default locale for this entry, if set
See Also:
RegistryEntry.getDescription()

setDescription

public void setDescription(java.lang.String description)
Description copied from interface: RegistryEntry
Sets the description for the portlet entry

Specified by:
setDescription in interface RegistryEntry
Parameters:
description - the new description for the entry
See Also:
RegistryEntry.setDescription(java.lang.String)

getSecurity

public Security getSecurity()
Specified by:
getSecurity in interface RegistryEntry
Returns:
the security properties for this entry
See Also:
RegistryEntry.getSecurity()

setSecurity

public void setSecurity(Security security)
Description copied from interface: RegistryEntry
Set the security properties for this entry

Specified by:
setSecurity in interface RegistryEntry
Parameters:
security - the new security properties
See Also:
RegistryEntry.setSecurity(org.apache.jetspeed.om.registry.Security)

isHidden

public boolean isHidden()
Description copied from interface: RegistryEntry
Test if this entry should be visible in a list of the registry contents

Specified by:
isHidden in interface RegistryEntry
Returns:
true if the entry should be hidden
See Also:
RegistryEntry.isHidden()

setHidden

public void setHidden(boolean hidden)
Description copied from interface: RegistryEntry
Modify the visibility status of this entry

Specified by:
setHidden in interface RegistryEntry
Parameters:
hidden - the new status. If true, the entry will not be displayed in a registry list
See Also:
RegistryEntry.setHidden(boolean)

getHidden

public boolean getHidden()
Required by Castor 0.8.11 XML serialization for retrieving the visibility status


getBaseSecurity

public BaseSecurity getBaseSecurity()
Required by Castor 0.8.11 XML serialization for retrieving the security object


setBaseSecurity

public void setBaseSecurity(BaseSecurity security)
Required by Castor 0.8.11 XML serialization for setting the security status


getMetaInfo

public MetaInfo getMetaInfo()
Specified by:
getMetaInfo in interface RegistryEntry
Returns:
the metainfo properties for this entry

setMetaInfo

public void setMetaInfo(MetaInfo metaInfo)
Required by Castor 0.8.11 XML serialization for setting the entry metainfo

Specified by:
setMetaInfo in interface RegistryEntry
Parameters:
metaInfo - the new metainfo properties

getBaseMetaInfo

public BaseMetaInfo getBaseMetaInfo()
Required by Castor 0.8.11 XML serialization for retrieving the metainfo


setBaseMetaInfo

public void setBaseMetaInfo(BaseMetaInfo metaInfo)
Required by Castor 0.8.11 XML serialization for setting the entry metainfo


getSecurityRef

public SecurityReference getSecurityRef()
Getter for property securityId.

Specified by:
getSecurityRef in interface RegistryEntry
Returns:
Value of property securityId.

setSecurityRef

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

Specified by:
setSecurityRef in interface RegistryEntry
Parameters:
securityRef - New value of property securityRef.


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