Package com.jalios.jcms
Class ControllerStatus
java.lang.Object
com.jalios.jcms.ControllerStatus
- All Implemented Interfaces:
JcmsConstants,JaliosConstants
This class represents the status returned by a DataController.
- Author:
- Olivier Dedieu
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ControllerStatusThis status represents a forbidden operationstatic final ControllerStatusThis status represents a sucessfull operationFields 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_YEARFields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GENERATIONAL_STORE_DIRECTORY, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PHOTO_XLARGE, PHOTO_XLARGE_HEIGHT, PHOTO_XLARGE_PROP_PREFIX, PHOTO_XLARGE_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, SVGSPRITE_ICON_PREFIX, TEMPLATE_TAB, THEME_DIR, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, TYPES_UNKNOWN_CLASS_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new ControllerStatusControllerStatus(int topic) Constructs a new ControllerStatus with a given topic.ControllerStatus(String msg) Constructs a new ControllerStatus with the given message -
Method Summary
Modifier and TypeMethodDescriptionvoidaddNestedStatus(ControllerStatus status) Add a ControllerStatus to the list of nested status.getMessage(String userLang) Returns the status message.getProp()Object[]intgetTopic()booleanReturns whether or not the operation has failedbooleanReturns whether or not the operation is forbiddenbooleanisOK()Returns whether or not the operation was OK (equal to not hasFailed())voidsetMessage(String msg) Sets the status message.voidSets the property used for status messagevoidsetTopic(int v) Sets the topic of the statustoString()
-
Field Details
-
OK
This status represents a sucessfull operation- Since:
- jcms-5.0.0
-
FORBIDDEN
This status represents a forbidden operation- Since:
- jcms-5.0.0
-
-
Constructor Details
-
ControllerStatus
public ControllerStatus()Constructs a new ControllerStatus- Since:
- jcms-5.0.0
-
ControllerStatus
public ControllerStatus(int topic) Constructs a new ControllerStatus with a given topic. Warning! This constructor is reserved for JPlatform internal usage.- Parameters:
topic- the topic (an internal JPlatform ControllerStatus topic)- Since:
- jcms-5.0.0
-
ControllerStatus
Constructs a new ControllerStatus with the given message- Parameters:
msg- the message- Since:
- jcms-5.0.0
-
-
Method Details
-
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
Sets the property used for status message- Parameters:
prop- the propertypropParams- the property parameters- Since:
- jcms-8
-
getProp
- Returns:
- the property
- Since:
- jcms-5.0.0
-
getPropParams
- Returns:
- the property parameters
- Since:
- jcms-8
-
getMessage
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:
-
setMessage
Sets the status message. This method should be only invoked for non-localized message. Otherwise use setProp() methods.- Parameters:
msg- message- Since:
- jcms-5.0.0
- See Also:
-
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- Parameters:
v- topic- Since:
- jcms-5.0.0
-
toString
-
getNestedStatusList
- Returns:
- the list of all nested status (can be null)
- Since:
- jcms-5.0.2
-
addNestedStatus
Add a ControllerStatus to the list of nested status.- Parameters:
status-ControllerStatus- Since:
- jcms-5.0.2
-