com.stratelia.webactiv.almanach.control
Class AlmanachDTO

java.lang.Object
  com.stratelia.webactiv.almanach.control.AlmanachDTO

public class AlmanachDTO
extends Object

A DTO on an almanach instance. It is used to transfer almanach instance data to the view page. By default, the almanach instance isn't an agregated one, so don't forget to set this option in the case the DTO is about an agregated almanach.

Constructor Summary

AlmanachDTO()

Method Summary

String	getColor() Gets the color with which the events of this almanach should be displayed in a calendar.
String	getInstanceId() Gets the unique identifier of the almanach instance.
String	getLabel() Gets the label of the almanach.
String	getSpaceId() Gets the identifier of the workspace into which the almanach is defined.
String	getUrl() Gets the URL of this almanach instance.
boolean	isAgregated() Is this almanach an agregated one?
AlmanachDTO	setAggregated(boolean isAggregated) Indicates whether this almanach is an aggregated one.
AlmanachDTO	setColor(String color) Sets the color with which the events of this almanach should be displayed in a calendar.
AlmanachDTO	setInstanceId(String instanceId) Sets the unique identifier of this almanach instance.
AlmanachDTO	setLabel(String label) Sets a label to this almanach.
AlmanachDTO	setSpaceId(String spaceId) Sets the workspace into which this almanach is defined.
AlmanachDTO	setUrl(String url) Sets the URL of the almanach instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlmanachDTO

public AlmanachDTO()

Method Detail

getColor

public String getColor()

Gets the color with which the events of this almanach should be displayed in a calendar.

Returns:

the color definition.

setColor

public AlmanachDTO setColor(String color)

Sets the color with which the events of this almanach should be displayed in a calendar.

Parameters:

color - the color of this almanach's events.

Returns:

the almanach DTO itself.

getInstanceId

public String getInstanceId()

Gets the unique identifier of the almanach instance.

Returns:

the almanach instance identifier.

setInstanceId

public AlmanachDTO setInstanceId(String instanceId)

Sets the unique identifier of this almanach instance.

Parameters:

instanceId - the almanach instance identifier.

Returns:

the almanach DTO itself.

getSpaceId

public String getSpaceId()

Gets the identifier of the workspace into which the almanach is defined.

Returns:

the workspace identifier.

setSpaceId

public AlmanachDTO setSpaceId(String spaceId)

Sets the workspace into which this almanach is defined.

Parameters:

spaceId - the identifier of the workspace.

Returns:

itself;

isAgregated

public boolean isAgregated()

Is this almanach an agregated one?

Returns:

true if this almanach is an agregated one, false otherwise.

setAggregated

public AlmanachDTO setAggregated(boolean isAggregated)

Indicates whether this almanach is an aggregated one.

Parameters:

isAggregated - true is this almanach an agregated one, false otherwise.

Returns:

the almanach DTO itself.

getLabel

public String getLabel()

Gets the label of the almanach.

Returns:

almanach label.

setLabel

public AlmanachDTO setLabel(String label)

Sets a label to this almanach.

Parameters:

label - the almanach label.

Returns:

the almanach DTO itself.

getUrl

public String getUrl()

Gets the URL of this almanach instance.

Returns:

the URL of the almanach instance.

setUrl

public AlmanachDTO setUrl(String url)

Sets the URL of the almanach instance.

Parameters:

url - the almanach instance URL.

Returns:

itself.