org.apache.cocoon.portal.coplet
Class CopletData

java.lang.Object
  extended byorg.apache.cocoon.portal.coplet.CopletData

public class CopletData
extends Object

A coplet data describes an available coplet. A coplet data can be seen as a class. A user can create one or more instances of the coplet (CopletInstanceDatas).

Version:
$Id: CopletData.java 328453 2005-10-25 19:08:53Z cziegeler $

Field Summary
protected  String allowedRoles
           
protected  List allowedRolesList
           
protected  Map attributes
           
protected  CopletBaseData copletBaseData
           
protected  String id
          The unique identifier.
protected  String title
           
 
Constructor Summary
CopletData()
          Constructor
CopletData(String id)
           
 
Method Summary
 void addToAllowedRoles(String role)
           
protected  void buildRolesString(List fromList)
           
 String getAllowedRoles()
           
 List getAllowedRolesList()
          Return the list of roles that are allowed to access this coplet
 Object getAttribute(String key)
           
 Map getAttributes()
           
 CopletBaseData getCopletBaseData()
          Returns the copletBaseData.
 String getId()
          Return the unique identifier of this object.
 String getTitle()
          Returns the title.
 Object removeAttribute(String key)
           
 void removeFromAllowedRoles(String role)
           
 void setAllowedRoles(String roles)
           
 void setAttribute(String key, Object value)
           
 void setCopletBaseData(CopletBaseData copletBaseData)
          Sets the copletBaseData.
 void setTitle(String title)
          Sets the title.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

id

protected final String id
The unique identifier.


title

protected String title

copletBaseData

protected CopletBaseData copletBaseData

attributes

protected Map attributes

allowedRoles

protected String allowedRoles

allowedRolesList

protected transient List allowedRolesList
Constructor Detail

CopletData

public CopletData()
Constructor


CopletData

public CopletData(String id)
Method Detail

getId

public String getId()
Return the unique identifier of this object.

Returns:
The unique identifier.

getTitle

public String getTitle()
Returns the title.

Returns:
String

setTitle

public void setTitle(String title)
Sets the title.

Parameters:
title - The title to set

getCopletBaseData

public CopletBaseData getCopletBaseData()
Returns the copletBaseData.

Returns:
CopletBaseData

setCopletBaseData

public void setCopletBaseData(CopletBaseData copletBaseData)
Sets the copletBaseData.

Parameters:
copletBaseData - The copletBaseData to set

removeAttribute

public Object removeAttribute(String key)

getAttribute

public Object getAttribute(String key)

setAttribute

public void setAttribute(String key,
                         Object value)

getAttributes

public Map getAttributes()

getAllowedRoles

public String getAllowedRoles()
Returns:
Returns the allowed roles.

setAllowedRoles

public void setAllowedRoles(String roles)
Parameters:
roles - The allowed roles to set.

getAllowedRolesList

public List getAllowedRolesList()
Return the list of roles that are allowed to access this coplet

Returns:
A list of roles or null if everyone is allowed.

addToAllowedRoles

public void addToAllowedRoles(String role)

removeFromAllowedRoles

public void removeFromAllowedRoles(String role)

buildRolesString

protected void buildRolesString(List fromList)

toString

public String toString()
See Also:
Object.toString()


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.