Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

au.edu.educationau.belts.command.lesson.action
Class UpdateLessonItemAction  view UpdateLessonItemAction download UpdateLessonItemAction.java

java.lang.Object
  extended byau.edu.educationau.belts.command.AbstractCommand
      extended byau.edu.educationau.belts.command.container.AbstractContainerCommand
          extended byau.edu.educationau.belts.command.lesson.AbstractLessonItemCommand
              extended byau.edu.educationau.belts.command.lesson.action.UpdateLessonItemAction
All Implemented Interfaces:
au.edu.educationau.belts.command.Action, au.edu.educationau.belts.command.Command, au.edu.educationau.belts.container.Containable, java.io.Serializable

public class UpdateLessonItemAction
extends au.edu.educationau.belts.command.lesson.AbstractLessonItemCommand
implements au.edu.educationau.belts.command.Action

This class performs the action of updating a Lesson Item

Required Parameters:

id
the id of the lesson item to update
instructions
the instructions for this lesson item

Outcomes

OK
the lesson item was updated OK
ERROR
an error occurred during lesson item update
VALIDATION
a validation error occurred

The following errors may occur during lesson item update:

Lesson Item Not Found
a lesson item with that id was not found
Not Allowed to update Lesson Items
the current user is not allowed to update lesson items

Results

No results are returned from this action.

Version:
$Revision: 1.7 $ - $Date: 2003/05/12 06:35:42 $

Field Summary
private  java.lang.String _instructions
           
private  java.lang.String _name
           
static java.lang.String INSTRUCTIONS
           
static java.lang.String NAME
           
 
Fields inherited from class au.edu.educationau.belts.command.lesson.AbstractLessonItemCommand
_lesson, _position, LESSON, POSITION
 
Fields inherited from class au.edu.educationau.belts.command.container.AbstractContainerCommand
 
Fields inherited from class au.edu.educationau.belts.command.AbstractCommand
_outcome, _result, ENTITY_NOT_FOUND_ERROR, SECURITY_ERROR, SYSTEM_ERROR, VALIDATION_ERROR
 
Constructor Summary
UpdateLessonItemAction()
           
 
Method Summary
 void execute()
          Execute the command.
 void setInstructions(java.lang.String instructions)
          Sets the instructions.
 void setName(java.lang.String name)
          Sets the name.
 boolean validate()
          Validate checks to ensure that the parameters required to execute the Command have been correctly set.
 
Methods inherited from class au.edu.educationau.belts.command.lesson.AbstractLessonItemCommand
setLesson, setPosition
 
Methods inherited from class au.edu.educationau.belts.command.container.AbstractContainerCommand
container, dispatchEvent, hasContainer, prepare, release
 
Methods inherited from class au.edu.educationau.belts.command.AbstractCommand
addDuplicateEntityFoundError, addEmailFieldValidationError, addEntityNotFoundError, addError, addError, addError, addFieldValidationError, addIdValidationError, addSecurityError, addSystemError, addValidationError, addWarning, result
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface au.edu.educationau.belts.command.Command
result
 

Field Detail

INSTRUCTIONS

public static final java.lang.String INSTRUCTIONS
See Also:
Constant Field Values

_instructions

private java.lang.String _instructions

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values

_name

private java.lang.String _name
Constructor Detail

UpdateLessonItemAction

public UpdateLessonItemAction()
Method Detail

validate

public boolean validate()
Description copied from interface: au.edu.educationau.belts.command.Command

Validate checks to ensure that the parameters required to execute the Command have been correctly set.

WARNING - you should only check the Command objects internal structure, and not attempt to call external services as these may not be available to the object.

Specified by:
validate in interface au.edu.educationau.belts.command.Command

execute

public void execute()
Description copied from interface: au.edu.educationau.belts.command.Command

Execute the command. The dispatcher is responsible for ensuring that the commands validate method is called before the command is executed.

Specified by:
execute in interface au.edu.educationau.belts.command.Command

setInstructions

public void setInstructions(java.lang.String instructions)
Sets the instructions.


setName

public void setName(java.lang.String name)
Sets the name.