Java Doc for Usecase.java in » Content-Management-System » apache-lenya-2.0 » org » apache » lenya » cms » usecase » 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.usecase

Source Cross Reference Class Diagram Java Document (Java Doc)

org.apache.lenya.cms.usecase .Usecase

All known Subclasses:   org.apache.lenya.cms.usecase .AbstractUsecase,
Usecase
public interface Usecase (Code)
Usecase interface.
version:
   $Id: Usecase.java 568271 2007-08-21 20:49:18Z andreas $

Field Summary
String ROLE
     The Usecase role.

Method Summary
void advance()
     Advances the usecase to the next step.
void cancel()
     Cancels the usecase.
void checkExecutionConditions()
     Checks the conditions right before the operation is executed.
void checkPostconditions()
     Checks the conditions after the usecase was executed.
void checkPreconditions()
     Checks the conditions before a form is displayed.
void execute()
     Executes the usecase.
List getErrorMessages()
     Returns the error messages from the previous operation.
List getInfoMessages()
     Returns the info messages from the previous operation.
String getName()

Object getParameter(String name)
     Returns the current value of a parameter.
Parameters:
  name - The parameter name.
Object getParameter(String name, Object defaultValue)
     Returns the current value of a parameter.
Parameters:
  name - The parameter name.
Parameters:
  defaultValue - The default value to return if the parameter is not set.
String getParameterAsString(String name)
     Returns the current value of a parameter as a string.
Parameters:
  name - The parameter name.
String[] getParameterNames()

Part getPart(String name)
     Returns the current value of a part parameter as a string.
Parameters:
  name - The part parameter name.
Session getSession()

String getSourceURL()

String getTargetURL(boolean success)
     Returns the webapp URL which should be redirected to after the usecase is completed.
Parameters:
  success - If the usecase was completed successfully.
UsecaseView getView()

public boolean hasErrors()
     Determine if the usecase has error messages.
public boolean hasInfoMessages()
     Determine if the usecase has info messages.
boolean isOptimistic()

void lockInvolvedObjects()
     Locks all objects that are involved in the transaction.
void setName(String name)

void setParameter(String name, Object value)
     Sets a parameter from the form.
void setPart(String name, Part value)
     Sets a parameter from the form.
void setSourceURL(String url)

void setTestSession(Session session)
     If you invoke this method, the usecase won't use its own isolated session, but the passed test session.
void setView(UsecaseView view)


Field Detail
ROLE
String ROLE(Code)
The Usecase role.

Method Detail
advance
void advance() throws UsecaseException(Code)
Advances the usecase to the next step. This method is called when all parameters are set.
throws:
  UsecaseException - if an error occurs.

cancel
void cancel() throws UsecaseException(Code)
Cancels the usecase.
throws:
  UsecaseException - if an error occurs.

checkExecutionConditions
void checkExecutionConditions() throws UsecaseException(Code)
Checks the conditions right before the operation is executed.
throws:
  UsecaseException - if an error occurs that causes an unstablesystem.

checkPostconditions
void checkPostconditions() throws UsecaseException(Code)
Checks the conditions after the usecase was executed.
throws:
  UsecaseException - if an error occurs that causes an unstablesystem.

checkPreconditions
void checkPreconditions() throws UsecaseException(Code)
Checks the conditions before a form is displayed.
throws:
  UsecaseException - if an error occurs that causes an unstablesystem.

execute
void execute() throws UsecaseException(Code)
Executes the usecase. During this method error and info messages are filled in. If getErrorMessages() returns an empty array, the operation succeeded. Otherwise, the operation failed.
throws:
  UsecaseException - if an error occured that causes an unstablesystem.

getErrorMessages
List getErrorMessages()(Code)
Returns the error messages from the previous operation. Error messages prevent the operation from being executed. A list of UsecaseMessage objects.

getInfoMessages
List getInfoMessages()(Code)
Returns the info messages from the previous operation. Info messages do not prevent the operation from being executed. A list of UsecaseMessage objects.

getName
String getName()(Code)
The name of this usecase.

getParameter
Object getParameter(String name)(Code)
Returns the current value of a parameter.
Parameters:
  name - The parameter name. An object.

getParameter
Object getParameter(String name, Object defaultValue)(Code)
Returns the current value of a parameter.
Parameters:
  name - The parameter name.
Parameters:
  defaultValue - The default value to return if the parameter is not set. An object.

getParameterAsString
String getParameterAsString(String name)(Code)
Returns the current value of a parameter as a string.
Parameters:
  name - The parameter name. A string or null if the parameter was not set.

getParameterNames
String[] getParameterNames()(Code)
The parameter names.

getPart
Part getPart(String name)(Code)
Returns the current value of a part parameter as a string.
Parameters:
  name - The part parameter name. A part or null if the part was not set.

getSession
Session getSession()(Code)
The repository session.

getSourceURL
String getSourceURL()(Code)
The web application URL the usecase was invoked on.

getTargetURL
String getTargetURL(boolean success)(Code)
Returns the webapp URL which should be redirected to after the usecase is completed.
Parameters:
  success - If the usecase was completed successfully. A web application URL.

getView
UsecaseView getView()(Code)
The view of the usecase.

hasErrors
public boolean hasErrors()(Code)
Determine if the usecase has error messages. Provides a way of checking for errors without actually retrieving them. true if the usecase resulted in error messages.

hasInfoMessages
public boolean hasInfoMessages()(Code)
Determine if the usecase has info messages. Provides a way of checking for info messages without actually retrieving them. true if the usecase resulted in info messages being generated.

isOptimistic
boolean isOptimistic()(Code)
if the usecase uses optimistic offline lock.

lockInvolvedObjects
void lockInvolvedObjects() throws UsecaseException(Code)
Locks all objects that are involved in the transaction.
throws:
  UsecaseException - if an error occurs.

setName
void setName(String name)(Code)

Parameters:
  name - The name of this usecase.

setParameter
void setParameter(String name, Object value)(Code)
Sets a parameter from the form.
Parameters:
  name - The parameter name.
Parameters:
  value - The parameter value.

setPart
void setPart(String name, Part value)(Code)
Sets a parameter from the form. This method is called for parts in multipart requests.
Parameters:
  name - The parameter name.
Parameters:
  value - The parameter value.

setSourceURL
void setSourceURL(String url)(Code)

Parameters:
  url - The URL the usecase is invoked on.

setTestSession
void setTestSession(Session session)(Code)
If you invoke this method, the usecase won't use its own isolated session, but the passed test session. The session will not be committed when the usecase is invoked, so you can check it for modifications without modifying the repository.
Parameters:
  session - The test session.

setView
void setView(UsecaseView view)(Code)

Parameters:
  view - The view of the usecase.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.