CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto
Class InboxDto

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.ArtifactDto
                  extended by com.intland.codebeamer.persistence.dto.InboxDto
All Implemented Interfaces:
BaseDto, IndexableDto, ProjectAwareDto, ReferableDto, VersionedReferableDto, WriteControlledDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class InboxDto
extends ArtifactDto

Wraps an inbox item and the associated artifact.

See Also:
Serialized Form

Nested Class Summary
static class InboxDto.HostAndPort
          Just a simple struct-like class to hold parsed host name and port.
 
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.ArtifactDto
ArtifactDto.PathComparator
 
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 java.lang.String ALLOWED_EMAILS_ALL
          Possible value for allowedEmails string: Anybody can send email to forums...
static java.lang.String ALLOWED_EMAILS_ALL_CB
          Possible value for allowedEmals string: If all codebeamer users are allowed to send emails to a forum.
static java.lang.String ALLOWED_EMAILS_PROJECT_MEMBERS
          Possible value for allowedEmals string: If project members are allowed to send emails to a forum.
 
Fields inherited from class com.intland.codebeamer.persistence.dto.ArtifactDto
INTERWIKI_LINK_TYPE_DIR, INTERWIKI_LINK_TYPE_DOC, INTERWIKI_LINK_TYPE_NOTE, INTERWIKI_LINK_TYPE_NOTES, INTERWIKI_LINK_TYPE_REPORT
 
Fields inherited from interface com.intland.codebeamer.persistence.dto.base.ReferableDto
HEAD_VERSION, SECTION_DELIMITER, VERSION_DELIMITER
 
Constructor Summary
InboxDto()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
          Compares this artifact to the specified object.
 java.lang.String getAccount()
           
 java.lang.String getAllowedEmails()
           
 java.lang.Integer getDefaultUserId()
           
 java.lang.String getEmail()
           
 java.lang.String getExtraAllowedEmails()
           
 ForumDto getForum()
           
 java.util.Date getLastAccessAt()
           
 java.lang.String getPasswd()
           
 ProjectDto getProject()
          Get the project this artifact belongs to
 java.lang.String getProtocol()
           
 java.lang.String getServer()
           
 int hashCode()
           
 boolean isDefaultInbox()
           
 boolean isDeleteFromServer()
           
 boolean isEnabled()
           
 boolean isUseSsl()
           
static InboxDto.HostAndPort parseMailServerPort(java.lang.String mailServer)
          Parse out the default mail server port from the mailServer name, which may contain it as "host:port" format.
 void setAccount(java.lang.String account)
           
 void setAllowedEmails(java.lang.String allowed_emails)
           
 void setDefaultInbox(boolean defaultInbox)
           
 void setDefaultUserId(java.lang.Integer default_user_id)
           
 void setDeleteFromServer(boolean delete_from_server)
           
 void setEmail(java.lang.String email)
           
 void setEnabled(boolean enabled)
           
 void setExtraAllowedEmails(java.lang.String extra_allowed_emails)
           
 void setForum(ForumDto forum)
           
 void setLastAccessAt(java.util.Date llastAccessAt)
           
 void setPasswd(java.lang.String passwd)
           
 void setProject(ProjectDto project)
          Set the project this artifact belongs to
 void setProtocol(java.lang.String protocol)
           
 void setServer(java.lang.String server)
           
 void setUseSsl(boolean use_ssl)
           
 java.lang.String toString()
           
 
Methods inherited from class com.intland.codebeamer.persistence.dto.ArtifactDto
clone, compareArtifacts, compareScope, compareTo, compareType, getAdditionalInfo, getAge, getCanDelete, getCompareType, getCreatedAt, getGenericReferenceId, getIconUrl, getInterwikiLink, getInterwikiLinkVersioned, getLastModifiedAt, getLastModifiedBy, getNotification, getOwner, getParent, getPath, getScopeName, getShortDescription, getTypeId, getUrlLink, getUrlLinkVersioned, getVersion, isA, isApprovalSupported, isDeleted, isDirectory, isExists, isFile, isIndexed, isReadable, isSubscribed, isWikiNotes, isWikiPage, isWritable, setAdditionalInfo, setCreatedAt, setDeleted, setGenericReferenceId, setIndexed, setLastModifiedAt, setLastModifiedBy, setName, setNotification, setOwner, setParent, setReadable, setScopeName, setTypeId, setWritable
 
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
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto
compare, compareInteger, equals, getId, hashCode, setId
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ALLOWED_EMAILS_ALL

