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

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> au >> edu >> educationau >> belts >> command >> school >> [ action overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of au.edu.educationau.belts.command.school.action.RemoveSchoolClassUsersAction JAVADOC | Sourc code of au.edu.educationau.belts.command.school.action.RemoveSchoolClassUsersAction SOURCE | Download au.edu.educationau.belts.command.school.action.RemoveSchoolClassUsersAction DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

au.edu.educationau.belts.command.school.action
Class RemoveSchoolClassUsersAction  view RemoveSchoolClassUsersAction download RemoveSchoolClassUsersAction.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.container.AbstractBeltsContainerCommand
              extended byau.edu.educationau.belts.command.AbstractIdCommand
                  extended byau.edu.educationau.belts.command.school.AbstractSchoolClassCommand
                      extended byau.edu.educationau.belts.command.school.action.RemoveSchoolClassUsersAction
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 RemoveSchoolClassUsersAction
extends au.edu.educationau.belts.command.school.AbstractSchoolClassCommand
implements au.edu.educationau.belts.command.Action

This class performs the action of creating a SchoolClass, based on the minimal information required for a class.

Required Roles:

A person creating a class must be a belts:school-administrator

Required Parameters:

id
the id for the class

Outcomes

OK
the class was updated OK
ERROR
an error occurred during class creation
VALIDATION
a validation error occurred

The following errors may occur during class creation:

Duplicate Class
a class with that id already exists
Not Allowed to Remove Users from Classes
the current user is not allowed to remove users from classes

Results

No results are returned from this action.

Version:
$Revision: 1.6 $ - $Date: 2003/02/28 06:48:02 $

Field Summary
private  java.lang.String[] _users
           
static java.lang.String USERS
           
 
Fields inherited from class au.edu.educationau.belts.command.AbstractIdCommand
_id, ID
 
Fields inherited from class au.edu.educationau.belts.command.container.AbstractBeltsContainerCommand
_log
 
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
RemoveSchoolClassUsersAction()
           
 
Method Summary
 void execute()
          Removes users from a class.
 void setUsers(java.lang.String[] users)
          Sets the users.
 boolean validate()
          Ensures that the appropriate fields are non empty Strings
 
Methods inherited from class au.edu.educationau.belts.command.school.AbstractSchoolClassCommand
userHasPermission, userHasPermission
 
Methods inherited from class au.edu.educationau.belts.command.AbstractIdCommand
setId
 
Methods inherited from class au.edu.educationau.belts.command.container.AbstractBeltsContainerCommand
beltsContainer, currentUser, currentUserIsMemberOfSchool, currentUsersSchool, isManager, isPermitted, isTeacher, permitted
 
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

USERS

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

_users

private java.lang.String[] _users
Constructor Detail

RemoveSchoolClassUsersAction

public RemoveSchoolClassUsersAction()
Method Detail

validate

public boolean validate()
Ensures that the appropriate fields are non empty Strings

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

execute

public void execute()
Removes users from a class.

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

setUsers

public void setUsers(java.lang.String[] users)
Sets the users.

Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> au >> edu >> educationau >> belts >> command >> school >> [ action overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of au.edu.educationau.belts.command.school.action.RemoveSchoolClassUsersAction JAVADOC | Sourc code of au.edu.educationau.belts.command.school.action.RemoveSchoolClassUsersAction SOURCE | Download au.edu.educationau.belts.command.school.action.RemoveSchoolClassUsersAction DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD