blackboard.data.course
Class GroupMembership

java.lang.Object
  blackboard.data.BbObject
      blackboard.data.course.GroupMembership

All Implemented Interfaces:

IBbObject, Identifiable, java.lang.Cloneable

public class GroupMembership
extends BbObject

The GroupMembership class is a representation of a group membership record within the Blackboard application. A group membership record defines a user's inclusion in a particular group.

Since:

Bb 6.0

Version:

$Revision: #1 $ $Date: 2007/06/27 $

Field Summary

static DataType

DATA_TYPE

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

GroupMembership()
Creates an instance of GroupMembership with default property values.

Method Summary

Id	getCourseMembershipId() Returns the course membership Id associated with this GroupMembership.
DataType	getDataType() Returns the DataType identifier for this object.
Id	getGroupId() Returns the group Id associated with this GroupMembership.
void	setCourseMembershipId(Id iCourseMembershipId) Sets the course membership Id value for this GroupMembership.
void	setGroupId(Id iGroupId) Sets the group Id value for this GroupMembership.
void	validate() Validates the contents of this GroupMembership.

Methods inherited from class blackboard.data.BbObject

clone, getBbAttributes, getCreatedDate, getId, getModifiedDate, persist, setCreatedDate, setId, setModifiedDate, toString

Methods inherited from class java.lang.Object

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

Field Detail

DATA_TYPE

public static final DataType DATA_TYPE

Constructor Detail

GroupMembership

public GroupMembership()

Creates an instance of GroupMembership with default property values.

Method Detail

getGroupId

public Id getGroupId()

Returns the group Id associated with this GroupMembership.

Returns:

group Id value for this group membership

setGroupId

public void setGroupId(Id iGroupId)

Sets the group Id value for this GroupMembership.

Parameters:

iGroupId - the group Id value to use for this group membership

getCourseMembershipId

public Id getCourseMembershipId()

Returns the course membership Id associated with this GroupMembership.

Returns:

course membership Id value for this group membership

setCourseMembershipId

public void setCourseMembershipId(Id iCourseMembershipId)

Sets the course membership Id value for this GroupMembership.

Parameters:

iCourseMembershipId - the course membserhip Id value to use for this group membership

getDataType

public DataType getDataType()

Returns the DataType identifier for this object. Can be used to uniquely identify the "type" of this data object.

Specified by:

getDataType in interface IBbObject

Specified by:

getDataType in interface Identifiable

Specified by:

getDataType in class BbObject

Returns:

the DataType for this object

validate

public void validate()
              throws ValidationException

Validates the contents of this GroupMembership. Internal consistency checks are also performed.

Specified by:

validate in interface IBbObject

Overrides:

validate in class BbObject

Throws:

ValidationException - if validation of this object fails