Package lumis.portal.activitystream

Class ActivityAction

java.lang.Object

lumis.portal.activitystream.ActivityAction

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

EmailNotifierVariableResolver.ActionDecorator

@StableMinor(version="17.0",
             sinceVersion="8.2")
public class ActivityAction
extends java.lang.Object
implements java.io.Serializable

The action performed during an Activity.

Since:

8.2.0

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ActivityAction()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDisplayName()	Returns the display name of this action.
java.lang.String	getId()	Returns the identifier of this action.
java.lang.String	getLocalizedDisplayName(java.util.Locale locale)	Returns the localized display name of this action.
IResource	getStringResource()	Returns the string resource used to localize this action's strings.
void	setDisplayName(java.lang.String displayName)	Sets the display name of this action.
void	setId(java.lang.String id)	Sets the identifier of this action.
void	setStringResource(IResource stringResource)	Sets the string localization resource paths for this action based on a string localization resource object.
void	setStringResourcePath(java.lang.String stringResourcePath)	Sets the string localization resource path for this action.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivityAction

public ActivityAction()

Method Detail

getId

public java.lang.String getId()

Returns the identifier of this action.

Returns:

the identifier of this action.

Since:

8.2.0

setId

public void setId(java.lang.String id)

Sets the identifier of this action.

Parameters:

id - the identifier.

Since:

8.2.0

getStringResource

public IResource getStringResource()

Returns the string resource used to localize this action's strings.

Returns:

the string localization resource.

Since:

8.2.0

setStringResource

public void setStringResource(IResource stringResource)

Sets the string localization resource paths for this action based on a string localization resource object.

Parameters:

stringResource - the string localization resource object.

Since:

8.2.0

See Also:

setStringResourcePath(String)

setStringResourcePath

public void setStringResourcePath(java.lang.String stringResourcePath)

Sets the string localization resource path for this action.

Parameters:

stringResourcePath - the string localization resource path.

Since:

8.2.0

See Also:

setStringResource(IResource)

getDisplayName

public java.lang.String getDisplayName()

Returns the display name of this action.

Returns:

a plain-text value, possibly a localizable string key.

Since:

8.2.0

See Also:

#getStringResourcePaths()

setDisplayName

public void setDisplayName(java.lang.String displayName)

Sets the display name of this action.

Parameters:

displayName - the plain-text display name value, possibly a localizable string key.

Since:

8.2.0

See Also:

getStringResource()

getLocalizedDisplayName

public java.lang.String getLocalizedDisplayName(java.util.Locale locale)
                                         throws PortalException

Returns the localized display name of this action.

Parameters:

locale - the locale to use to localize the display name.

Returns:

the plain-text display name value.

Throws:

PortalException - if there was a problem while applying the localization on the value.

Since:

8.2.0

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object