blackboard.ws.gradebook
Class ColumnFilter

java.lang.Object
  blackboard.ws.gradebook.ColumnFilter

public class ColumnFilter
extends java.lang.Object

This filter can be used to restrict the number of columns you get back in the getGradebookColumns method. It is also used by the ScoreFilter to restrict the number of columns you get back from the getGradesXXX methods. Refer to the various uses of this class for more details on how you would use it (i.e. use depends on method)
(C) Copyright Blackboard Inc. 2007-2008 - All Rights Reserved

Since:

Bb 9.1

Constructor Summary

ColumnFilter()

Method Summary

java.lang.String	firstId() Id of the first column.
java.lang.String	firstName() Title of the first column.
java.lang.String[]	getExpansionData()
int	getFilterType() The filter type.
java.lang.String[]	getIds()
java.lang.String[]	getNames()
boolean	isExternalGrade()
void	setExpansionData(java.lang.String[] expansionData) Expansion data is currently ignored.
void	setExternalGrade(boolean externalGrade)
void	setFilterType(int filterType) This is one of the defined types in this class.
void	setIds(java.lang.String[] ids)
void	setNames(java.lang.String[] names)

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnFilter

public ColumnFilter()

Method Detail

firstName

public java.lang.String firstName()

Title of the first column. Used when only 1 column is expected by the filter type.

Returns:

the name

getIds

public java.lang.String[] getIds()

Returns:

array of column ids

setIds

public void setIds(java.lang.String[] ids)

Parameters:

ids - array of column ids

getNames

public java.lang.String[] getNames()

Returns:

array of column titles

setNames

public void setNames(java.lang.String[] names)

Parameters:

names - array of column titles

firstId

public java.lang.String firstId()

Id of the first column. Used when only 1 column is expected by the filter type.

Returns:

the id

getFilterType

public int getFilterType()

The filter type.

Returns:

filter type.

setFilterType

public void setFilterType(int filterType)

This is one of the defined types in this class. When using this object to retrieve data, please ensure that both the filter type and the relevant data fields associated to the specified filter type are set before calling the API with this object. For example, if the filter type is 2, i.e. get by course id and name, please ensure that the filter type, course id, and name are set. Possible values include:

• GET_COLUMN_BY_COURSE_ID
• GET_COLUMN_BY_COURSE_ID_AND_COLUMN_NAME
• GET_COLUMN_BY_IDS
• GET_COLUMN_BY_EXTERNAL_GRADE_FLAG

Parameters:

filterType - one of the predefined filter type

isExternalGrade

public boolean isExternalGrade()

Returns:

flag which indicates whether the column is selected as "External Grade".

setExternalGrade

public void setExternalGrade(boolean externalGrade)

Parameters:

externalGrade - flag to indicates whether the column is selected as "External Grade".

getExpansionData

public java.lang.String[] getExpansionData()

Returns:

the expansionData

setExpansionData

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

Expansion data is currently ignored. In future versions it may be used to add additional attributes without breaking the wsdl contract.

Parameters:

expansionData - the expansionData to set (For Future Use)