steve.pums.assess.bus
Class Category

java.lang.Object
  extended by org.apache.struts.action.ActionForm
      extended by steve.pums.assess.bus.Category
All Implemented Interfaces:
java.io.Serializable

public class Category
extends org.apache.struts.action.ActionForm

Represents a mark category within the project mark form

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.struts.action.ActionForm
multipartRequestHandler, servlet
 
Constructor Summary
Category()
          Creates a new instance of SPCategory
Category(int categoryID, java.lang.String name, java.lang.String longName, java.lang.String description, java.lang.String optional, java.lang.String optionType, int optionGroup, int weight)
          Creates a new instance of SPCategory with values assigned
 
Method Summary
 void addCategoryOption(Option opt)
          Adds a new option to the category
 int getCategoryID()
          Getter for category ID
 java.util.Vector getCategoryOptions()
          Getter for category options
 java.lang.String getComments()
          Getter for category comments
 java.lang.String getDescription()
          Getter for category description
 java.lang.String getLongName()
          Getter for category long name
 int getMark()
          Getter for category mark
 java.lang.String getName()
          Getter for category name
 int getOptCount()
          Counts the number of available options
 int getOptionGroup()
          Getter for category option group
 int[] getOptionsSelected()
          Getter for selected category options
 java.lang.String getOptionType()
          Getter for category option type
 int getWeight()
          Getter for category weight
 boolean isOptional()
          Getter for category optional
 void setCategoryID(int categoryID)
          Setter for category ID
 void setCategoryOptions(java.util.Vector categoryOptions)
          Setter for category options
 void setComments(java.lang.String comments)
          Setter for category comments
 void setDescription(java.lang.String description)
          Setter for category description
 void setLongName(java.lang.String longName)
          Setter for category long name
 void setName(java.lang.String name)
          Setter for category name
 void setOptional(boolean optional)
          Setter for category optional
 void setOptional(java.lang.String optional)
          Setter for category optional
 void setOptionGroup(int optionGroup)
          Setter for category option group
 void setOptionsSelected(int[] optionsSelected)
          Setter for options selected in category
 void setOptionType(java.lang.String optionType)
          Setter for category option type
 void setWeight(int weight)
          Setter for category weight
 org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping actionMapping, javax.servlet.http.HttpServletRequest httpServletRequest)
          Validates the category during submission of the mark form
 
Methods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServlet, getServletWrapper, reset, reset, setMultipartRequestHandler, setServlet, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Category

public Category()
Creates a new instance of SPCategory


Category

public Category(int categoryID,
                java.lang.String name,
                java.lang.String longName,
                java.lang.String description,
                java.lang.String optional,
                java.lang.String optionType,
                int optionGroup,
                int weight)
Creates a new instance of SPCategory with values assigned

Parameters:
categoryID - Unique ID of category
name - Name of category
longName - Long name of category
description - Descrpition of category
optional - Indicates if category is optional
optionType - Inidicates option type
optionGroup - Inidicates the group of options
weight - Category weight in the mark process
Method Detail

getName

public java.lang.String getName()
Getter for category name

Returns:
Category name

setName

public void setName(java.lang.String name)
Setter for category name

Parameters:
name - Category name

getLongName

public java.lang.String getLongName()
Getter for category long name

Returns:
Category long name

setLongName

public void setLongName(java.lang.String longName)
Setter for category long name

Parameters:
longName - Category long name

getDescription

public java.lang.String getDescription()
Getter for category description

Returns:
Category name

setDescription

public void setDescription(java.lang.String description)
Setter for category description

Parameters:
description - Category description

isOptional

public boolean isOptional()
Getter for category optional

Returns:
If category is optional or not

setOptional

public void setOptional(boolean optional)
Setter for category optional

Parameters:
optional - Boolean optional

setOptional

public void setOptional(java.lang.String optional)
Setter for category optional

Parameters:
optional - String optional

getOptionType

public java.lang.String getOptionType()
Getter for category option type

Returns:
Category option type

setOptionType

public void setOptionType(java.lang.String optionType)
Setter for category option type

Parameters:
optionType - Category option type

getOptionGroup

public int getOptionGroup()
Getter for category option group

Returns:
Category option group

addCategoryOption

public void addCategoryOption(Option opt)
Adds a new option to the category

Parameters:
opt - New option

getWeight

public int getWeight()
Getter for category weight

Returns:
Category weight

setWeight

public void setWeight(int weight)
Setter for category weight

Parameters:
weight - Weight of category

getComments

public java.lang.String getComments()
Getter for category comments

Returns:
Category comments

setComments

public void setComments(java.lang.String comments)
Setter for category comments

Parameters:
comments - Category comments

getCategoryID

public int getCategoryID()
Getter for category ID

Returns:
Category ID

setCategoryID

public void setCategoryID(int categoryID)
Setter for category ID

Parameters:
categoryID - Category ID

validate

public org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping actionMapping,
                                                      javax.servlet.http.HttpServletRequest httpServletRequest)
Validates the category during submission of the mark form

Overrides:
validate in class org.apache.struts.action.ActionForm
Parameters:
actionMapping - Action Mapping
httpServletRequest - Servlet request
Returns:
Errors identified from validation

getCategoryOptions

public java.util.Vector getCategoryOptions()
Getter for category options

Returns:
Category options

setCategoryOptions

public void setCategoryOptions(java.util.Vector categoryOptions)
Setter for category options

Parameters:
categoryOptions - Category options

setOptionGroup

public void setOptionGroup(int optionGroup)
Setter for category option group

Parameters:
optionGroup - Category option group

getOptionsSelected

public int[] getOptionsSelected()
Getter for selected category options

Returns:
Selected category options

setOptionsSelected

public void setOptionsSelected(int[] optionsSelected)
Setter for options selected in category

Parameters:
optionsSelected - Array of selected options

getOptCount

public int getOptCount()
Counts the number of available options

Returns:
The count of options

getMark

public int getMark()
            throws java.lang.Exception
Getter for category mark

Returns:
Mark awarded for category
Throws:
java.lang.Exception - In the event of lang error