CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto.base
Class AbstractReferenceDto

java.lang.Object
  extended by com.intland.codebeamer.persistence.dto.base.IdentifiableDto
      extended by com.intland.codebeamer.persistence.dto.base.AbstractReferenceDto
All Implemented Interfaces:
BaseDto, ReferenceHolderDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable
Direct Known Subclasses:
AssociationDto, EntityReferenceDto

public abstract class AbstractReferenceDto
extends IdentifiableDto
implements ReferenceHolderDto

Each DTO that represents reference between two entities in the system or between one entity and an external URL, must extend this.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto
IdentifiableDto.IdComparator
 
Field Summary
static ReferenceAccessor<AbstractReferenceDto> FromReferences
          A special ReferenceAccessor to access the "from" references of AbstractReferenceDto s
static ReferenceAccessor<AbstractReferenceDto> ToReferences
          A special ReferenceAccessor to access the "to" references of AbstractReferenceDto s
 
Fields inherited from interface com.intland.codebeamer.persistence.dto.base.ReferenceHolderDto
Accessor
 
Constructor Summary
AbstractReferenceDto()
           
 
Method Summary
protected  ReferenceDto checkFrom()
           
protected  ReferenceDto checkTo()
           
 boolean equals(java.lang.Object obj)
           
 ReferenceDto getFrom()
          Get the origin of this directed association
 java.lang.String getFromDescription()
          Returns the textual description of the source end or null if this end can't be resolved.
 ReferableDto getFromDto()
           
 java.lang.Integer getFromId()
           
 java.lang.String getFromInterwikiReference()
          Returns the textual description of the source end or null if this end can't be resolved.
 java.lang.Integer getFromTypeId()
           
 java.lang.String getFromUrl()
          Returns the URL of the source end or null if this end can't be resolved.
 ReferenceDto getReference()
          By default only the destination reference will be resolved
 ReferenceDto getTo()
          Get the destination of this directed association
 java.lang.String getToDescription()
          Returns the textual description of the target end or null if this end can't be resolved.
 ReferableDto getToDto()
           
 java.lang.Integer getToId()
           
 java.lang.String getToInterwikiReference()
          Returns the textual description of the target end or null if this end can't be resolved.
 java.lang.Integer getToTypeId()
           
 java.lang.String getToUrl()
          Returns the URL of the target end or null if this end can't be resolved.
 java.lang.String getUrl()
           
 int hashCode()
           
 boolean isUrlReference()
          Returns true if this reference points to a URL, not to another artifact.
 void setFrom(ReferenceDto from)
          Set the origin of this directed association
 void setFromDto(ReferableDto fromDto)
           
 void setFromId(java.lang.Integer fromId)
           
 void setFromTypeId(java.lang.Integer fromTypeId)
           
 void setTo(ReferenceDto to)
          Set the destination of this directed association
 void setToDto(ReferableDto toDto)
           
 void setToId(java.lang.Integer toId)
           
 void setToTypeId(java.lang.Integer toTypeId)
           
 void setUrl(java.lang.String url)
           
 java.lang.String toString()
           
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto
clone, compare, compareInteger, compareTo, equals, getId, hashCode, setId
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

FromReferences

public static final ReferenceAccessor<AbstractReferenceDto> FromReferences
A special ReferenceAccessor to access the "from" references of AbstractReferenceDto s


ToReferences

public static final ReferenceAccessor<AbstractReferenceDto> ToReferences
A special ReferenceAccessor to access the "to" references of AbstractReferenceDto s

Constructor Detail

AbstractReferenceDto

public AbstractReferenceDto()
Method Detail

getFrom

public ReferenceDto getFrom()
Get the origin of this directed association

Returns:
the association origin

setFrom

public void setFrom(ReferenceDto from)
Set the origin of this directed association

Parameters:
from - is the association origin

checkFrom

protected ReferenceDto checkFrom()

getFromTypeId

public java.lang.Integer getFromTypeId()

setFromTypeId

public void setFromTypeId(java.lang.Integer fromTypeId)

getFromId

public java.lang.Integer getFromId()

setFromId

public void setFromId(java.lang.Integer fromId)

getFromDto

public ReferableDto getFromDto()

setFromDto

public void setFromDto(ReferableDto fromDto)

getFromDescription

public java.lang.String getFromDescription()
Returns the textual description of the source end or null if this end can't be resolved.


getFromUrl

public java.lang.String getFromUrl()
Returns the URL of the source end or null if this end can't be resolved.


getFromInterwikiReference

public java.lang.String getFromInterwikiReference()
Returns the textual description of the source end or null if this end can't be resolved.


getTo

public ReferenceDto getTo()
Get the destination of this directed association

Returns:
the association destination

setTo

public void setTo(ReferenceDto to)
Set the destination of this directed association

Parameters:
to - is the association destination

getReference

public ReferenceDto getReference()
By default only the destination reference will be resolved

Specified by:
getReference in interface ReferenceHolderDto
Returns:
the destination reference to be resolved

checkTo

protected ReferenceDto checkTo()

getToTypeId

public java.lang.Integer getToTypeId()

setToTypeId

public void setToTypeId(java.lang.Integer toTypeId)

getToId

public java.lang.Integer getToId()

setToId

public void setToId(java.lang.Integer toId)

getToDto

public ReferableDto getToDto()

setToDto

public void setToDto(ReferableDto toDto)

getToDescription

public java.lang.String getToDescription()
Returns the textual description of the target end or null if this end can't be resolved.


getToUrl

public java.lang.String getToUrl()
Returns the URL of the target end or null if this end can't be resolved.


getToInterwikiReference

public java.lang.String getToInterwikiReference()
Returns the textual description of the target end or null if this end can't be resolved.


getUrl

public java.lang.String getUrl()

setUrl

public void setUrl(java.lang.String url)

isUrlReference

public boolean isUrlReference()
Returns true if this reference points to a URL, not to another artifact.


hashCode

public int hashCode()
Overrides:
hashCode in class IdentifiableDto

equals

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

toString

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

CodeBeamer 5.4.0.1-RC API

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