Java Doc for DocumentUsecase.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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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.AbstractUsecase
   org.apache.lenya.cms.usecase.DocumentUsecase

All known Subclasses:   org.apache.lenya.cms.lucene.IndexDocument,  org.apache.lenya.cms.site.usecases.MoveSubsite,  org.apache.lenya.cms.editors.fckeditor.Fckeditor,  org.apache.lenya.cms.site.usecases.SiteUsecase,  org.apache.lenya.cms.editors.forms.FormsEditor,  org.apache.lenya.cms.editors.SaveDocument,  org.apache.lenya.cms.usecase.scheduling.ManageJobs,  org.apache.lenya.cms.site.usecases.Copy,  org.apache.lenya.cms.editors.forms.OneFormEditor,  org.apache.lenya.blog.cms.usecases.Deactivate,  org.apache.lenya.blog.cms.usecases.Delete,  org.apache.lenya.cms.site.usecases.ChangeNodeID,  org.apache.lenya.cms.workflow.usecases.History,  org.apache.lenya.cms.site.usecases.CreateBlogEntry,  org.apache.lenya.cms.site.usecases.Nudge,  org.apache.lenya.cms.workflow.usecases.CheckWorkflow,  org.apache.lenya.cms.editors.tinymce.TinyMce,  org.apache.lenya.cms.site.usecases.DeleteLanguage,  org.apache.lenya.cms.site.usecases.Rollback,  org.apache.lenya.cms.editors.EditDocument,  org.apache.lenya.cms.site.usecases.ChangeLabel,  org.apache.lenya.cms.site.usecases.ForceCheckIn,  org.apache.lenya.blog.cms.usecases.Publish,  org.apache.lenya.cms.site.usecases.Cut,  org.apache.lenya.cms.site.usecases.ChangeVisibility,
DocumentUsecase
public class DocumentUsecase extends AbstractUsecase (Code)

Extends AbstractUsecase with document helper methods.

Some parameters are initialized by default:

  • document- the document


Field Summary
final protected static  StringDOCUMENT
    
final protected static  StringTARGET_DOCUMENT
    

Constructor Summary
public  DocumentUsecase()
     Ctor.

Method Summary
protected  voiddoCheckPreconditions()
    
protected  DocumentgetSourceDocument()
     Returns the source document.
public  StringgetSourceURL()
    
protected  DocumentgetTargetDocument(boolean success)
     Returns the document to be redirected to after the usecase has been completed.
public  StringgetTargetURL(boolean success)
     If DocumentUsecase.setTargetDocument(Document) was not called, the URL of the source document ( DocumentUsecase.getSourceDocument() ) is returned.
protected  voidsetDefaultTargetURL(String url)
    
protected  voidsetTargetDocument(Document document)
     Sets the target document for the case that the usecase execution succeeded (see DocumentUsecase.getTargetDocument(boolean) ).

Field Detail
DOCUMENT
final protected static String DOCUMENT(Code)



TARGET_DOCUMENT
final protected static String TARGET_DOCUMENT(Code)




Constructor Detail
DocumentUsecase
public DocumentUsecase()(Code)
Ctor.




Method Detail
doCheckPreconditions
protected void doCheckPreconditions() throws Exception(Code)

See Also:   org.apache.lenya.cms.usecase.AbstractUsecase.doCheckPreconditions



getSourceDocument
protected Document getSourceDocument()(Code)
Returns the source document. A document.



getSourceURL
public String getSourceURL()(Code)

See Also:   org.apache.lenya.cms.usecase.AbstractUsecase.getSourceURL



getTargetDocument
protected Document getTargetDocument(boolean success)(Code)
Returns the document to be redirected to after the usecase has been completed. If the parameter success is false, the source document is returned (override this method to change this behaviour).
Parameters:
  success - If the usecase was successfully completed. A document.



getTargetURL
public String getTargetURL(boolean success)(Code)
If DocumentUsecase.setTargetDocument(Document) was not called, the URL of the source document ( DocumentUsecase.getSourceDocument() ) is returned.
See Also:   org.apache.lenya.cms.usecase.Usecase.getTargetURL(boolean)



setDefaultTargetURL
protected void setDefaultTargetURL(String url)(Code)

See Also:   org.apache.lenya.cms.usecase.AbstractUsecase.setDefaultTargetURL(java.lang.String)



setTargetDocument
protected void setTargetDocument(Document document)(Code)
Sets the target document for the case that the usecase execution succeeded (see DocumentUsecase.getTargetDocument(boolean) ).
Parameters:
  document - A document.



Fields inherited from org.apache.lenya.cms.usecase.AbstractUsecase
final protected static String ATTRIBUTE_NAME(Code)(Java Doc)
final protected static String ATTRIBUTE_POLICY(Code)(Java Doc)
final protected static String ATTRIBUTE_USECASE(Code)(Java Doc)
final protected static String ATTRIBUTE_VALUE(Code)(Java Doc)
final protected static String ELEMENT_EXIT(Code)(Java Doc)
final protected static String ELEMENT_PARAMETER(Code)(Java Doc)
final protected static String ELEMENT_TRANSACTION(Code)(Java Doc)
final protected static String ELEMENT_VIEW(Code)(Java Doc)
final protected static String ERROR_OBJECTS_CHECKED_OUT(Code)(Java Doc)
final protected static String EVENT_CHECK_EXECUTION_CONDITIONS(Code)(Java Doc)
final protected static String EVENT_CHECK_POSTCONDITIONS(Code)(Java Doc)
final protected static String EVENT_CHECK_PRECONDITIONS(Code)(Java Doc)
final protected static String EVENT_EXECUTE(Code)(Java Doc)
final protected static StateMachine.Model MODEL(Code)(Java Doc)
final protected static String PARAMETERS_INITIALIZED(Code)(Java Doc)
final protected static String PARAMETER_CHECKOUT_RESTRICTED_TO_SESSION(Code)(Java Doc)
final protected static String PARAMETER_FACTORY(Code)(Java Doc)
final protected static String PARAMETER_SESSION(Code)(Java Doc)
final protected static String PARAMETER_STATE_MACHINE(Code)(Java Doc)
protected String SOURCE_URL(Code)(Java Doc)
final protected static StateMachine.Transition[] TRANSITIONS(Code)(Java Doc)
final protected static String VALUE_OPTIMISTIC(Code)(Java Doc)
final protected static String VALUE_PESSIMISTIC(Code)(Java Doc)
protected Context context(Code)(Java Doc)
protected ServiceManager manager(Code)(Java Doc)

