|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.CmsMultiDialog
org.opencms.workplace.commons.CmsAvailability
Provides methods for the resource availability/notification dialog.
The following files use this class:
Field Summary | |
static java.lang.String |
DIALOG_TYPE
The dialog type. |
static java.lang.String |
PARAM_ENABLE_NOTIFICATION
Request parameter name for the activation of the notifciation. |
static java.lang.String |
PARAM_EXPIREDATE
Request parameter name for the expiredate. |
static java.lang.String |
PARAM_LEAVEEXPIRE
Request parameter name for the leaveexpire. |
static java.lang.String |
PARAM_LEAVERELEASE
Request parameter name for the leaverelease. |
static java.lang.String |
PARAM_MODIFY_SIBLINGS
Request parameter name for the recursive flag. |
static java.lang.String |
PARAM_NOTIFICATION_INTERVAL
Request parameter name for the activation of the notifciation. |
static java.lang.String |
PARAM_RECURSIVE
Request parameter name for the recursive flag. |
static java.lang.String |
PARAM_RELEASEDATE
Request parameter name for the releasedate. |
static java.lang.String |
PARAM_RESETEXPIRE
Request parameter name for the resetexpire. |
static java.lang.String |
PARAM_RESETRELEASE
Request parameter name for the resetrelease. |
Fields inherited from class org.opencms.workplace.CmsMultiDialog |
DELIMITER_RESOURCES, PARAM_RESOURCELIST |
Fields inherited from class org.opencms.workplace.tools.CmsToolDialog |
PARAM_BASE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW |
Constructor Summary | |
CmsAvailability(CmsJspActionElement jsp)
Public constructor. |
|
CmsAvailability(javax.servlet.jsp.PageContext context,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables. |
Method Summary | |
void |
actionCloseDialog()
Used to close the current JSP dialog. |
void |
actionUpdate()
Performs the resource operation, will be called by the JSP page. |
java.lang.String |
buildCheckboxEnableNotification()
Creates the checkbox to enable content notification for a resource. |
java.lang.String |
buildCheckboxModifySiblings()
Creates an the checkbox to modify all siblings. |
java.lang.String |
buildCheckRecursive()
Creates the "recursive" checkbox for touching subresources of folders. |
java.lang.String |
buildInputNotificationInterval()
Creates an input field for the notification interval. |
java.lang.String |
buildResponsibleList()
Builds a String with HTML code to display the responsibles of a resource. |
java.lang.String |
calendarIncludes()
Deprecated. use CmsCalendarWidget.calendarIncludes(java.util.Locale) , this is just here so that old JSP still work |
java.lang.String |
calendarInit(java.lang.String inputFieldId,
java.lang.String triggerButtonId,
java.lang.String align,
boolean singleClick,
boolean weekNumbers,
boolean mondayFirst,
java.lang.String dateStatusFunc,
boolean showTime)
Deprecated. use CmsCalendarWidget.calendarInit(org.opencms.i18n.CmsMessages, String, String, String, boolean, boolean, boolean, String, boolean) , this is just here so that old JSP still work |
java.lang.String |
getCurrentDateTime()
Returns the current date and time as String formatted in localized pattern. |
java.lang.String |
getCurrentExpireDate()
Returns the current expiredate as String formatted in localized pattern. |
java.lang.String |
getCurrentReleaseDate()
Returns the current releasedate as String formatted in localized pattern. |
protected java.lang.String |
getLocalizedType(int flags)
Returns a localized String for "Group", if the flag of a group ACE, and the localization for "User" otherwise. |
java.lang.String |
getParamEnablenotification()
Returns the value of the enable_notification parameter. |
java.lang.String |
getParamExpiredate()
Returns the value of the new expiredate parameter, or null if this parameter was not provided. |
java.lang.String |
getParamLeaveexpire()
Returns the value of the leaveexpire parameter. |
java.lang.String |
getParamModifysiblings()
Returns the value of the modify siblings parameter, or null if this parameter was not provided. |
java.lang.String |
getParamNotificationinterval()
Returns the value of the notification interval parameter, or null if this parameter was not provided. |
java.lang.String |
getParamRecursive()
Returns the value of the recursive parameter, or null if this parameter was not provided. |
java.lang.String |
getParamReleasedate()
Returns the value of the new releasedate parameter, or null if this parameter was not provided. |
java.lang.String |
getParamResetexpire()
Returns the value of the resetexpire parameter. |
java.lang.String |
getParamResetrelease()
Returns the value of the resetrelease parameter. |
protected void |
initWorkplaceRequestValues(CmsWorkplaceSettings settings,
javax.servlet.http.HttpServletRequest request)
Analyzes the request for workplace parameters and adjusts the workplace settings accordingly. |
protected boolean |
performDialogOperation()
Modifies the release and expire date of a resource, and changes the notification interval. |
protected void |
performSingleResource(java.lang.String resName,
long releaseDate,
long expireDate,
boolean leaveRelease,
boolean leaveExpire,
boolean modifyRecursive,
boolean modifySiblings)
Performs the availability and notification operations on a single resource. |
void |
setParamEnablenotification(java.lang.String value)
Sets the value of the enable notification parameter. |
void |
setParamExpiredate(java.lang.String value)
Sets the value of the expire date. |
void |
setParamLeaveexpire(java.lang.String paramLeaveexpire)
Sets the value of the leaveexpire parameter. |
void |
setParamModifysiblings(java.lang.String value)
Sets the value of the modify siblings parameter. |
void |
setParamNotificationinterval(java.lang.String value)
Sets the value of the new timestamp parameter. |
void |
setParamRecursive(java.lang.String value)
Sets the value of the recursive parameter. |
void |
setParamReleasedate(java.lang.String value)
Sets the value of the releasedate parameter. |
void |
setParamResetexpire(java.lang.String paramResetexpire)
Sets the value of the resetexpire parameter. |
void |
setParamResetrelease(java.lang.String paramResetrelease)
Sets the value of the resetrelease parameter. |
protected void |
writeProperty(java.lang.String resourcePath,
java.lang.String propertyName,
java.lang.String propertyValue)
Writes a property value for a resource. |
Methods inherited from class org.opencms.workplace.CmsMultiDialog |
addMultiOperationException, buildLockHeaderBox, buildResourceList, checkMultiOperationException, checkResourcePermissions, getParamResourcelist, getResourceList, getResourceListAsParam, isMultiOperation, isOperationOnFolder, setDialogTitle, setParamResource, setParamResourcelist |
Methods inherited from class org.opencms.workplace.tools.CmsToolDialog |
dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamPath, setParamRoot, setParamStyle, useNewStyle |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String DIALOG_TYPE
public static final java.lang.String PARAM_ENABLE_NOTIFICATION
public static final java.lang.String PARAM_EXPIREDATE
public static final java.lang.String PARAM_LEAVEEXPIRE
public static final java.lang.String PARAM_LEAVERELEASE
public static final java.lang.String PARAM_MODIFY_SIBLINGS
public static final java.lang.String PARAM_NOTIFICATION_INTERVAL
public static final java.lang.String PARAM_RECURSIVE
public static final java.lang.String PARAM_RELEASEDATE
public static final java.lang.String PARAM_RESETEXPIRE
public static final java.lang.String PARAM_RESETRELEASE
Constructor Detail |
public CmsAvailability(CmsJspActionElement jsp)
jsp
- an initialized JSP action elementpublic CmsAvailability(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
context
- the JSP page contextreq
- the JSP requestres
- the JSP responseMethod Detail |
public void actionCloseDialog() throws javax.servlet.jsp.JspException
CmsDialog
This method tries to include the URI stored in the workplace settings. This URI is determined by the frame name, which has to be set in the framename parameter.
actionCloseDialog
in class CmsDialog
javax.servlet.jsp.JspException
- if including an element failsCmsDialog.actionCloseDialog()
public void actionUpdate() throws javax.servlet.jsp.JspException
javax.servlet.jsp.JspException
- if problems including sub-elements occurpublic java.lang.String buildCheckboxEnableNotification()
public java.lang.String buildCheckboxModifySiblings()
If no siblings exist for this resource, an empty string will be returned.
public java.lang.String buildCheckRecursive()
public java.lang.String buildInputNotificationInterval()
public java.lang.String buildResponsibleList()
public java.lang.String calendarIncludes()
CmsCalendarWidget.calendarIncludes(java.util.Locale)
, this is just here so that old JSP still work
public java.lang.String calendarInit(java.lang.String inputFieldId, java.lang.String triggerButtonId, java.lang.String align, boolean singleClick, boolean weekNumbers, boolean mondayFirst, java.lang.String dateStatusFunc, boolean showTime)
CmsCalendarWidget.calendarInit(org.opencms.i18n.CmsMessages, String, String, String, boolean, boolean, boolean, String, boolean)
, this is just here so that old JSP still work
inputFieldId
- the ID of the input field where the date is pasted totriggerButtonId
- the ID of the button which triggers the calendaralign
- initial position of the calendar popup elementsingleClick
- if true, a single click selects a date and closes the calendar, otherwise calendar is closed by doubleclickweekNumbers
- show the week numbers in the calendar or notmondayFirst
- show monday as first day of weekdateStatusFunc
- name of the function which determines if/how a date should be disabledshowTime
- true if the time selector should be shown, otherwise false
public java.lang.String getCurrentDateTime()
public java.lang.String getCurrentExpireDate()
public java.lang.String getCurrentReleaseDate()
public java.lang.String getParamEnablenotification()
The enable_notification parameter if content notification is enabled for this resource.
public java.lang.String getParamExpiredate()
public java.lang.String getParamLeaveexpire()
public java.lang.String getParamModifysiblings()
public java.lang.String getParamNotificationinterval()
public java.lang.String getParamRecursive()
The recursive parameter on folders decides if all subresources of the folder should be touched, too.
public java.lang.String getParamReleasedate()
The releasedate parameter stores the new releasedate as String.
public java.lang.String getParamResetexpire()
public java.lang.String getParamResetrelease()
public void setParamEnablenotification(java.lang.String value)
value
- the value to setpublic void setParamExpiredate(java.lang.String value)
value
- the value to setpublic void setParamLeaveexpire(java.lang.String paramLeaveexpire)
paramLeaveexpire
- the value of the leaveexpire parameterpublic void setParamModifysiblings(java.lang.String value)
value
- the value to setpublic void setParamNotificationinterval(java.lang.String value)
value
- the value to setpublic void setParamRecursive(java.lang.String value)
value
- the value to setpublic void setParamReleasedate(java.lang.String value)
value
- the value to setpublic void setParamResetexpire(java.lang.String paramResetexpire)
paramResetexpire
- the value of the resetexpire parameterpublic void setParamResetrelease(java.lang.String paramResetrelease)
paramResetrelease
- the value of the resetrelease parameterprotected java.lang.String getLocalizedType(int flags)
flags
- the flags of the ACE
protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
CmsWorkplace
initWorkplaceRequestValues
in class CmsDialog
CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
protected boolean performDialogOperation() throws CmsException
performDialogOperation
in class CmsMultiDialog
CmsException
- if modification is not successfulprotected void performSingleResource(java.lang.String resName, long releaseDate, long expireDate, boolean leaveRelease, boolean leaveExpire, boolean modifyRecursive, boolean modifySiblings) throws CmsException
resName
- the VFS path of the resourcereleaseDate
- the new release dateexpireDate
- the new expiration dateleaveRelease
- flag indicating if the release date should be left untouchedleaveExpire
- flag indicating if the expiration date should be left untouchedmodifyRecursive
- flag indicating if the operation is recursive for foldersmodifySiblings
- flag indicating to include resource siblings
CmsException
- if the availability and notification operations failprotected void writeProperty(java.lang.String resourcePath, java.lang.String propertyName, java.lang.String propertyValue) throws CmsException
resourcePath
- the path of the resourcepropertyName
- the name of the propertypropertyValue
- the new value of the property
CmsException
- if something goes wrong
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |