|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object blackboard.data.BbObject blackboard.data.announcement.Announcement
public class Announcement
The Announcement
class is a representation of an announcement
within the Blackboard application.
Nested Class Summary | |
---|---|
static class |
Announcement.Type
Enumeration for defining the different kinds of announcement that Blackboard supports. |
Field Summary | |
---|---|
static DataType |
ANNOUNCEMENT_DATA_TYPE
Deprecated. Use the constant DATA_TYPE instead |
static DataType |
DATA_TYPE
|
Fields inherited from class blackboard.data.BbObject |
---|
_bbAttributes |
Constructor Summary | |
---|---|
Announcement()
Creates an instance of Announcement with default property
values. |
Method Summary | |
---|---|
static ListFilter |
createCourseIdFilter(Id targetCourseId)
Factory method to create an instance of the ListFilter interface
capable of filtering a list of Announcement objects based upon
their course Id value. |
Id |
getAsmtId()
Deprecated. This field no longer exists as of Bb6 and should not be used. |
FormattedText |
getBody()
Returns the body of this Announcement . |
Id |
getCourseId()
Returns the course Id to which this Announcement
was posted. |
Id |
getCreatorUserId()
Returns the creator user Id associated with this Announcement
. |
DataType |
getDataType()
Returns the DataType identifier for this object. |
boolean |
getIsPermanent()
Returns whether this Announcement should always be displayed,
regardless of the date it was posted. |
java.util.Calendar |
getModifiedDate()
Deprecated. |
java.util.Calendar |
getRestrictionEndDate()
Returns the date up until which this Announcement should be
made available for viewing within the user interface. |
java.util.Calendar |
getRestrictionStartDate()
Returns the date after which this Announcement should be
made available for viewing within the Blackboard application. |
java.lang.String |
getTitle()
Returns the title associated with this Announcement . |
Announcement.Type |
getType()
Returns the type value associated with this Announcement . |
Id |
getUserId()
Deprecated. Has been replaced by the more aptly named getCreatorUserId() |
void |
setAsmtId(Id iAsmtId)
Deprecated. This field no longer exists as of Bb6 and should not be used. |
void |
setBody(FormattedText body)
Sets the body of this Announcement . |
void |
setCourseId(Id iCourseId)
Sets the course Id value for this Announcement . |
void |
setCreatorUserId(Id iCreatorUserId)
Sets the creator user Id value for this Announcement . |
void |
setIsPermanent(boolean bIsPermanent)
Sets whether this Announcement should always be displayed,
regardless of the date it was posted. |
void |
setModifiedDate(java.util.Calendar cModifiedDate)
Deprecated. |
void |
setRestrictionEndDate(java.util.Calendar cRestrictionEndDate)
Sets the date up until which this Announcement should be made
available for viewing within the user interface. |
void |
setRestrictionStartDate(java.util.Calendar cRestrictionStartDate)
Sets the date after which this Announcement should be made
available for viewing within the user interface. |
void |
setTitle(java.lang.String strTitle)
Sets the title associated with this Announcement . |
void |
setType(Announcement.Type eType)
Sets the type value associated with this Announcement . |
void |
setUserId(Id iUserId)
Deprecated. Has been replaced by the more aptly named setCreatorUserId(Id) . |
void |
validate()
Validates the contents of this Announcement . |
Methods inherited from class blackboard.data.BbObject |
---|
clone, getBbAttributes, getCreatedDate, getId, persist, setCreatedDate, setId, toString |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final DataType DATA_TYPE
public static final DataType ANNOUNCEMENT_DATA_TYPE
DATA_TYPE
insteadConstructor Detail |
---|
public Announcement()
Announcement
with default property
values.
Method Detail |
---|
public java.util.Calendar getModifiedDate()
getModifiedDate
in interface IBbObject
getModifiedDate
in class BbObject
Calendar
representing the modified date of this
BbObject
public void setModifiedDate(java.util.Calendar cModifiedDate)
setModifiedDate
in interface IBbObject
setModifiedDate
in class BbObject
cModifiedDate
- a Calendar
to use for the modified datepublic Id getCourseId()
Id
to which this Announcement
was posted.
Id
value for this announcementpublic void setCourseId(Id iCourseId)
Id
value for this Announcement
.
This value should only be set to a valid course id if this announcement is
a "course" announcement (i.e., the value set in setType(Announcement.Type)
is Announcement.Type.COURSE
). For all other types of announcements
this value should be Id.UNSET_ID
.
iCourseId
- the course Id
value to use for this announcementpublic Id getUserId()
getCreatorUserId()
getCreatorUserId()
.
getCreatorUserId()
.
public void setUserId(Id iUserId)
setCreatorUserId(Id)
.
setCreatorUserId(Id)
.
setCreatorUserId(Id)
.
public Id getCreatorUserId()
Id
associated with this Announcement
. This value is the Id
of the user who created this
Announcement
.
Id
value for this announcementpublic void setCreatorUserId(Id iCreatorUserId)
Id
value for this Announcement
.
This value is the Id
of the user who created this
Announcement
.
iCreatorUserId
- the creator user Id
value to use for this announcementpublic Id getAsmtId()
public void setAsmtId(Id iAsmtId)
public boolean getIsPermanent()
Announcement
should always be displayed,
regardless of the date it was posted.
public void setIsPermanent(boolean bIsPermanent)
Announcement
should always be displayed,
regardless of the date it was posted.
bIsPermanent
- true is this announcement should alwyas be displayed,
false otherwisepublic java.lang.String getTitle()
Announcement
.
String
public void setTitle(java.lang.String strTitle)
Announcement
.
strTitle
- a String
containing the title for this announcementpublic FormattedText getBody()
Announcement
.
public void setBody(FormattedText body)
Announcement
.
body
- a FormattedText
containing the body of this announcementpublic java.util.Calendar getRestrictionStartDate()
Announcement
should be
made available for viewing within the Blackboard application.
Calendar
representing the date after which this announcement
should be made available for viewinggetRestrictionEndDate()
public void setRestrictionStartDate(java.util.Calendar cRestrictionStartDate)
Announcement
should be made
available for viewing within the user interface.
cRestrictionStartDate
- a Calendar
to use for the date after
which this announcement should be available for viewingsetRestrictionEndDate(Calendar)
public java.util.Calendar getRestrictionEndDate()
Announcement
should be
made available for viewing within the user interface.
Calendar
representing the date up until which this announcement
should be made available for viewinggetRestrictionStartDate()
public void setRestrictionEndDate(java.util.Calendar cRestrictionEndDate)
Announcement
should be made
available for viewing within the user interface.
cRestrictionEndDate
- a Calendar
to use for the date up until
which this announcement should be available for viewingsetRestrictionStartDate(Calendar)
public Announcement.Type getType()
Announcement
.
Announcement.Type
Announcement.Type
public void setType(Announcement.Type eType)
Announcement
.
eType
- a valid type value as defined in Announcement.Type
Announcement.Type
public DataType getDataType()
DataType
identifier for this object. Can be used to
uniquely identify the "type" of this data object.
getDataType
in interface IBbObject
getDataType
in class BbObject
DataType
for this objectpublic void validate() throws ValidationException
Announcement
. Internal consistency
checks are also performed.
validate
in interface IBbObject
validate
in class BbObject
ValidationException
- if validation of this object failspublic static final ListFilter createCourseIdFilter(Id targetCourseId)
ListFilter
interface
capable of filtering a list of Announcement
objects based upon
their course Id value. Should be used with BbList.Iterator
.
targetCourseId
- the Id
of the course for which announcements
should be returned. Announcements belonging to the given course
(identified by Id) will be returned.
ListFilter
instance that can filter on course Id
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |