blackboard.ws.gradebook
Class ColumnVO

java.lang.Object
  blackboard.ws.gradebook.ColumnVO

public class ColumnVO
extends java.lang.Object

A ColumnVO represents a single column in the gradebook
(C) Copyright Blackboard Inc. 2007-2008 - All Rights Reserved

Since:

Bb 9.1

Constructor Summary

ColumnVO()

Method Summary

java.lang.String	getAggregationModel()
java.lang.String	getAnalysisUrl()
java.lang.String	getCalculationType()
java.lang.String	getColumnDisplayName() Column name must be the same as the name of the course content (e.g. assignment, assessment) that the Grade Center column is associated to.
java.lang.String	getColumnName()
java.lang.String	getContentId()
java.lang.String	getCourseId()
long	getDateCreated() This is a read-only attribute set by the server.
long	getDateModified() This is a read-only attribute set by the server.
java.lang.String	getDescription()
java.lang.String	getDescriptionType()
long	getDueDate()
java.lang.String[]	getExpansionData()
java.lang.String	getGradebookTypeId()
java.lang.String	getId() The internal id for the column.
int	getMultipleAttempts()
int	getPosition()
double	getPossible()
java.lang.String	getScaleId()
float	getWeight()
boolean	isDeleted() This is a read-only attribute set by the server.
boolean	isExternalGrade() A flag indicating the 'external grade' column (only one is allowed per course).
boolean	isHideAttempt()
boolean	isScorable()
boolean	isShowStatsToStudent()
boolean	isVisible()
boolean	isVisibleInBook()
void	setAggregationModel(java.lang.String aggregationModel)
void	setAnalysisUrl(java.lang.String analysisUrl)
void	setCalculationType(java.lang.String calculationType) For release 9.1, calculated formula is not supported.
void	setColumnDisplayName(java.lang.String columnDisplayName)
void	setColumnName(java.lang.String columnName)
void	setContentId(java.lang.String contentId)
void	setCourseId(java.lang.String courseId)
void	setDateCreated(long datecreated) This is a read-only attribute set by the server.
void	setDateModified(long datemodified) This is a read-only attribute set by the server.
void	setDeleted(boolean deleted) This is a read-only attribute set by the server.
void	setDescription(java.lang.String description)
void	setDescriptionType(java.lang.String descriptionType) Possible values are: "HTML" "PLAIN_TEXT" "SMART_TEXT" If not specified or an invalid value is specified then "SMART_TEXT" is assumed.
void	setDueDate(long duedate)
void	setExpansionData(java.lang.String[] expansionData)
void	setExternalGrade(boolean isExternalGrade) In release 9.1, this is a read-only property.
void	setGradebookTypeId(java.lang.String gradebookTypeId) Note that a gradebookType is currently called a "Category" in the Gradebook user interface.
void	setHideAttempt(boolean hideAttempt)
void	setId(java.lang.String id)
void	setMultipleAttempts(int multipleAttempts)
void	setPosition(int position)
void	setPossible(double possible)
void	setScaleId(java.lang.String scaleId)
void	setScorable(boolean scorable)
void	setShowStatsToStudent(boolean showStatsToStudent)
void	setVisible(boolean visible)
void	setVisibleInBook(boolean visibleInBook)
void	setWeight(float weight)

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnVO

public ColumnVO()

Method Detail

getColumnName

public java.lang.String getColumnName()

Returns:

the constant name for the gradebook column.

setColumnName

public void setColumnName(java.lang.String columnName)

Parameters:

columnName - the internal column name which is a constant regardless of the locale.

isExternalGrade

public boolean isExternalGrade()

A flag indicating the 'external grade' column (only one is allowed per course).

In release 9.1, this is a read-only property. The API for setting this value may be added in future release.

Returns:

a flag to indicate whether this column is set as the "External Grade" column.

setExternalGrade

public void setExternalGrade(boolean isExternalGrade)

In release 9.1, this is a read-only property. The API for setting this value may be added in future release.

Parameters:

isExternalGrade - a flag to indicate whether this column is set as the "External Grade" column.

getId

public java.lang.String getId()

The internal id for the column. Use .getId() to pass into methods requiring a column Id.

setId

public void setId(java.lang.String id)

Parameters:

id - id of the column.

getGradebookTypeId

public java.lang.String getGradebookTypeId()

Returns:

the gradebookType id

setGradebookTypeId

public void setGradebookTypeId(java.lang.String gradebookTypeId)

Note that a gradebookType is currently called a "Category" in the Gradebook user interface. This must be retrieved from a call to the GradebookWS.getGradebookTypes method.

Parameters:

gradebookTypeId - the category id to set

getContentId

public java.lang.String getContentId()

Returns:

the contentId

setContentId

public void setContentId(java.lang.String contentId)

Parameters:

contentId - the contentId to set

getScaleId

public java.lang.String getScaleId()

Returns:

the scaleId

setScaleId

public void setScaleId(java.lang.String scaleId)

Parameters:

scaleId - the scaleId to set

