CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto
Class LabelDto

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.LabelDto
All Implemented Interfaces:
BaseDto, IndexableDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class LabelDto
extends NamedDto
implements IndexableDto

Wraps a label.

Labels have a special derived property "display name":

See Also:
Serialized Form

Nested Class Summary
 
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
 
Field Summary
static java.lang.String PRIVATE_LABEL_PREFIX
           
 
Constructor Summary
LabelDto()
           
 
Method Summary
static boolean displayNameToPrivateAccess(java.lang.String displayName)
          Returns the access flag from a label display name.
static java.lang.String displayNameToRealName(java.lang.String displayName)
          Returns the real name to persist from a label display name.
 boolean equals(java.lang.Object obj)
          Two labels are "business identical" when they have the same IDs or empty IDs and the same name.
 java.util.Date getCreatedAt()
           
 UserDto getCreatedBy()
           
 java.lang.String getDisplayName()
          Returns the name to display in the user interface, which reflects also its "public"/"private" access.
 java.lang.String getEscapedDisplayName()
          Returns the display name escaped to use in Javascript code embedded in HTML.
 java.lang.String getIconUrl()
           
 java.util.Date getMostRecentlyUsedAt()
           
 java.lang.Integer getPopularity()
           
 java.lang.Boolean getPrivateLabel()
           
 int hashCode()
           
 boolean isIndexed()
           
 void setCreatedAt(java.util.Date createdAt)
           
 void setCreatedBy(UserDto createdBy)
           
 void setDisplayName(java.lang.String displayName)
          Sets its name and access based on its display name.
 void setIndexed(boolean indexed)
           
 void setMostRecentlyUsedAt(java.util.Date mostRecentlyUsedAt)
           
 void setPopularity(java.lang.Integer popularity)
           
 void setPrivateLabel(java.lang.Boolean privateLabel)
           
 java.lang.String toString()
           
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.NamedDto
compareNames, compareString, compareStringIgnoreCase, compareTo, createLookupMap, getName, setName
 
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

PRIVATE_LABEL_PREFIX

public static final java.lang.String PRIVATE_LABEL_PREFIX
See Also:
Constant Field Values
Constructor Detail

LabelDto

public LabelDto()
Method Detail

getPrivateLabel

public java.lang.Boolean getPrivateLabel()

setPrivateLabel

public void setPrivateLabel(java.lang.Boolean privateLabel)

getCreatedBy

public UserDto getCreatedBy()

setCreatedBy

public void setCreatedBy(UserDto createdBy)

getCreatedAt

public java.util.Date getCreatedAt()

setCreatedAt

public void setCreatedAt(java.util.Date createdAt)

getPopularity

public java.lang.Integer getPopularity()

setPopularity

public void setPopularity(java.lang.Integer popularity)

getMostRecentlyUsedAt

public java.util.Date getMostRecentlyUsedAt()

setMostRecentlyUsedAt

public void setMostRecentlyUsedAt(java.util.Date mostRecentlyUsedAt)

isIndexed

public boolean isIndexed()
Specified by:
isIndexed in interface IndexableDto

setIndexed

public void setIndexed(boolean indexed)
Specified by:
setIndexed in interface IndexableDto

getDisplayName

public java.lang.String getDisplayName()
Returns the name to display in the user interface, which reflects also its "public"/"private" access.


setDisplayName

public void setDisplayName(java.lang.String displayName)
Sets its name and access based on its display name.


getEscapedDisplayName

public java.lang.String getEscapedDisplayName()
Returns the display name escaped to use in Javascript code embedded in HTML.


equals

public boolean equals(java.lang.Object obj)
Two labels are "business identical" when they have the same IDs or empty IDs and the same name.

Overrides:
equals in class NamedDto

hashCode

public int hashCode()
Overrides:
hashCode in class NamedDto

toString

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

displayNameToPrivateAccess

public static boolean displayNameToPrivateAccess(java.lang.String displayName)
Returns the access flag from a label display name.

Returns:
true if it's a private label.

displayNameToRealName

public static java.lang.String displayNameToRealName(java.lang.String displayName)
Returns the real name to persist from a label display name.


getIconUrl

public java.lang.String getIconUrl()

CodeBeamer 5.4.0.1-RC API

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