Methods inherited from org.apache.lenya.cms.usecase.AbstractUsecase
public void addErrorMessage(String message)(Code)(Java Doc)
public void addErrorMessage(String message, String[] _params)(Code)(Java Doc)
public void addErrorMessages(String[] messages)(Code)(Java Doc)
public void addInfoMessage(String message, String[] _params)(Code)(Java Doc)
public void addInfoMessage(String message)(Code)(Java Doc)
public void advance() throws UsecaseException(Code)(Java Doc)
protected void advanceState(String event)(Code)(Java Doc)
protected boolean canCheckOut(Node[] objects) throws RepositoryException(Code)(Java Doc)
public void cancel() throws UsecaseException(Code)(Java Doc)
protected void checkEvent(String event)(Code)(Java Doc)
final public void checkExecutionConditions() throws UsecaseException(Code)(Java Doc)
public void checkPostconditions() throws UsecaseException(Code)(Java Doc)
final public void checkPreconditions() throws UsecaseException(Code)(Java Doc)
protected boolean checkoutRestrictedToSession()(Code)(Java Doc)
protected void clearErrorMessages()(Code)(Java Doc)
protected void clearInfoMessages()(Code)(Java Doc)
public void configure(Configuration config) throws ConfigurationException(Code)(Java Doc)
public void contextualize(Context context) throws ContextException(Code)(Java Doc)
protected void deleteParameter(String name)(Code)(Java Doc)
protected void doCheckExecutionConditions() throws Exception(Code)(Java Doc)
protected void doCheckPostconditions() throws Exception(Code)(Java Doc)
protected void doCheckPreconditions() throws Exception(Code)(Java Doc)
protected void doExecute() throws Exception(Code)(Java Doc)
final protected void doInitialize()(Code)(Java Doc)
protected void dumpErrorMessages()(Code)(Java Doc)
final public void execute() throws UsecaseException(Code)(Java Doc)
public String getBooleanCheckboxParameter(String name)(Code)(Java Doc)
protected Context getContext()(Code)(Java Doc)
protected DocumentFactory getDocumentFactory()(Code)(Java Doc)
public List getErrorMessages()(Code)(Java Doc)
protected String getExitQueryString()(Code)(Java Doc)
public List getInfoMessages()(Code)(Java Doc)
public String getName()(Code)(Java Doc)
protected Node[] getNodesToLock() throws UsecaseException(Code)(Java Doc)
public Object getParameter(String name)(Code)(Java Doc)
public Object getParameter(String name, Object defaultValue)(Code)(Java Doc)
public boolean getParameterAsBoolean(String name, boolean defaultValue)(Code)(Java Doc)
public int getParameterAsInteger(String name, int defaultValue)(Code)(Java Doc)
public String getParameterAsString(String name)(Code)(Java Doc)
public String getParameterAsString(String name, String defaultValue)(Code)(Java Doc)
public String[] getParameterNames()(Code)(Java Doc)
public Map getParameters()(Code)(Java Doc)
public Part getPart(String name)(Code)(Java Doc)
public Session getSession()(Code)(Java Doc)
public String getSourceURL()(Code)(Java Doc)
protected StateMachine getStateMachine()(Code)(Java Doc)
public String getTargetURL(boolean success)(Code)(Java Doc)
public UsecaseView getView()(Code)(Java Doc)
public boolean hasErrors()(Code)(Java Doc)
public boolean hasInfoMessages()(Code)(Java Doc)
protected void initParameters()(Code)(Java Doc)
final public void initialize() throws Exception(Code)(Java Doc)
protected void initializeParametersIfNotDone()(Code)(Java Doc)
public boolean isOptimistic()(Code)(Java Doc)
final public void lockInvolvedObjects() throws UsecaseException(Code)(Java Doc)
final public void lockInvolvedObjects(Node[] objects) throws UsecaseException(Code)(Java Doc)
protected void prepareView() throws Exception(Code)(Java Doc)
public void service(ServiceManager manager) throws ServiceException(Code)(Java Doc)
protected void setDefaultTargetURL(String url)(Code)(Java Doc)
protected void setExitParameter(String name, String value)(Code)(Java Doc)
public void setName(String name)(Code)(Java Doc)
public void setParameter(String name, Object value)(Code)(Java Doc)
public void setPart(String name, Part value)(Code)(Java Doc)
protected void setSession(org.apache.lenya.cms.repository.Session session)(Code)(Java Doc)
public void setSourceURL(String url)(Code)(Java Doc)
public void setTestSession(Session session)(Code)(Java Doc)
public void setView(UsecaseView view)(Code)(Java Doc)
protected void startTransaction() throws RepositoryException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.