blackboard.ws.announcement
Class AnnouncementVO

java.lang.Object
  blackboard.ws.announcement.AnnouncementVO

public class AnnouncementVO
extends java.lang.Object

AnnouncementVO represents the Announcement data object in the Academic Suite.

Since:

Bb 9.1

Constructor Summary

AnnouncementVO()

Method Summary

java.lang.String	getBody()
java.lang.String	getCourseId()
java.lang.String	getCreatorUserId()
java.lang.String[]	getExpansionData()
java.lang.String	getId()
int	getPosition()
long	getRestrictionEndDate()
long	getRestrictionStartDate()
java.lang.String	getTitle()
java.lang.String	getTitleColor()
java.lang.String	getType()
boolean	isPermanent()
boolean	isPushNotify()
boolean	isShowOnCourses()
boolean	isShowOnLogin()
void	setBody(java.lang.String body) The body must be properly formatted HTML content.
void	setCourseId(java.lang.String courseId) Use this method for Course and Organization announcements only.
void	setCreatorUserId(java.lang.String creatorUserId) This is a read-only field. userId in session will override the value set by this method and be used as creatorUserId in case of login via user Authentication For tool based login, the specified value is used, but ONLY if the tool has also registered that it will be calling the ContextWS.emulateUser method.
void	setExpansionData(java.lang.String[] expansionData) Expansion data is currently ignored.
void	setId(java.lang.String id) Valid id must be provided for update.
void	setPermanent(boolean isPermanent) Determines if an announcement should always be displayed with no date restriction
void	setPosition(int position) Min. value of position is 1.
void	setPushNotify(boolean pushNotify) Determines if an email should be sent to all users even those that choose not to receive Announcement notifications through email.
void	setRestrictionEndDate(long endDate) The date on which an available announcement should become unavailable and stop being displayed.
void	setRestrictionStartDate(long startDate) The date in which an announcement should become available and start to be displayed.
void	setShowOnCourses(boolean showOnCourses) Determines if system announcement should also appear on course/org announcement page
void	setShowOnLogin(boolean showOnLogin) Determines if an announcement appears on log in page
void	setTitle(java.lang.String title) The title will be displayed as the heading of an announcement
void	setTitleColor(java.lang.String titleColor) Sets the color of announcement title.
void	setType(java.lang.String type) This is a read-only field.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnouncementVO

public AnnouncementVO()

Method Detail

getCourseId

public java.lang.String getCourseId()

Returns:

the courseId of an announcement

setCourseId

public void setCourseId(java.lang.String courseId)

Use this method for Course and Organization announcements only. For new announcements, the value of CourseIdVO parameter passed in to create/ update methods will override the value set by this method and be used instead. When updating the existing ones, the value set by this method will be compared to CourseIdVO parameter and an error will occur when they do not match.

Parameters:

courseId - The id of the course/organization an announcement belongs to. The course id should be in the form "nnn_1_" where nnn is an integer.

getCreatorUserId

public java.lang.String getCreatorUserId()

Returns:

the announcement creator's id

setCreatorUserId

public void setCreatorUserId(java.lang.String creatorUserId)

This is a read-only field. userId in session will override the value set by this method and be used as creatorUserId in case of login via user Authentication For tool based login, the specified value is used, but ONLY if the tool has also registered that it will be calling the ContextWS.emulateUser method. It does not actually have to call that method and emulate the user to set the creator id - it just has to have the appropriate permissions to call it.

Parameters:

creatorUserId - the announcement creator's id

getTitle

public java.lang.String getTitle()

Returns:

the title of an announcement

setTitle

public void setTitle(java.lang.String title)

The title will be displayed as the heading of an announcement

Parameters:

title - the title of an announcement

getBody

public java.lang.String getBody()

Returns:

the body content of an announcement

setBody

public void setBody(java.lang.String body)

The body must be properly formatted HTML content.

Parameters:

body - the body content of an announcement

getRestrictionStartDate

public long getRestrictionStartDate()

Returns:

the date on which an announcement becomes available

setRestrictionStartDate

public void setRestrictionStartDate(long startDate)

The date in which an announcement should become available and start to be displayed. If left unset, time at the creation will be used and the announcement will be available immediately.

Parameters:

startDate - the date on which an announcement becomes available

getRestrictionEndDate

public long getRestrictionEndDate()

Returns:

the date on which an announcement becomes unavailable

setRestrictionEndDate

public void setRestrictionEndDate(long endDate)

The date on which an available announcement should become unavailable and stop being displayed. If left unset, the announcement will be available indefinitely.

Parameters:

endDate - the date on which an announcement becomes unavailable

isPermanent

public boolean isPermanent()

Returns:

true if an announcement has no date restriction

setPermanent

public void setPermanent(boolean isPermanent)

Determines if an announcement should always be displayed with no date restriction

Parameters:

isPermanent - if an announcement has no date restriction

getType

public java.lang.String getType()

Returns:

the type of an announcement

setType

public void setType(java.lang.String type)

This is a read-only field. When saving, If a valid id is set to courseId field, the type will be automatically set to "blackboard.data.announcement.Announcement$Type:COURSE" Otherwise, "blackboard.data.announcement.Announcement$Type:SYSTEM".

Parameters:

type - the type of an announcement - COURSE or SYSTEM

isShowOnLogin

public boolean isShowOnLogin()

Returns:

true if an announcement is set to appear on log in page

setShowOnLogin

public void setShowOnLogin(boolean showOnLogin)

Determines if an announcement appears on log in page

Parameters:

showOnLogin - if an announcement should appear on log in page

isShowOnCourses

public boolean isShowOnCourses()

Returns:

true if system announcement should also appear on course/org announcement page

setShowOnCourses

public void setShowOnCourses(boolean showOnCourses)

Determines if system announcement should also appear on course/org announcement page

isPushNotify

public boolean isPushNotify()

Returns:

true if an email should be sent to all users

setPushNotify

public void setPushNotify(boolean pushNotify)

Determines if an email should be sent to all users even those that choose not to receive Announcement notifications through email.

Parameters:

pushNotify - if an email should be sent to all users

getPosition

public int getPosition()

Returns:

the order of an announcement in the announcement list

setPosition

public void setPosition(int position)

Min. value of position is 1. If unset or invalid, the announcement will be placed on top of the list.

Parameters:

position - the order of an announcement in the announcement list

getTitleColor

public java.lang.String getTitleColor()

setTitleColor

public void setTitleColor(java.lang.String titleColor)

Sets the color of announcement title. If left unset or if set to any invalid value then the system default color will be used.

Parameters:

titleColor - a String containing the title color for an announcement. The color value should by a RGB color value as used in HTML pages (#RRGGBB -- for example, #000000 will display black).

getId

public java.lang.String getId()

Returns:

the id

setId

public void setId(java.lang.String id)

Valid id must be provided for update. When creating new announcements, id can be left unset or set to be null.

Parameters:

id - the id of an announcement

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)