blackboard.ws.gradebook
Class GradebookTypeFilter

java.lang.Object
  blackboard.ws.gradebook.GradebookTypeFilter

public class GradebookTypeFilter
extends java.lang.Object

This filter can be used to query for the gradebook type(s) in a course. The filter will match any item that matches the given filterType value A null/empty string array for attribute id is ignored, no schema(s) are loaded for this value in the given course A null/empty string attribute title is ignored, no gradebook type(s) are loaded for this value in the given course An invalid string value in the attribute array, that does not exist in the system is ignored, no error generated
(C) Copyright Blackboard Inc. 2007-2008 - All Rights Reserved

Since:

Bb 9.1

Constructor Summary

GradebookTypeFilter()

Method Summary

java.lang.String[]	getExpansionData()
int	getFilterType()
java.lang.String[]	getIds()
java.lang.String	getTitle()
void	setExpansionData(java.lang.String[] expansionData) Expansion data is currently ignored.
void	setFilterType(int filterType) This is one of the defined types in this class.
void	setIds(java.lang.String[] ids)
void	setTitle(java.lang.String title)

Methods inherited from class java.lang.Object

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

Constructor Detail

GradebookTypeFilter

public GradebookTypeFilter()

Method Detail

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 to set.

getIds

public java.lang.String[] getIds()

Returns:

ids of attempts

setIds

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

Parameters:

ids - ids of attempts

getFilterType

public int getFilterType()

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_GRADEBOOK_TYPE_BY_ID, please ensure that the filter type and id are set. Possible Values are:

• GET_GRADEBOOK_TYPE_BY_ID
• GET_GRADEBOOK_TYPE_BY_COURSE_ID
• GET_GRADEBOOK_TYPE_BY_COURSE_ID_AND_TITLE

Parameters:

filterType - one of the predefined filter type

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)