CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto
Class WikiPageDto

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.WikiPageDto
All Implemented Interfaces:
BaseDto, IndexableDto, ProjectAwareDto, ReferableDto, VersionedReferableDto, WriteControlledDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class WikiPageDto
extends ArtifactDto

Wraps a wiki page.

See Also:
Serialized Form

Nested Class Summary
 
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 INTERWIKI_LINK_TYPE
           
 
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
WikiPageDto()
           
WikiPageDto(ProjectDto project, int type)
           
 
Method Summary
 boolean getCanDelete()
          Check if the current user may delete this artifact
 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.
 WikiPageDto getParentPage()
           
 java.lang.String getUrlLink()
          Returns the local URL that points to the web page where this DTO is managed.
 java.lang.String getUrlLinkVersioned(java.lang.String version)
           
 boolean isApprovalSupported()
          Returns whether this supports artifact approval workflows.
 boolean isProjectHomePage()
          Returns true if this page is the wiki homepage of its project.
 boolean isProjectNavigationBarPage()
          Returns true if this wiki page is the "Navigation Bar" of its project.
 boolean isProjectPage()
          Returns true if this wiki page is a regular project page in its project.
 boolean isTrackerHomePage()
          Returns true if this wiki page is the tracker homepage of its project.
 boolean isTrackerPage()
          Returns true if this wiki page is a tracker page in its project.
 boolean isUserHomePage()
          Returns true if this page is the homepage of its creator.
 boolean isUserPage()
          Returns true if this wiki page is a user page of its creator.
static boolean isWikiPage(ArtifactDto artifact)
          Check if the specified artifact is a WikiPage
 void setParentPage(WikiPageDto parent)
           
 
Methods inherited from class com.intland.codebeamer.persistence.dto.ArtifactDto
clone, compareArtifacts, compareScope, compareTo, compareType, equals, getAdditionalInfo, getAge, getCompareType, getCreatedAt, getGenericReferenceId, getInterwikiLinkVersioned, getLastModifiedAt, getLastModifiedBy, getNotification, getOwner, getParent, getPath, getProject, getScopeName, getShortDescription, getTypeId, getVersion, hashCode, isA, isDeleted, isDirectory, isExists, isFile, isIndexed, isReadable, isSubscribed, isWikiNotes, isWikiPage, isWritable, setAdditionalInfo, setCreatedAt, setDeleted, setGenericReferenceId, setIndexed, setLastModifiedAt, setLastModifiedBy, setName, setNotification, setOwner, setParent, setProject, setReadable, setScopeName, setTypeId, setWritable, toString
 
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

INTERWIKI_LINK_TYPE

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

WikiPageDto

public WikiPageDto()

WikiPageDto

public WikiPageDto(ProjectDto project,
                   int type)
Method Detail

getParentPage

public WikiPageDto getParentPage()

setParentPage

public void setParentPage(WikiPageDto parent)

getCanDelete

public boolean getCanDelete()
Description copied from class: ArtifactDto
Check if the current user may delete this artifact

Overrides:
getCanDelete in class ArtifactDto
Returns:
true if current user may delete this artifact, otherwise false

isProjectPage

public boolean isProjectPage()
Returns true if this wiki page is a regular project page in its project. Note that isProjectPage returns false for project navigation bar pages.


isProjectHomePage

public boolean isProjectHomePage()
Returns true if this page is the wiki homepage of its project.


isProjectNavigationBarPage

public boolean isProjectNavigationBarPage()
Returns true if this wiki page is the "Navigation Bar" of its project.


isTrackerPage

public boolean isTrackerPage()
Returns true if this wiki page is a tracker page in its project.


isTrackerHomePage

public boolean isTrackerHomePage()
Returns true if this wiki page is the tracker homepage of its project.


isUserPage

public boolean isUserPage()
Returns true if this wiki page is a user page of its creator.


isUserHomePage

public boolean isUserHomePage()
Returns true if this page is the homepage of its creator.


isApprovalSupported

public boolean isApprovalSupported()
Description copied from class: ArtifactDto
Returns whether this supports artifact approval workflows.

Overrides:
isApprovalSupported in class ArtifactDto

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
Overrides:
getUrlLink in class ArtifactDto

getUrlLinkVersioned

public java.lang.String getUrlLinkVersioned(java.lang.String version)
Specified by:
getUrlLinkVersioned in interface VersionedReferableDto
Overrides:
getUrlLinkVersioned in class ArtifactDto

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
Overrides:
getInterwikiLink in class ArtifactDto

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
Overrides:
getIconUrl in class ArtifactDto

isWikiPage

public static boolean isWikiPage(ArtifactDto artifact)
Check if the specified artifact is a WikiPage

Parameters:
artifact - to check
Returns:
true if the artifact is a WikiPage, otherwise false

CodeBeamer 5.4.0.1-RC API

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