blackboard.ws.gradebook
Class GradebookTypeVO

java.lang.Object
  blackboard.ws.gradebook.GradebookTypeVO

public class GradebookTypeVO
extends java.lang.Object

A GradebookTypeVO contains definition for a gradebook column type in a particular course.
(C) Copyright Blackboard Inc. 2007-2008 - All Rights Reserved

Since:

Bb 9.1

Constructor Summary

GradebookTypeVO()

Method Summary

java.lang.String	getCourseId()
java.lang.String	getDescription()
java.lang.String	getDisplayedDescription() This is a localized description text derived based on gradebook type data loaded from database, i.e. this data is not persisted to database.
java.lang.String	getDisplayedTitle() This is a localized title derived based on gradebook type data loaded from database, i.e. this data is not persisted to database.
java.lang.String[]	getExpansionData()
java.lang.String	getId()
java.lang.String	getTitle()
float	getWeight()
boolean	isCalculated()
boolean	isScorable()
boolean	isUserDefined() This is a read-only attribute set by the server.
void	setCalculated(boolean calculated) AS does not allow update of this field value.
void	setCourseId(java.lang.String courseId) This is a read-only attribute set by the server.
void	setDescription(java.lang.String description)
void	setDisplayedDescription(java.lang.String displayedDescription) This is a localized description text derived based on gradebook type data loaded from database, i.e. this data is not persisted to database.
void	setDisplayedTitle(java.lang.String displayedTitle) This is a localized title derived based on gradebook type data loaded from database, i.e. this data is not persisted to database.
void	setExpansionData(java.lang.String[] xexpansionData)
void	setId(java.lang.String id)
void	setScorable(boolean scorable) AS does not allow update of this field value.
void	setTitle(java.lang.String title)
void	setUserDefined(boolean userDefined) This value is default set to true.
void	setWeight(float weight)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GradebookTypeVO

public GradebookTypeVO()

Method Detail

isCalculated

public boolean isCalculated()

Returns:

is calculated flag

setCalculated

public void setCalculated(boolean calculated)

AS does not allow update of this field value. Once created this value is final

Parameters:

calculated - is calculated flag.

getCourseId

public java.lang.String getCourseId()

Returns:

course id

setCourseId

public void setCourseId(java.lang.String courseId)

This is a read-only attribute set by the server.

Parameters:

courseId - course id

getDescription

public java.lang.String getDescription()

Returns:

description

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - description to set.

getExpansionData

public java.lang.String[] getExpansionData()

Returns:

expansion data

setExpansionData

public void setExpansionData(java.lang.String[] xexpansionData)

Parameters:

xexpansionData - expansion data to set

getId

public java.lang.String getId()

Returns:

id of the gradebook type.

setId

public void setId(java.lang.String id)

Parameters:

id - id of the gradebook type.

isScorable

public boolean isScorable()

Returns:

flag to indicate whether it's scorable.

setScorable

public void setScorable(boolean scorable)

AS does not allow update of this field value. Once created this value is final

Parameters:

scorable - flag for scorable

getTitle

public java.lang.String getTitle()

Returns:

title of the gradebook type.

setTitle

public void setTitle(java.lang.String title)

Parameters:

title - title of the gradebook type.

isUserDefined

public boolean isUserDefined()

This is a read-only attribute set by the server.

Returns:

whether it's user defined.

setUserDefined

public void setUserDefined(boolean userDefined)

This value is default set to true. This is a read only attribute set by the server.

Parameters:

userDefined - flag to indicate whether it's user defined.

getWeight

public float getWeight()

Returns:

weight of the gradebook type.

setWeight

public void setWeight(float weight)

Parameters:

weight - weight of the gradebook type.

getDisplayedDescription

public java.lang.String getDisplayedDescription()

This is a localized description text derived based on gradebook type data loaded from database, i.e. this data is not persisted to database. It's derived by the server when getting gradebook data and then returned to the WS client.

Returns:

localized description for the gradebook type.

setDisplayedDescription

public void setDisplayedDescription(java.lang.String displayedDescription)

This is a localized description text derived based on gradebook type data loaded from database, i.e. this data is not persisted to database. It's derived by the server when getting gradebook data and then returned to the WS client. As such, this set method should only be called by the server to return information back to the WS client.

Parameters:

displayedDescription - localized description for the gradebook type.

getDisplayedTitle

public java.lang.String getDisplayedTitle()

This is a localized title derived based on gradebook type data loaded from database, i.e. this data is not persisted to database. It's derived by the server when getting gradebook data and then returned to the WS client.

Returns:

localized title for the gradebook type.

setDisplayedTitle

public void setDisplayedTitle(java.lang.String displayedTitle)

This is a localized title derived based on gradebook type data loaded from database, i.e. this data is not persisted to database. It's derived by the server when getting gradebook data and then returned to the WS client. As such, this set method should only be called by the server to return information back to the WS client.

Parameters:

displayedTitle - localized title for the gradebook type.