| Method Summary |
|
| public void | addErrorMessage(String message)
Adds an error message. |
| public void | addErrorMessage(String message, String[] _params)
Adds an error message. |
| public void | addErrorMessages(String[] messages)
Adds an error message. |
| public void | addInfoMessage(String message, String[] _params)
Adds an info message. |
| public void | addInfoMessage(String message)
Adds an info message. |
| public void | advance()
|
| protected void | advanceState(String event)
Advance the usecase state machine to the next state. |
| protected boolean | canCheckOut(Node[] objects)
|
| public void | cancel()
|
| protected void | checkEvent(String event)
|
| final public void | checkExecutionConditions()
|
| public void | checkPostconditions()
|
| final public void | checkPreconditions()
|
| protected boolean | checkoutRestrictedToSession()
|
| protected void | clearErrorMessages()
Clears the error messages. |
| protected void | clearInfoMessages()
Clears the info messages. |
| public void | configure(Configuration config)
|
| public void | contextualize(Context context)
|
| protected void | deleteParameter(String name)
Deletes a parameter. |
| protected void | doCheckExecutionConditions()
Checks the execution conditions. |
| protected void | doCheckPostconditions()
Checks the post conditions. |
| protected void | doCheckPreconditions()
Checks the preconditions. |
| protected void | doExecute()
Executes the operation. |
| final protected void | doInitialize()
Does the actual initialization. |
| protected void | dumpErrorMessages()
Dumps the error messages to the log. |
| final public void | execute()
|
| public String | getBooleanCheckboxParameter(String name)
Returns one of the strings "true" or "false" depending on whether the corresponding checkbox
was checked.
Parameters:
name - The parameter name. |
| protected Context | getContext()
Returns the context. |
| protected DocumentFactory | getDocumentFactory()
|
| public List | getErrorMessages()
Checks if the operation can be executed and returns the error messages. |
| protected String | getExitQueryString()
Returns the query string to access the exit usecase of this usecase. |
| public List | getInfoMessages()
Returns the information messages to show on the confirmation screen.
An array of strings. |
| public String | getName()
|
| protected Node[] | getNodesToLock()
|
| public Object | getParameter(String name)
|
| public Object | getParameter(String name, Object defaultValue)
|
| public boolean | getParameterAsBoolean(String name, boolean defaultValue)
Returns a parameter as boolean. |
| public int | getParameterAsInteger(String name, int defaultValue)
Returns a parameter as integer. |
| public String | getParameterAsString(String name)
|
| public String | getParameterAsString(String name, String defaultValue)
Returns a parameter as string. |
| public String[] | getParameterNames()
|
| public Map | getParameters()
|
| public Part | getPart(String name)
|
| public Session | getSession()
|
| public String | getSourceURL()
|
| protected StateMachine | getStateMachine()
|
| public String | getTargetURL(boolean success)
If
AbstractUsecase.setDefaultTargetURL(String) was not called, the source document (
AbstractUsecase.getSourceURL() ) is returned. |
| public UsecaseView | getView()
|
| public boolean | hasErrors()
Determine if the usecase has error messages. |
| public boolean | hasInfoMessages()
Determine if the usecase has info messages. |
| protected void | initParameters()
Override to initialize parameters. |
| final public void | initialize()
|
| protected void | initializeParametersIfNotDone()
|
| public boolean | isOptimistic()
|
| final public void | lockInvolvedObjects()
This method starts the transaction and locks all involved objects immediately. |
| final public void | lockInvolvedObjects(Node[] objects)
Lock the objects, for example when you need to change them (for example, delete). |
| protected void | prepareView()
Override this method to prepare the view (add information messages etc.). |
| public void | service(ServiceManager manager)
|
| protected void | setDefaultTargetURL(String url)
Sets the default target URL which should be used if no explicit target URL is set. |
| protected void | setExitParameter(String name, String value)
Sets a parameter to pass to the exit usecase. |
| public void | setName(String name)
|
| public void | setParameter(String name, Object value)
|
| public void | setPart(String name, Part value)
|
| protected void | setSession(org.apache.lenya.cms.repository.Session session)
|
| public void | setSourceURL(String url)
|
| public void | setTestSession(Session session)
|
| public void | setView(UsecaseView view)
|
| protected void | startTransaction()
Start a transaction by using a new, modifiable session. |