|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object blackboard.data.BbObject blackboard.data.calendar.CalendarEntry
public class CalendarEntry
The CalendarEntry
class provides a means for defining an event
(system, course, or personal) within the Blackboard application.
Nested Class Summary | |
---|---|
static class |
CalendarEntry.Type
Enumeration of the types of calendar events supported by the Blackboard Calendar tool. |
Field Summary | |
---|---|
static DataType |
CALENDAR_ENTRY_DATA_TYPE
Deprecated. Use the constant DATA_TYPE instead |
static DataType |
DATA_TYPE
Constant used to identify data type |
Fields inherited from class blackboard.data.BbObject |
---|
_bbAttributes |
Constructor Summary | |
---|---|
CalendarEntry()
Creates an instance of CalendarEntry 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 CalendarEntry objects based upon
their course Id value. |
static ListFilter |
createTypeFilter(CalendarEntry.Type type)
Factory method to create an instance of the ListFilter interface
capable of filtering a list of CalendarEntry objects based upon
their CalendarEntry.Type value. |
Id |
getCourseId()
Returns the course Id to which this CalendarEntry
was posted. |
Id |
getCreatorUserId()
Returns the creator user Id associated with this CalendarEntry
. |
DataType |
getDataType()
Returns the DataType identifier for this object. |
FormattedText |
getDescription()
Returns the description of this CalendarEntry . |
java.util.Calendar |
getEndDate()
Returns the date on which this CalendarEntry will/has end(ed). |
java.util.Calendar |
getStartDate()
Returns the date on which this CalendarEntry will/has start(ed). |
java.lang.String |
getTitle()
Returns the title associated with this CalendarEntry . |
CalendarEntry.Type |
getType()
Returns the type value associated with this CalendarEntry . |
Id |
getUserId()
Deprecated. has been replaced by getCreatorUserId() . |
void |
setCourseId(Id iCourseId)
Sets the course Id value for this CalendarEntry . |
void |
setCreatorUserId(Id iCreatorUserId)
Sets the creator user Id value for this CalendarEntry
. |
void |
setDescription(FormattedText desc)
Sets the description of this CalendarEntry . |
void |
setEndDate(java.util.Calendar cEndDate)
Sets the end date for this CalendarEntry . |
void |
setStartDate(java.util.Calendar cStartDate)
Sets the start date for this CalendarEntry . |
void |
setTitle(java.lang.String strTitle)
Sets the title associated with this CalendarEntry . |
void |
setType(CalendarEntry.Type eType)
Sets the type value associated with this CalendarEntry . |
void |
setUserId(Id iUserId)
Deprecated. has been replaced by setCreatorUserId(Id) . |
void |
validate()
Validates the contents of this CalendarEntry . |
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 |
---|
public static final DataType DATA_TYPE
public static final DataType CALENDAR_ENTRY_DATA_TYPE
DATA_TYPE
insteadConstructor Detail |
---|
public CalendarEntry()
CalendarEntry
with default property
values.
Method Detail |
---|
public Id getUserId()
getCreatorUserId()
.
getCreatorUserId()
.
getCreatorUserId()
.
public void setUserId(Id iUserId)
setCreatorUserId(Id)
.
setCreatorUserId(Id)
.
setCreatorUserId(Id)
.
public Id getCreatorUserId()
Id
associated with this CalendarEntry
. This value is the Id
of the user who created this
CalendarEntry
.
Id
value for this calendar entrypublic void setCreatorUserId(Id iCreatorUserId)
Id
value for this CalendarEntry
. This value is the Id
of the user who created this
CalendarEntry
.
CalendarEntry
has to be created by someone. As a result
this is a required field.
iCreatorUserId
- the creator user Id
value to use for this calendar
entrypublic Id getCourseId()
Id
to which this CalendarEntry
was posted.
Id
value for this calendarpublic void setCourseId(Id iCourseId)
Id
value for this CalendarEntry
.
This value should only be set to a valid course id if this calendar entry
is a "course" calendar entry (i.e., the value set in setType(CalendarEntry.Type)
is CalendarEntry.Type.COURSE
). For all other types of calendar
entries this value should be Id.UNSET_ID
.
iCourseId
- the course Id
value to use for this calendarpublic CalendarEntry.Type getType()
CalendarEntry
.
CalendarEntry.Type
CalendarEntry.Type
public void setType(CalendarEntry.Type eType)
CalendarEntry
.
eType
- a valid type value as defined in CalendarEntry.Type
CalendarEntry.Type
public java.util.Calendar getStartDate()
CalendarEntry
will/has start(ed).
The default value for this field is the date this object was created, rounded
to the next whole hour.
Calendar
representing the start date of this calendar entrypublic void setStartDate(java.util.Calendar cStartDate)
CalendarEntry
. Start date is a
required field and must be provided. This fields defaults to a valid value
(see getStartDate()
).
cStartDate
- a Calendar
to use for the start datepublic java.util.Calendar getEndDate()
CalendarEntry
will/has end(ed).
The default value for this field is the start date (see getStartDate()
)
plus one hour.
Calendar
representing the end date of this calendar entrypublic void setEndDate(java.util.Calendar cEndDate)
CalendarEntry
. End date is a
required field and must be provided. This fields defaults to a valid value
(see getEndDate()
).
cEndDate
- a Calendar
to use for the end datepublic java.lang.String getTitle()
CalendarEntry
.
String
public void setTitle(java.lang.String strTitle)
CalendarEntry
.
strTitle
- a String
containing the title for this calendarpublic FormattedText getDescription()
CalendarEntry
.
public void setDescription(FormattedText desc)
CalendarEntry
.
desc
- a FormattedText
containing the description of this calendarpublic 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
CalendarEntry
. 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 CalendarEntry
objects based upon
their course Id value. Should be used with BbList.Iterator
.
targetCourseId
- the Id
of the course for which CalendarEntries
should be returned. CalendarEntries belonging to the given course
(identified by Id) will be returned.
ListFilter
instance that can filter on course Idpublic static final ListFilter createTypeFilter(CalendarEntry.Type type)
ListFilter
interface
capable of filtering a list of CalendarEntry
objects based upon
their CalendarEntry.Type value. Should be used with BbList.Iterator
.
type
- the CalendarEntry.Type
for which CalendarEntries
should be returned.
ListFilter
instance that can filter on the calendar type
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |