Open Source Enterprise Content Management for the Enterprise

A proven framework for building great web sites

Search:

OpenEdit Software OpenEdit User Group OpenEdit Services English Español

OpenEdit Software

Download Feature Matrix Video Tutorials Screenshots OpenEdit Demo Documentation

OpenEdit User Group

User Forum OpenEdit Blog Who is using OpenEdit? OE Project Tracker

OpenEdit Services

Software Consulting Hosting Contact Us

com.openedit.modules.edit
Class EditModule

java.lang.Object
  BaseModule
      com.openedit.modules.edit.BaseEditorModule
          com.openedit.modules.edit.EditModule

public class EditModule
extends BaseEditorModule

This module provides the page editing functionality, and several actions to support it.

Author:

Eric Galluzzo

Constructor Summary

EditModule()

Method Summary

void	claimEditLock(WebPageRequest inReq) This command claims the edit lock for a path, which should be given via the editPath request parameter, unless the doNotCheckLock request parameter is set to true, in which case nothing will be done.
void	forciblyClaimEditLock(WebPageRequest inReq)
EditLockRegistry	getEditLockRegistry() Returns the edit lock registry used when claiming and releasing locks.
java.lang.String	getEditLockWarningPath()
void	releaseEditLock(WebPageRequest inReq)
void	setEditLockWarningPath(java.lang.String editLockWarningPath)

Methods inherited from class com.openedit.modules.edit.BaseEditorModule

check404, checkExist, forceDownload, redirectToOriginal, writeContent

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EditModule

public EditModule()

Method Detail

getEditLockRegistry

public EditLockRegistry getEditLockRegistry()

Returns the edit lock registry used when claiming and releasing locks.

Returns:

EditLockRegistry

claimEditLock

public void claimEditLock(WebPageRequest inReq)
                   throws OpenEditException,
                          javax.servlet.ServletException

This command claims the edit lock for a path, which should be given via the editPath request parameter, unless the doNotCheckLock request parameter is set to true, in which case nothing will be done. If the edit lock is already claimed, the user will be redirected to a warning page.

Throws:

javax.servlet.ServletException

OpenEditException

getEditLockWarningPath

public java.lang.String getEditLockWarningPath()

setEditLockWarningPath

public void setEditLockWarningPath(java.lang.String editLockWarningPath)

releaseEditLock

public void releaseEditLock(WebPageRequest inReq)
                     throws OpenEditException

Throws:

OpenEditException

forciblyClaimEditLock

public void forciblyClaimEditLock(WebPageRequest inReq)
                           throws OpenEditException

Throws:

OpenEditException