getDescription

public java.lang.String getDescription()

Returns:

the description

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - the description to set

getAnalysisUrl

public java.lang.String getAnalysisUrl()

Returns:

the analysisUrl

setAnalysisUrl

public void setAnalysisUrl(java.lang.String analysisUrl)

Parameters:

analysisUrl - the analysisUrl to set

getDueDate

public long getDueDate()

Returns:

the duedate

setDueDate

public void setDueDate(long duedate)

Parameters:

duedate - the duedate to set (in seconds since unix epoch)

getDateCreated

public long getDateCreated()

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

Returns:

the datecreated

setDateCreated

public void setDateCreated(long datecreated)

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

Parameters:

datecreated - the datecreated to set

getDateModified

public long getDateModified()

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

Returns:

the datemodified

setDateModified

public void setDateModified(long datemodified)

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

Parameters:

datemodified - the datemodified to set

isVisible

public boolean isVisible()

Returns:

the visible

setVisible

public void setVisible(boolean visible)

Parameters:

visible - the visible to set

isScorable

public boolean isScorable()

Returns:

the scorable

setScorable

public void setScorable(boolean scorable)

Parameters:

scorable - the scorable to set

isHideAttempt

public boolean isHideAttempt()

Returns:

the hideAttempt

setHideAttempt

public void setHideAttempt(boolean hideAttempt)

Parameters:

hideAttempt - the hideAttempt to set

isDeleted

public boolean isDeleted()

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

Returns:

the deletedInd

setDeleted

public void setDeleted(boolean deleted)

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

Parameters:

deleted - true if the column has been deleted

getPossible

public double getPossible()

Returns:

the possible

setPossible

public void setPossible(double possible)

Parameters:

possible - the possible to set

getWeight

public float getWeight()

Returns:

the weight

setWeight

public void setWeight(float weight)

Parameters:

weight - the weight to set

getPosition

public int getPosition()

Returns:

the position

setPosition

public void setPosition(int position)

Parameters:

position - the position to set

getMultipleAttempts

public int getMultipleAttempts()

Returns:

the multipleAttempts

setMultipleAttempts

public void setMultipleAttempts(int multipleAttempts)

Parameters:

multipleAttempts - the multipleAttempts to set

getAggregationModel

public java.lang.String getAggregationModel()

Returns:

the aggregationModel

setAggregationModel

public void setAggregationModel(java.lang.String aggregationModel)

Parameters:

aggregationModel - the aggregationModel to set. Possible values include: LAST_AGGREGATION_MODEL, HIGHEST_AGGREGATION_MODEL, LOWEST_AGGREGATION_MODEL, FIRST_AGGREGATION_MODEL, and AVERAGE_AGGREGATION_MODEL.

getCalculationType

public java.lang.String getCalculationType()

Returns:

the calculationType

setCalculationType

public void setCalculationType(java.lang.String calculationType)

For release 9.1, calculated formula is not supported.

Parameters:

calculationType - the calculationType to set. Possible values include: TOTAL_CALC_TYPE, WEIGHTED_TOTAL_CALC_TYPE, NON_CALCULATED_CALC_TYPE, AVERAGE_CALC_TYPE, MINMAX_CALC_TYPE.

getExpansionData

public java.lang.String[] getExpansionData()

Returns:

the expansionData

setExpansionData

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

Parameters:

expansionData - the expansionData to set

getCourseId

public java.lang.String getCourseId()

Returns:

the course id.

setCourseId

public void setCourseId(java.lang.String courseId)

Parameters:

courseId - The id of the course. The course id should be in the form "nnn_1_" where nnn is an integer.

getDescriptionType

public java.lang.String getDescriptionType()

Returns:

the description type.

setDescriptionType

public void setDescriptionType(java.lang.String descriptionType)

Possible values are:

• "HTML"
• "PLAIN_TEXT"
• "SMART_TEXT"

If not specified or an invalid value is specified then "SMART_TEXT" is assumed.

Parameters:

descriptionType - The type of text in description

isVisibleInBook

public boolean isVisibleInBook()

Returns:

whether the column is visible in Grade Center for the instructor.

setVisibleInBook

public void setVisibleInBook(boolean visibleInBook)

Parameters:

visibleInBook - whether the book is visible in Grade Center.

getColumnDisplayName

public java.lang.String getColumnDisplayName()

Column name must be the same as the name of the course content (e.g. assignment, assessment) that the Grade Center column is associated to. However, the the Grade Center column can also have a separate display name that is different.

Returns:

display name for the column in Grade Center.

setColumnDisplayName

public void setColumnDisplayName(java.lang.String columnDisplayName)

Parameters:

columnDisplayName - display name for the column in Grade Center.

isShowStatsToStudent

public boolean isShowStatsToStudent()

Returns:

a flag to indicate whether to show the stats to students

setShowStatsToStudent

public void setShowStatsToStudent(boolean showStatsToStudent)

Parameters:

showStatsToStudent - a flag to indicate whether to show the stats to students