|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lenya.cms.cocoon.flow.FlowHelper
public class FlowHelper
Flowscript utility class. The FOM_Cocoon object is not passed in the constructor to avoid errors. This way, not the initial, but the current FOM_Cocoon object is used by the methods.
Field Summary | |
---|---|
static java.lang.String |
SEPARATOR
|
Constructor Summary | |
---|---|
FlowHelper()
Ctor. |
Method Summary | |
---|---|
DocumentHelper |
getDocumentHelper(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon)
Returns a DocumentHelper instance. |
java.lang.String |
getImageParameterValue(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon,
java.lang.String parameterName)
Resolves the request parameter value for a specific name. |
java.util.Map |
getObjectModel(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon)
Returns the Cocoon Object Model |
PageEnvelope |
getPageEnvelope(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon)
Returns the current page envelope. |
org.apache.cocoon.environment.Request |
getRequest(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon)
Returns the request object of the current request. |
java.lang.String |
getRequestURI(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon)
Returns the request URI of the current request. |
RevisionController |
getRevisionController(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon)
Get a RevisionController instance. |
Situation |
getSituation(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon)
Returns the current workflow situation. |
void |
reservedCheckIn(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon,
boolean backup)
Checkis in the current document from the PageEnvelope context. |
void |
triggerWorkflow(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon,
java.lang.String event)
Trigger a workflow event for the document associated with the current PageEnvelope. |
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 SEPARATOR
Constructor Detail |
---|
public FlowHelper()
Method Detail |
---|
public Situation getSituation(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon) throws AccessControlException
cocoon
- The FOM_Cocoon object.
AccessControlException
- when something went wrong.public PageEnvelope getPageEnvelope(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon) throws PageEnvelopeException
cocoon
- The FOM_Cocoon object.
PageEnvelopeException
- when something went wrong.public java.lang.String getRequestURI(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon)
cocoon
- The FOM_Cocoon object.
public org.apache.cocoon.environment.Request getRequest(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon)
cocoon
- The FOM_Cocoon object.
public java.util.Map getObjectModel(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon)
cocoon
- The Flow Object Model of Cocoon
public DocumentHelper getDocumentHelper(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon)
cocoon
- The Flow Object Model of Cocoon
DocumentHelper
public java.lang.String getImageParameterValue(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon, java.lang.String parameterName)
{name}:{value}.{axis}
.
This is a workaround for the <input type="image"/>
bug in Internet Explorer.
cocoon
- The FOM_Cocoon object.parameterName
- The request parameter name.
public void triggerWorkflow(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon, java.lang.String event) throws WorkflowException, PageEnvelopeException, AccessControlException
cocoon
- The Cocoon Flow Object Modelevent
- The name of the workflow event to trigger.
WorkflowException
- If an workflow error occurs
PageEnvelopeException
- Page envelope can not operate properly.
AccessControlException
- If an access control violation occurs.public RevisionController getRevisionController(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon) throws PageEnvelopeException, java.io.IOException
cocoon
- The Cocoon Flow Object Model
PageEnvelopeException
- Page envelope can not operate properly.
java.io.IOException
- If an IOException occurs.PageEnvelope
,
RevisionController
public void reservedCheckIn(org.apache.cocoon.components.flow.javascript.fom.FOM_Cocoon cocoon, boolean backup) throws FileReservedCheckInException, java.lang.Exception
cocoon
- The Cocoon Flow Object Modelbackup
- Wether a new revision should be created.
FileReservedCheckInException
java.lang.Exception
RevisionController.reservedCheckIn(String, String, boolean)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |