org.exoplatform.portal.mop

Class Described

java.lang.Object

org.exoplatform.portal.mop.Described

Direct Known Subclasses:

Described_Chromattic

public abstract class Described
extends Object

Something having a human readable name and a description. The semantic of the name is to be human readable, it can be expressed under various ways : name, display name, label, title, etc...

Version:

$Revision$

Author:

Julien Viet

Constructor Summary

Constructors

Constructor and Description
Described()

Method Summary

Modifier and Type	Method and Description
abstract String	getDescription() Returns the description.
abstract String	getName() Returns the namet.
org.exoplatform.portal.mop.State	getState() Return the state.
abstract void	setDescription(String description) Update the description.
abstract void	setName(String name) Update the name.
void	setState(org.exoplatform.portal.mop.State state) Update the state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Described

public Described()

Method Detail

getName

public abstract String getName()

Returns the namet.

Returns:

the name

setName

public abstract void setName(String name)

Update the name.

Parameters:

name - the new name

getDescription

public abstract String getDescription()

Returns the description.

Returns:

the description

setDescription

public abstract void setDescription(String description)

Update the description.

Parameters:

description - the new description

getState

public org.exoplatform.portal.mop.State getState()

Return the state.

Returns:

the state

setState

public void setState(org.exoplatform.portal.mop.State state)
              throws NullPointerException

Update the state.

Parameters:

state - the new state

Throws:

NullPointerException - if the new state is null