Java Doc for FlowHelper.java in » Content-Management-System » apache-lenya-2.0 » org » apache » lenya » cms » cocoon » flow » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Content Management System » apache lenya 2.0 » org.apache.lenya.cms.cocoon.flow

Source Cross Reference Class Diagram Java Document (Java Doc)

org.apache.lenya.cms.cocoon.flow .FlowHelper

All known Subclasses:   org.apache.lenya.cms.cocoon.flow .FlowHelperImpl,
FlowHelper
public interface FlowHelper (Code)
Flowscript utility class.
version:
   $Id: FlowHelper.java 564507 2007-08-10 08:33:31Z andreas $

Field Summary
String ROLE
     The Avalon Role.

Method Summary
DocumentHelper getDocumentHelper(FOM_Cocoon cocoon)
     Returns a DocumentHelper instance.
String getImageParameterValue(FOM_Cocoon cocoon, String parameterName)
     Resolves the request parameter value for a specific name.
Map getObjectModel(FOM_Cocoon cocoon)

PageEnvelope getPageEnvelope(FOM_Cocoon cocoon)
     Returns the current page envelope.
Parameters:
  cocoon - The FOM_Cocoon object.
Request getRequest(FOM_Cocoon cocoon)
     Returns the request object of the current request.
Parameters:
  cocoon - The FOM_Cocoon object.
String getRequestURI(FOM_Cocoon cocoon)
     Returns the request URI of the current request.
Parameters:
  cocoon - The FOM_Cocoon object.
void reservedCheckIn(FOM_Cocoon cocoon, boolean backup)
     Checkis in the current document from the PageEnvelope context.
void triggerWorkflow(FOM_Cocoon cocoon, String event)
     Trigger a workflow event for the document associated with the current PageEnvelope.

Field Detail
ROLE
String ROLE(Code)
The Avalon Role.

Method Detail
getDocumentHelper
DocumentHelper getDocumentHelper(FOM_Cocoon cocoon)(Code)
Returns a DocumentHelper instance.
Parameters:
  cocoon - The Flow Object Model of Cocoon The document helper
See Also:   DocumentHelper

getImageParameterValue
String getImageParameterValue(FOM_Cocoon cocoon, String parameterName)(Code)
Resolves the request parameter value for a specific name. The parameter names are encoded as {name}:{value}.{axis}. This is a workaround for the <input type="image"/> bug in Internet Explorer.
Parameters:
  cocoon - The FOM_Cocoon object.
Parameters:
  parameterName - The request parameter name. A string.

getObjectModel
Map getObjectModel(FOM_Cocoon cocoon)(Code)
Returns the Cocoon Object Model
Parameters:
  cocoon - The Flow Object Model of Cocoon The object model

getPageEnvelope
PageEnvelope getPageEnvelope(FOM_Cocoon cocoon) throws PageEnvelopeException(Code)
Returns the current page envelope.
Parameters:
  cocoon - The FOM_Cocoon object. A page envelope.
throws:
  PageEnvelopeException - when something went wrong.

getRequest
Request getRequest(FOM_Cocoon cocoon)(Code)
Returns the request object of the current request.
Parameters:
  cocoon - The FOM_Cocoon object. A request object.

getRequestURI
String getRequestURI(FOM_Cocoon cocoon)(Code)
Returns the request URI of the current request.
Parameters:
  cocoon - The FOM_Cocoon object. A string.

reservedCheckIn
void reservedCheckIn(FOM_Cocoon cocoon, boolean backup) throws FileReservedCheckInException, Exception(Code)
Checkis in the current document from the PageEnvelope context.
Parameters:
  cocoon - The Cocoon Flow Object Model
Parameters:
  backup - Wether a new revision should be created.
throws:
  FileReservedCheckInException -
throws:
  Exception -

triggerWorkflow
void triggerWorkflow(FOM_Cocoon cocoon, String event) throws WorkflowException, PageEnvelopeException, AccessControlException(Code)
Trigger a workflow event for the document associated with the current PageEnvelope.
Parameters:
  cocoon - The Cocoon Flow Object Model
Parameters:
  event - The name of the workflow event to trigger.
throws:
  WorkflowException - If an workflow error occurs
throws:
  PageEnvelopeException - Page envelope can not operate properly.
throws:
  AccessControlException - If an access control violation occurs.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.