com.jalios.jcms
Class ControllerStatus

java.lang.Object
  com.jalios.jcms.ControllerStatus

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class ControllerStatus
extends Object
implements JcmsConstants

This class represents the status returned by a DataController.

Version:

$Revision: 13770 $

Author:

Olivier Dedieu

Field Summary

static ControllerStatus	FORBIDDEN This status represents a forbidden operation
static ControllerStatus	OK This status represents a sucessfull operation
static String	REVISION

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CRYPT_MD5, CRYPT_UNDEFINED, CRYPT_UNIX, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

ControllerStatus()
Constructs a new ControllerStatus

ControllerStatus(int topic)
Constructs a new ControllerStatus with the given topic

ControllerStatus(String msg)
Constructs a new ControllerStatus with the given message

Method Summary

void	addNestedStatus(ControllerStatus status) Add a ControllerStatus to the list of nested status.
String	getMessage(String userLang) Returns the status message.
ArrayList	getNestedStatusList()
String	getProp()
int	getTopic()
boolean	hasFailed() Returns whether or not the operation has failed
boolean	isForbidden() Returns whether or not the operation is forbidden
boolean	isOK() Returns whether or not the operation was OK (equal to not hasFailed())
void	setMessage(String msg) Sets the status message.
void	setProp(String prop) Sets the property used for status message
void	setProp(String prop, Object p1) Sets the property
void	setProp(String prop, Object[] propParam) Sets the property
void	setProp(String prop, Object p1, Object p2) Sets the property
void	setProp(String prop, Object p1, Object p2, Object p3) Sets the property
void	setTopic(int v) Sets the topic of the status
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

OK

public static final ControllerStatus OK

This status represents a sucessfull operation

Since:

jcms-5.0.0

FORBIDDEN

public static final ControllerStatus FORBIDDEN

This status represents a forbidden operation

Since:

jcms-5.0.0

Constructor Detail

ControllerStatus

public ControllerStatus()

Constructs a new ControllerStatus

Since:

jcms-5.0.0

ControllerStatus

public ControllerStatus(int topic)

Constructs a new ControllerStatus with the given topic

Parameters:

topic - the topic

Since:

jcms-5.0.0

ControllerStatus

public ControllerStatus(String msg)

Constructs a new ControllerStatus with the given message

Parameters:

msg - the message

Since:

jcms-5.0.0

Method Detail

isForbidden

public boolean isForbidden()

Returns whether or not the operation is forbidden

Returns:

true if the status is a forbidden status

Since:

jcms-5.0.0

hasFailed

public boolean hasFailed()

Returns whether or not the operation has failed

Returns:

true if the status is a fail status

Since:

jcms-5.0.0

isOK

public boolean isOK()

Returns whether or not the operation was OK (equal to not hasFailed())

Returns:

true if the status is a OK status, false for a failed status

Since:

jcms-5.0.2

setProp

public void setProp(String prop)

Sets the property used for status message

Parameters:

prop - the property

Since:

jcms-5.0.0

See Also:

getMessage(String)

setProp

public void setProp(String prop,
                    Object p1)

Sets the property

Parameters:

prop - the property

p1 - the first property parameter

Since:

jcms-5.0.0

See Also:

getMessage(String)

setProp

public void setProp(String prop,
                    Object p1,
                    Object p2)

Sets the property

Parameters:

prop - the property

p1 - the first property parameter

p2 - the second property parameter

Since:

jcms-5.0.0

See Also:

getMessage(String)

setProp

public void setProp(String prop,
                    Object p1,
                    Object p2,
                    Object p3)

Sets the property

Parameters:

prop - the property

p1 - the first property parameter

p2 - the second property parameter

p3 - the third property parameter

Since:

jcms-5.0.0

See Also:

getMessage(String)

setProp

public void setProp(String prop,
                    Object[] propParam)

Sets the property

Parameters:

prop - the property

propParam - the property parameters

Since:

jcms-5.0.0

See Also:

getMessage(String)

getProp

public String getProp()

Returns:

the property

Since:

jcms-5.0.0

getMessage

public String getMessage(String userLang)

Returns the status message. It may be either the message provided with setMessage() method or the value of property provided with setProp() methods. In this latter case, the message is localized according the userLang parameter. If there are nested status in this status, it will return all the message in a html form with <ul> <li> ... etc

Parameters:

userLang - the user language to be used to resolved the property

Returns:

the status message

Since:

jcms-5.0.0

See Also:

setProp(String), setProp(String,Object[])

setMessage

public void setMessage(String msg)

Sets the status message. This method should be only invoked for non-localized message. Otherwise use setProp() methods.

Since:

jcms-5.0.0

See Also:

setProp(String), setProp(String,Object[])

getTopic

public int getTopic()

Returns:

the topic of the status

Since:

jcms-5.0.0

setTopic

public void setTopic(int v)

Sets the topic of the status

Since:

jcms-5.0.0

toString

public String toString()

Overrides:

toString in class Object

Returns:

the status message in the default language

Since:

jcms-5.0.0

getNestedStatusList

public ArrayList getNestedStatusList()

Returns:

the list of all nested status (can be null)

Since:

jcms-5.0.2

addNestedStatus

public void addNestedStatus(ControllerStatus status)

Add a ControllerStatus to the list of nested status.

Since:

jcms-5.0.2