|
Jive Forums API (5.5.20.2-oracle) Web Services Client Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.webservices.Announcement
public class Announcement
Announcments are used to alert users to important information. Announcements belong to either forums, categories, or the system. Each announement has an optional start date and end date; outside of those dates, the announcement will not be displayed to end users.
Each announcement can have an arbitrary number of extended properties, which allow extra data about the announcement to be stored.
Constructor Summary | |
---|---|
Announcement()
|
Method Summary | |
---|---|
int |
getAttachmentCount()
Returns the number of attachments the announcement has. |
java.lang.String |
getBody()
Returns the announcement body. |
long |
getContainerObjectID()
Returns the object ID of the announcement container. |
int |
getContainerObjectType()
Returns the object type of the announcement container. |
java.util.Date |
getEndDate()
Returns the date when the announcement should not longer be visible. |
long |
getID()
Returns the unique ID of the announcement, or -1 if the announcement hasn't been added to the database yet. |
java.util.Date |
getStartDate()
Returns the date when the announcement should first be visible. |
java.lang.String |
getSubject()
Returns the announcement subject. |
User |
getUser()
Returns the User that is the author of the announcemnt. |
void |
setAttachmentCount(int attachmentCount)
|
void |
setBody(java.lang.String body)
Sets the body of this announcement. |
void |
setContainerObjectID(long containerObjectID)
|
void |
setContainerObjectType(int containerObjectType)
|
void |
setEndDate(java.util.Date endDate)
Sets the date when the announcement should not longer be visible. |
void |
setID(long announcementID)
|
void |
setStartDate(java.util.Date startDate)
Sets the start date for when the announcement should first be visible. |
void |
setSubject(java.lang.String subject)
Sets the announcement subject. |
void |
setUser(User user)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Announcement()
Method Detail |
---|
public long getID()
public void setID(long announcementID)
public int getContainerObjectType()
public void setContainerObjectType(int containerObjectType)
public long getContainerObjectID()
public void setContainerObjectID(long containerObjectID)
public User getUser()
public void setUser(User user)
public java.util.Date getStartDate()
public void setStartDate(java.util.Date startDate) throws UnauthorizedException
startDate
- the date the announcement should first be visible.
UnauthorizedException
- if not allowed to set the start date.public java.util.Date getEndDate()
public void setEndDate(java.util.Date endDate) throws UnauthorizedException
endDate
- the date when the announcement is no longer visible.
UnauthorizedException
- if not allowed to set the end date.public java.lang.String getSubject()
public void setSubject(java.lang.String subject) throws UnauthorizedException
subject
- the subject.
UnauthorizedException
- if not allowed to set the subject.public java.lang.String getBody()
public void setBody(java.lang.String body) throws UnauthorizedException
body
- the body.
UnauthorizedException
- if not allowed to set the body.public int getAttachmentCount()
public void setAttachmentCount(int attachmentCount)
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |