CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto
Class ForumDto

java.lang.Object
  extended by com.intland.codebeamer.persistence.dto.base.IdentifiableDto
      extended by com.intland.codebeamer.persistence.dto.base.NamedDto
          extended by com.intland.codebeamer.persistence.dto.base.DescribeableDto
              extended by com.intland.codebeamer.persistence.dto.ForumDto
All Implemented Interfaces:
BaseDto, ProjectAwareDto, ReferableDto, WriteControlledDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class ForumDto
extends DescribeableDto
implements ProjectAwareDto, ReferableDto, WriteControlledDto

Wraps a forum.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.base.DescribeableDto
DescribeableDto.DescriptionComparator
 
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.base.NamedDto
NamedDto.NameComparator
 
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto
IdentifiableDto.IdComparator
 
Nested classes/interfaces inherited from interface com.intland.codebeamer.persistence.dto.base.ReferableDto
ReferableDto.DescriptionComparator
 
Field Summary
static int ANNOUNCEMENTS
           
static int EVENTS
           
static int GENERAL
           
static java.lang.String INTERWIKI_LINK_TYPE
           
static int NEWS
           
 
Fields inherited from interface com.intland.codebeamer.persistence.dto.base.ReferableDto
HEAD_VERSION, SECTION_DELIMITER, VERSION_DELIMITER
 
Constructor Summary
ForumDto()
           
 
Method Summary
static int compareForums(ForumDto f1, ForumDto f2)
          Compare two ForumDtos that may be null
 int compareTo(java.lang.Object obj)
          Caution: NamedDto compareTo violates the rule that a.equals(b) is equivalent to a.compareTo(b) == 0, because only the names are compared
 boolean equals(java.lang.Object obj)
           
 java.util.Date getCreatedAt()
           
 UserDto getCreatedBy()
           
 java.lang.String getIconUrl()
          Returns the URL of the (small) icon image that represents this DTO type.
 java.lang.String getInboxEmail()
           
 java.lang.String getInterwikiLink()
          Returns the interwiki link that points to the web page where this DTO is managed.
 java.lang.String getKeyName()
           
 ProjectDto getProject()
           
 java.lang.String getShortDescription()
          Returns the short description that represent this entity in the user interface.
 ForumTypeDto getType()
           
 java.lang.String getUrlLink()
          Returns the local URL that points to the web page where this DTO is managed.
 java.lang.Boolean getVisible()
           
 int hashCode()
           
 boolean isReadable()
           
 boolean isWritable()
           
 void setCreatedAt(java.util.Date createdAt)
           
 void setCreatedBy(UserDto createdByUser)
           
 void setInboxEmail(java.lang.String inboxEmail)
           
 void setKeyName(java.lang.String shortName)
           
 void setProject(ProjectDto project)
           
 void setReadable(boolean readable)
           
 void setType(ForumTypeDto type)
           
 void setVisible(java.lang.Boolean visible)
           
 void setWritable(boolean writable)
           
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.DescribeableDto
compareByDescription, getDescription, getDescriptionFormat, setDescription, setDescriptionFormat
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.NamedDto
compareNames, compareString, compareStringIgnoreCase, createLookupMap, getName, setName, toString
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto
clone, compare, compareInteger, equals, getId, hashCode, setId
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

INTERWIKI_LINK_TYPE

public static final java.lang.String INTERWIKI_LINK_TYPE
See Also:
Constant Field Values

GENERAL

public static final int GENERAL
See Also:
Constant Field Values

ANNOUNCEMENTS

public static final int ANNOUNCEMENTS
See Also:
Constant Field Values

EVENTS

public static final int EVENTS
See Also:
Constant Field Values

NEWS

public static final int NEWS
See Also:
Constant Field Values
Constructor Detail

ForumDto

public ForumDto()
Method Detail

getProject

public ProjectDto getProject()
Specified by:
getProject in interface ProjectAwareDto

setProject

public void setProject(ProjectDto project)
Specified by:
setProject in interface ProjectAwareDto

getCreatedBy

public UserDto getCreatedBy()

setCreatedBy

public void setCreatedBy(UserDto createdByUser)

getKeyName

public java.lang.String getKeyName()

setKeyName

public void setKeyName(java.lang.String shortName)

getType

public ForumTypeDto getType()

setType

public void setType(ForumTypeDto type)

getVisible

public java.lang.Boolean getVisible()

setVisible

public void setVisible(java.lang.Boolean visible)

getCreatedAt

public java.util.Date getCreatedAt()

setCreatedAt

public void setCreatedAt(java.util.Date createdAt)

isReadable

public boolean isReadable()

setReadable

public void setReadable(boolean readable)

isWritable

public boolean isWritable()
Specified by:
isWritable in interface WriteControlledDto

setWritable

public void setWritable(boolean writable)
Specified by:
setWritable in interface WriteControlledDto

getInboxEmail

public java.lang.String getInboxEmail()

setInboxEmail

public void setInboxEmail(java.lang.String inboxEmail)

getShortDescription

public java.lang.String getShortDescription()
Description copied from interface: ReferableDto
Returns the short description that represent this entity in the user interface. This normally delegates to another getter, like ProjectDto.getName() or TrackerItemDto.getSummary().

Specified by:
getShortDescription in interface ReferableDto

getUrlLink

public java.lang.String getUrlLink()
Description copied from interface: ReferableDto
Returns the local URL that points to the web page where this DTO is managed.

Specified by:
getUrlLink in interface ReferableDto

getInterwikiLink

public java.lang.String getInterwikiLink()
Description copied from interface: ReferableDto
Returns the interwiki link that points to the web page where this DTO is managed.

Specified by:
getInterwikiLink in interface ReferableDto

getIconUrl

public java.lang.String getIconUrl()
Description copied from interface: ReferableDto
Returns the URL of the (small) icon image that represents this DTO type.

Specified by:
getIconUrl in interface ReferableDto

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class NamedDto

compareTo

public int compareTo(java.lang.Object obj)
Description copied from class: NamedDto
Caution: NamedDto compareTo violates the rule that a.equals(b) is equivalent to a.compareTo(b) == 0, because only the names are compared

Specified by:
compareTo in interface java.lang.Comparable
Overrides:
compareTo in class NamedDto

hashCode

public int hashCode()
Overrides:
hashCode in class NamedDto

compareForums

public static int compareForums(ForumDto f1,
                                ForumDto f2)
Compare two ForumDtos that may be null

Parameters:
f1 - is the first ForumDto, or null
f2 - is the second ForumDto, or null
Returns:
a value < 0 if f1 is less than f2, a value > 0 if f1 greater than f2, and 0 if f1 equals f2

CodeBeamer 5.4.0.1-RC API

Copyright © 2006-2009 Intland Software. All rights reserved.