public static final java.lang.String ALLOWED_EMAILS_ALL
Possible value for allowedEmails string: Anybody can send email to forums...

See Also:
Constant Field Values

ALLOWED_EMAILS_ALL_CB

public static final java.lang.String ALLOWED_EMAILS_ALL_CB
Possible value for allowedEmals string: If all codebeamer users are allowed to send emails to a forum.

See Also:
Constant Field Values

ALLOWED_EMAILS_PROJECT_MEMBERS

public static final java.lang.String ALLOWED_EMAILS_PROJECT_MEMBERS
Possible value for allowedEmals string: If project members are allowed to send emails to a forum.

See Also:
Constant Field Values
Constructor Detail

InboxDto

public InboxDto()
Method Detail

getAccount

public java.lang.String getAccount()

setAccount

public void setAccount(java.lang.String account)

getAllowedEmails

public java.lang.String getAllowedEmails()

setAllowedEmails

public void setAllowedEmails(java.lang.String allowed_emails)

getDefaultUserId

public java.lang.Integer getDefaultUserId()

setDefaultUserId

public void setDefaultUserId(java.lang.Integer default_user_id)

isDeleteFromServer

public boolean isDeleteFromServer()

setDeleteFromServer

public void setDeleteFromServer(boolean delete_from_server)

getEmail

public java.lang.String getEmail()

setEmail

public void setEmail(java.lang.String email)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getExtraAllowedEmails

public java.lang.String getExtraAllowedEmails()

setExtraAllowedEmails

public void setExtraAllowedEmails(java.lang.String extra_allowed_emails)

getForum

public ForumDto getForum()

setForum

public void setForum(ForumDto forum)

getProject

public ProjectDto getProject()
Description copied from class: ArtifactDto
Get the project this artifact belongs to

Specified by:
getProject in interface ProjectAwareDto
Overrides:
getProject in class ArtifactDto
Returns:
the project this artifact belongs to, or null if project independent artifact

setProject

public void setProject(ProjectDto project)
Description copied from class: ArtifactDto
Set the project this artifact belongs to

Specified by:
setProject in interface ProjectAwareDto
Overrides:
setProject in class ArtifactDto
Parameters:
project - this artifact belongs to, or null if project independent artifact

getPasswd

public java.lang.String getPasswd()

setPasswd

public void setPasswd(java.lang.String passwd)

getProtocol

public java.lang.String getProtocol()

setProtocol

public void setProtocol(java.lang.String protocol)

getServer

public java.lang.String getServer()

setServer

public void setServer(java.lang.String server)

isUseSsl

public boolean isUseSsl()

setUseSsl

public void setUseSsl(boolean use_ssl)

isDefaultInbox

public boolean isDefaultInbox()

setDefaultInbox

public void setDefaultInbox(boolean defaultInbox)

getLastAccessAt

public java.util.Date getLastAccessAt()

setLastAccessAt

public void setLastAccessAt(java.util.Date llastAccessAt)

equals

public boolean equals(java.lang.Object obj)
Compares this artifact to the specified object.

Overrides:
equals in class ArtifactDto
Parameters:
obj - object to compare with.
Returns:
true if the object passed in is a artifact with the same id, name and type.

hashCode

public int hashCode()
Overrides:
hashCode in class ArtifactDto

toString

public java.lang.String toString()
Overrides:
toString in class ArtifactDto

parseMailServerPort

public static InboxDto.HostAndPort parseMailServerPort(java.lang.String mailServer)
                                                throws java.lang.NumberFormatException
Parse out the default mail server port from the mailServer name, which may contain it as "host:port" format.

Parameters:
mailServer - The mail-server string
Returns:
The structure-class contains the host and port number, the port number is null for default port
Throws:
java.lang.NumberFormatException - if some port is provided, but that is an invalid number

CodeBeamer 5.4.0.1-RC API

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