CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto.base
Interface ReferableDto

All Superinterfaces:
BaseDto, java.io.Serializable
All Known Subinterfaces:
VersionedReferableDto
All Known Implementing Classes:
ArtifactCommentDto, ArtifactDto, BuildDto, BuildLogDto, CalendarDto, CalendarEntryDto, ChatStatsDto, EntityLabelDto, ForumDto, ForumPostDto, InboxDto, NavigationHistoryDto, ObjectRatingDto, ObjectRatingStatsDto, ProjectDto, ReadOnlyProjectDto, ReadOnlyRoleDto, ReadOnlyTrackerDto, ReadOnlyUserDto, ReferenceDto, RoleDto, ScmChangeSetDto, SourceFileDto, TrackerDto, TrackerItemAttachmentDto, TrackerItemCommentDto, TrackerItemDto, TrackerViewDto, UserDto, WikiPageCommentDto, WikiPageDto

public interface ReferableDto
extends BaseDto

All DTO classes that can be linked through URLs and interwiki references should implement this.


Nested Class Summary
static class ReferableDto.DescriptionComparator
          A special Comparator implementation to compare two ReferableDtos by short description
 
Field Summary
static java.lang.String HEAD_VERSION
          Version specified for the latest "HEAD" version.
static java.lang.String SECTION_DELIMITER
          Delimiter for interwiki links with section specified, like [WIKIPAGE:1234#My Favourite Section].
static java.lang.String VERSION_DELIMITER
          Delimiter for interwiki links with version specified, like [WIKIPAGE:1234/17].
 
Method Summary
 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.String getShortDescription()
          Returns the short description that represent this entity in the user interface.
 java.lang.String getUrlLink()
          Returns the local URL that points to the web page where this DTO is managed.
 

Field Detail

HEAD_VERSION

static final java.lang.String HEAD_VERSION
Version specified for the latest "HEAD" version.

See Also:
Constant Field Values

VERSION_DELIMITER

static final java.lang.String VERSION_DELIMITER
Delimiter for interwiki links with version specified, like [WIKIPAGE:1234/17].

See Also:
Constant Field Values

SECTION_DELIMITER

static final java.lang.String SECTION_DELIMITER
Delimiter for interwiki links with section specified, like [WIKIPAGE:1234#My Favourite Section].

See Also:
Constant Field Values
Method Detail

getShortDescription

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


getUrlLink

java.lang.String getUrlLink()
Returns the local URL that points to the web page where this DTO is managed.


getInterwikiLink

java.lang.String getInterwikiLink()
Returns the interwiki link that points to the web page where this DTO is managed.


getIconUrl

java.lang.String getIconUrl()
Returns the URL of the (small) icon image that represents this DTO type.


CodeBeamer 5.4.0.1-RC API

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