Announcement (Announcements Portlet 2.5.0 API)

java.lang.Object
- org.jasig.portlet.announcements.model.Announcement

All Implemented Interfaces:

Comparable<Announcement>
```
public class Announcement
extends Object
implements Comparable<Announcement>
```
Announcement class.

Version:

$Id: $Id

Author:

Erik A. Olsson (eolsson@uci.edu)

Field Summary

Fields
Modifier and Type Field and Description

static long MILLISECONDS_IN_A_YEAR
Useful for announcements with open-ended display periods.

Fields
Modifier and Type	Field and Description
`static long`	`MILLISECONDS_IN_A_YEAR` Useful for announcements with open-ended display periods.

Constructor Summary

Constructors
Constructor and Description

Announcement()

Constructors
Constructor and Description
`Announcement()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Announcement otherAnn)` compareTo.
`boolean`	`equals(Object obj)`
`String`	`getAbstractText()` Getter for the field `abstractText`.
`Set<String>`	`getAttachments()` Getter for the field `attachments`.
`String`	`getAuthor()` Getter for the field `author`.
`Date`	`getCreated()` Getter for the field `created`.
`Date`	`getEndDisplay()` Getter for the field `endDisplay`.
`Long`	`getId()` Getter for the field `id`.
`String`	`getLink()` Getter for the field `link`.
`String`	`getMessage()` Getter for the field `message`.
`Date`	`getNullSafeEndDisplay()` getNullSafeEndDisplay.
`Topic`	`getParent()` Getter for the field `parent`.
`Boolean`	`getPublished()` Getter for the field `published`.
`Date`	`getStartDisplay()` Getter for the field `startDisplay`.
`String`	`getTitle()` Getter for the field `title`.
`int`	`hashCode()`
`boolean`	`hasId()` hasId.
`void`	`setAbstractText(String abstractText)` Setter for the field `abstractText`.
`void`	`setAttachments(Set<String> attachments)` Setter for the field `attachments`.
`void`	`setAuthor(String author)` Setter for the field `author`.
`void`	`setCreated(Date created)` Setter for the field `created`.
`void`	`setEndDisplay(Date endDisplay)` Setter for the field `endDisplay`.
`void`	`setId(Long id)` Setter for the field `id`.
`void`	`setLink(String link)` Setter for the field `link`.
`void`	`setMessage(String message)` Setter for the field `message`.
`void`	`setParent(Topic parent)` Setter for the field `parent`.
`void`	`setPublished(Boolean published)` Setter for the field `published`.
`void`	`setStartDisplay(Date startDisplay)` Setter for the field `startDisplay`.
`void`	`setTitle(String title)` Setter for the field `title`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MILLISECONDS_IN_A_YEAR
```
public static final long MILLISECONDS_IN_A_YEAR
```
    Useful for announcements with open-ended display periods.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Announcement
```
public Announcement()
```
- Method Detail
  - getPublished
```
public Boolean getPublished()
```
    Getter for the field published.
    
    Returns:
    
    a Boolean object.
  - setPublished
```
public void setPublished(Boolean published)
```
    Setter for the field published.
    
    Parameters:
    
    published - a Boolean object.
  - hasId
```
public boolean hasId()
```
    hasId.
    
    Returns:
    
    a boolean.
  - getId
```
public Long getId()
```
    Getter for the field id.
    
    Returns:
    
    a Long object.
  - setId
```
public void setId(Long id)
```
    Setter for the field id.
    
    Parameters:
    
    id - a Long object.
  - getParent
```
public Topic getParent()
```
    Getter for the field parent.
    
    Returns:
    
    a Topic object.
  - setParent
```
public void setParent(Topic parent)
```
    Setter for the field parent.
    
    Parameters:
    
    parent - a Topic object.
  - getTitle
```
public String getTitle()
```
    Getter for the field title.
    
    Returns:
    
    a String object.
  - getCreated
```
public Date getCreated()
```
    Getter for the field created.
    
    Returns:
    
    a Date object.
  - getStartDisplay
```
public Date getStartDisplay()
```
    Getter for the field startDisplay.
    
    Returns:
    
    a Date object.
  - getEndDisplay
```
public Date getEndDisplay()
```
    Getter for the field endDisplay.
    
    Returns:
    
    a Date object.
  - getNullSafeEndDisplay
```
public Date getNullSafeEndDisplay()
```
    getNullSafeEndDisplay.
    
    Returns:
    
    a Date object.
  - getMessage
```
public String getMessage()
```
    Getter for the field message.
    
    Returns:
    
    a String object.
  - setTitle
```
public void setTitle(String title)
```
    Setter for the field title.
    
    Parameters:
    
    title - a String object.
  - setCreated
```
public void setCreated(Date created)
```
    Setter for the field created.
    
    Parameters:
    
    created - a Date object.
  - setStartDisplay
```
public void setStartDisplay(Date startDisplay)
```
    Setter for the field startDisplay.
    
    Parameters:
    
    startDisplay - a Date object.
  - setEndDisplay
```
public void setEndDisplay(Date endDisplay)
```
    Setter for the field endDisplay.
    
    Parameters:
    
    endDisplay - a Date object.
  - setMessage
```
public void setMessage(String message)
```
    Setter for the field message.
    
    Parameters:
    
    message - a String object.
  - getAbstractText
```
public String getAbstractText()
```
    Getter for the field abstractText.
    
    Returns:
    
    a String object.
  - getAuthor
```
public String getAuthor()
```
    Getter for the field author.
    
    Returns:
    
    a String object.
  - getLink
```
public String getLink()
```
    Getter for the field link.
    
    Returns:
    
    a String object.
  - setAbstractText
```
public void setAbstractText(String abstractText)
```
    Setter for the field abstractText.
    
    Parameters:
    
    abstractText - a String object.
  - setAuthor
```
public void setAuthor(String author)
```
    Setter for the field author.
    
    Parameters:
    
    author - a String object.
  - setLink
```
public void setLink(String link)
```
    Setter for the field link.
    
    Parameters:
    
    link - a String object.
  - getAttachments
```
public Set<String> getAttachments()
```
    Getter for the field attachments.
    
    Returns:
    
    a Set object.
  - setAttachments
```
public void setAttachments(Set<String> attachments)
```
    Setter for the field attachments.
    
    Parameters:
    
    attachments - a Set object.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(Announcement otherAnn)
```
    compareTo.
    
    Specified by:
    
    compareTo in interface Comparable<Announcement>
    
    Parameters:
    
    otherAnn - a Announcement object.
    
    Returns:
    
    a int.

Class Announcement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MILLISECONDS_IN_A_YEAR

Constructor Detail

Announcement

Method Detail

getPublished

setPublished

hasId

getId

setId

getParent

setParent

getTitle

getCreated

getStartDisplay

getEndDisplay

getNullSafeEndDisplay

getMessage

setTitle

setCreated

setStartDisplay

setEndDisplay

setMessage

getAbstractText

getAuthor

getLink

setAbstractText

setAuthor

setLink

getAttachments

setAttachments

equals

hashCode

compareTo