CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto
Class TrackerViewDto

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.TrackerViewDto
All Implemented Interfaces:
BaseDto, ReferableDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, org.apache.commons.collections.Predicate

public class TrackerViewDto
extends NamedDto
implements ReferableDto, org.apache.commons.collections.Predicate

Wraps a tracker view.

See Also:
Serialized Form

Nested Class Summary
static interface TrackerViewDto.PredicateFactory
          The interface of a PredicateFactory to translate TrackerView criteria into a Predicate
 
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 ASCENDING
           
static java.lang.String DESCENDING
           
static java.lang.Integer TRACKER_VIEW_TYPE
           
 
Fields inherited from interface com.intland.codebeamer.persistence.dto.base.ReferableDto
HEAD_VERSION, SECTION_DELIMITER, VERSION_DELIMITER
 
Constructor Summary
TrackerViewDto()
          Default constructor
TrackerViewDto(java.lang.Integer id)
          Create a new TrackerView with the specified id
TrackerViewDto(TrackerViewDto view)
          Create a shallow copy of the specified view
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 boolean evaluate(java.lang.Object object)
          Check if the specified object matches this views's criteria
 java.lang.String getAdvancedCriteria()
          Returns its advancedCriteria.
 java.util.Date getCreatedAt()
          Returns its createdAt.
 java.lang.String getCriteria()
          Returns its criteria.
 java.lang.String getDefaultOrder()
           
 java.lang.String getDefaultSort()
           
 java.lang.Integer getEntityId()
          The entity id which this view is for.
 java.lang.String getIconUrl()
          Returns the URL of the (small) icon image that represents this DTO type.
 java.lang.String getInterwikiLink()
          Returns the interwiki link that points to the web page where this DTO is managed.
 java.lang.Integer getOffset()
          Returns its offset.
 org.apache.commons.collections.Predicate getPredicate()
          Get the Predicate to check if specific objects match the view criteria
static TrackerViewDto.PredicateFactory getPredicateFactory()
          Get the factory to translate view criteria into a Predicate
 java.lang.String getRawCriteria()
          Returns its rawCriteria.
 java.lang.String getShortDescription()
          Returns the short description that represent this entity in the user interface.
 java.lang.String getSorting()
           
 java.lang.Integer getTypeId()
          The type of view.
 java.lang.String getUrlLink()
          Returns the local URL that points to the web page where this DTO is managed.
 UserDto getUser()
          Returns its user.
 int hashCode()
           
 boolean isEditable()
           
 boolean isPublic()
          Check if this is a public view
 void setAdvancedCriteria(java.lang.String advancedCriteria)
          Sets its advancedCriteria.
 void setCreatedAt(java.util.Date createdAt)
          Sets its createdAt.
 void setCriteria(java.lang.String criteria)
          Sets its criteria.
 void setEntityId(java.lang.Integer entityId)
          Sets its entityId.
 void setOffset(java.lang.Integer offset)
          Sets its offset.
 void setPredicate(org.apache.commons.collections.Predicate predicate)
          Set the Predicate to check if specific objects match the view criteria
static void setPredicateFactory(TrackerViewDto.PredicateFactory factory)
          Set the factory to translate view criteria into a Predicate
 void setRawCriteria(java.lang.String rawCriteria)
          Sets its rawCriteria.
 void setSorting(java.lang.String sorting)
           
 void setTypeId(java.lang.Integer typeId)
          Sets its typeId.
 void setUser(UserDto user)
          Sets its user.
 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

TRACKER_VIEW_TYPE

public static final java.lang.Integer TRACKER_VIEW_TYPE

ASCENDING

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

DESCENDING

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

TrackerViewDto

public TrackerViewDto()
Default constructor


TrackerViewDto

public TrackerViewDto(java.lang.Integer id)
Create a new TrackerView with the specified id

Parameters:
id - of the view

TrackerViewDto

public TrackerViewDto(TrackerViewDto view)
Create a shallow copy of the specified view

Parameters:
view - to copy
Method Detail

getCreatedAt

public java.util.Date getCreatedAt()
Returns its createdAt.


setCreatedAt

public void setCreatedAt(java.util.Date createdAt)
Sets its createdAt.


getCriteria

public java.lang.String getCriteria()
Returns its criteria.


setCriteria

public void setCriteria(java.lang.String criteria)
Sets its criteria.


getEntityId

public java.lang.Integer getEntityId()
The entity id which this view is for. Practically this is always the tracker-id for the views of type TRACKER_VIEW_TYPE.

Returns:
entity-id

setEntityId

public void setEntityId(java.lang.Integer entityId)
Sets its entityId.


getUser

public UserDto getUser()
Returns its user.


setUser

public void setUser(UserDto user)
Sets its user.


isPublic

public boolean isPublic()
Check if this is a public view

Returns:
true if this is a public view, false for a private user view

getTypeId

public java.lang.Integer getTypeId()
The type of view. This is @{link #TRACKER_VIEW_TYPE} for views belong to a tracker.


setTypeId

public void setTypeId(java.lang.Integer typeId)
Sets its typeId.


getSorting

public java.lang.String getSorting()

setSorting

public void setSorting(java.lang.String sorting)

getAdvancedCriteria

public java.lang.String getAdvancedCriteria()
Returns its advancedCriteria.


setAdvancedCriteria

public void setAdvancedCriteria(java.lang.String advancedCriteria)
Sets its advancedCriteria.


getRawCriteria

public java.lang.String getRawCriteria()
Returns its rawCriteria.


setRawCriteria

public void setRawCriteria(java.lang.String rawCriteria)
Sets its rawCriteria.


getPredicate

public org.apache.commons.collections.Predicate getPredicate()
Get the Predicate to check if specific objects match the view criteria

Returns:
a Predicate to check if specific objects match the view criteria

setPredicate

public void setPredicate(org.apache.commons.collections.Predicate predicate)
Set the Predicate to check if specific objects match the view criteria

Parameters:
predicate - to check if specific objects match the view criteria

evaluate

public boolean evaluate(java.lang.Object object)
Check if the specified object matches this views's criteria

Specified by:
evaluate in interface org.apache.commons.collections.Predicate
Parameters:
object - to check
Returns:
true if the object matches the view criteria, otherwise false

getOffset

public java.lang.Integer getOffset()
Returns its offset.


setOffset

public void setOffset(java.lang.Integer offset)
Sets its offset.


getDefaultSort

public java.lang.String getDefaultSort()

getDefaultOrder

public java.lang.String getDefaultOrder()

isEditable

public boolean isEditable()

equals

public boolean equals(java.lang.Object obj)
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

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

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

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

getPredicateFactory

public static TrackerViewDto.PredicateFactory getPredicateFactory()
Get the factory to translate view criteria into a Predicate

Returns:
the factory to translate view criteria into a Predicate, or null if no such factory available

setPredicateFactory

public static void setPredicateFactory(TrackerViewDto.PredicateFactory factory)
Set the factory to translate view criteria into a Predicate

Parameters:
factory - to translate view criteria into a Predicate, or null if no such factory available

CodeBeamer 5.4.0.1-RC API

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