org.figure8.join.businessobjects.reporting
Class Event

java.lang.Object
  org.figure8.join.core.EntityObject
      org.figure8.join.businessobjects.reporting.Event

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Event
extends EntityObject

This is an entity object that helps defining events into Join workflow. An event is thrown at defined moments of the process, it can be used to create information messages using the templating facilities it provides.

Version:

$Revision: 1.2 $

Author:

Laurent Broudoux

See Also:

Serialized Form

Field Summary

static java.lang.String	ASSEMBLY_EVENT_KEY Constant denoting the key of built-in assembly creationg event
static java.lang.String	BUILD_EVENT_KEY Constant denoting the key of built-in build creation event
static java.lang.String	DELIVERY_EVENT_KEY Constant denoting the key of built-in delivery creation event
static java.lang.String	DEPLOYMENT_DEMAND_KEY Constant denoting the key of built-in deployment demand event
static java.lang.String	DEPLOYMENT_END_KEY Constant denoting the key of built-il deployment end event
static java.lang.String	DEPLOYMENT_PREPARATION_KEY Constant denoting the key of built-in deployment preparation event
static java.lang.String	DEPLOYMENT_REALIZATION_KEY Constant denoting the key of built-in deployment realization event

Constructor Summary

Event()
Creates a new instance of Event

Event(java.lang.String key, java.lang.String label)
Creates a new instance of Event with mandatory attributes

Method Summary

java.lang.String	getKey()
java.lang.String	getLabel()
java.lang.String	getMsgContentTemplate()
java.lang.String	getMsgLinkTemplate()
java.lang.String	getMsgTitleTemplate()
PermissionResourceResolver	getResourceResolver() Get the ResourceResolver asssociated to this event (if any).
java.lang.String	getResourceResolverClass()
protected void	instantiateResourceResolver() Try to instantiate the PermissionResourceResolver associated with this role (if any ...)
void	setKey(java.lang.String key)
void	setLabel(java.lang.String label)
void	setMsgContentTemplate(java.lang.String msgContentTemplate)
void	setMsgLinkTemplate(java.lang.String msgLinkTemplate)
void	setMsgTitleTemplate(java.lang.String msgTitleTemplate)
void	setResourceResolverClass(java.lang.String resourceResolverClass) Give a resource resolver to this event. ie : an helper object that allows to retrieve resources to whom should apply event publication.

Methods inherited from class org.figure8.join.core.EntityObject

clone, equals, getId, hashCode, isTransient

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

DELIVERY_EVENT_KEY

public static final java.lang.String DELIVERY_EVENT_KEY

Constant denoting the key of built-in delivery creation event

See Also:

Constant Field Values

BUILD_EVENT_KEY

public static final java.lang.String BUILD_EVENT_KEY

Constant denoting the key of built-in build creation event

See Also:

Constant Field Values

ASSEMBLY_EVENT_KEY

public static final java.lang.String ASSEMBLY_EVENT_KEY

Constant denoting the key of built-in assembly creationg event

See Also:

Constant Field Values

DEPLOYMENT_DEMAND_KEY

public static final java.lang.String DEPLOYMENT_DEMAND_KEY

Constant denoting the key of built-in deployment demand event

See Also:

Constant Field Values

DEPLOYMENT_PREPARATION_KEY

public static final java.lang.String DEPLOYMENT_PREPARATION_KEY

Constant denoting the key of built-in deployment preparation event

See Also:

Constant Field Values

DEPLOYMENT_REALIZATION_KEY

public static final java.lang.String DEPLOYMENT_REALIZATION_KEY

Constant denoting the key of built-in deployment realization event

See Also:

Constant Field Values

DEPLOYMENT_END_KEY

public static final java.lang.String DEPLOYMENT_END_KEY

Constant denoting the key of built-il deployment end event

See Also:

Constant Field Values

Constructor Detail

Event

public Event()

Creates a new instance of Event

Event

public Event(java.lang.String key,
             java.lang.String label)

Creates a new instance of Event with mandatory attributes

Parameters:

key - The unique of this event

label - The label to display for this event

Method Detail

getKey

public java.lang.String getKey()

Returns:

The unique key for this event

setKey

public void setKey(java.lang.String key)

Parameters:

key - The unique key for this event

getLabel

public java.lang.String getLabel()

Returns:

The label to display for this event

setLabel

public void setLabel(java.lang.String label)

Parameters:

label - The label to display for this event

getMsgTitleTemplate

public java.lang.String getMsgTitleTemplate()

Returns:

A string representing template for generating messages title

setMsgTitleTemplate

public void setMsgTitleTemplate(java.lang.String msgTitleTemplate)

Parameters:

msgTitleTemplate - String representing template for title generation

getMsgContentTemplate

public java.lang.String getMsgContentTemplate()

Returns:

A string representing template for generating messages content

setMsgContentTemplate

public void setMsgContentTemplate(java.lang.String msgContentTemplate)

Parameters:

msgContentTemplate - String representing template for generating messages content

getMsgLinkTemplate

public java.lang.String getMsgLinkTemplate()

Returns:

A string representing template for generating messages link

setMsgLinkTemplate

public void setMsgLinkTemplate(java.lang.String msgLinkTemplate)

Parameters:

msgLinkTemplate - String representing template for generating messages link

getResourceResolverClass

public java.lang.String getResourceResolverClass()

Returns:

The FQN of the Java class used for managing permissions within this role

setResourceResolverClass

public void setResourceResolverClass(java.lang.String resourceResolverClass)
                              throws InvalidParameterException

Give a resource resolver to this event. ie : an helper object that allows to retrieve resources to whom should apply event publication. This parameter must be the name of a Java class that implements org.figure8.join.services.security.PermissionResourceResolver

Parameters:

resourceResolverClass - FQN of Java class

Throws:

InvalidParameterException - if the permissionResourceResolverClass is not valid

getResourceResolver

public PermissionResourceResolver getResourceResolver()
                                               throws InvalidParameterException

Get the ResourceResolver asssociated to this event (if any).

Returns:

The resolver instance or null if no resolver is associated to this role

Throws:

InvalidParameterException - if the permissionResourceResolverClass inner field is not valid

instantiateResourceResolver

protected void instantiateResourceResolver()
                                    throws InvalidParameterException

Try to instantiate the PermissionResourceResolver associated with this role (if any ...)

Throws:

InvalidParameterException - if the permissionResourceResolverClass inner field is not valid