Package com.polarion.alm.tracker.model

Interface IWikiPage

All Superinterfaces:

IAdaptable, IChangeListener, IFolderItem, IHasCustomValues, IHasValues, IPObject, IUniqueObject

public interface IWikiPage
extends IUniqueObject, IFolderItem

Since:

3.6.0

Author:

Roman Kratochvil

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_ATTACHMENTS
static final String	KEY_AUTHOR
static final String	KEY_CREATED
static final String	KEY_HOMEPAGECONTENT
static final String	KEY_LINKED_PAGES
static final String	KEY_LOCATION
static final String	KEY_PAGENAME
static final String	KEY_SPACEID
static final String	KEY_TITLE
static final String	KEY_TYPE
static final String	KEY_UPDATED
static final String	KEY_UPDATEDBY
static final String	PROTO

Fields inherited from interface com.polarion.alm.projects.model.IUniqueObject

KEY_ID, KEY_PROJECT

Method Summary

Modifier and Type	Method	Description
void	delete()	Deletes this Wiki Page.
IWikiPageAttachment	getAttachment(String fileName)
IPObjectList	getAttachments()
IUser	getAuthor()
IPObjectList	getBacklinkedPages()
Date	getCreated()
Text	getHomepageContent()
IPObjectList	getLinkedPages()
String	getPageName()
String	getPageNameWithSpace()	Method returns page name with space in readable form Format: Space Name / Page Name or Page Name only if it's located in default space
String	getSpaceId()
String	getTitle()	Returns Wiki Page Title
String	getTitleOrName()
String	getTitleWithSpace()
String	getType()
Date	getUpdated()
IUser	getUpdatedBy()

Methods inherited from interface com.polarion.platform.persistence.model.IAdaptable

adapt

Methods inherited from interface com.polarion.platform.persistence.model.IChangeListener

markChanged

Methods inherited from interface com.polarion.alm.tracker.model.IFolderItem

getFolder

Methods inherited from interface com.polarion.platform.persistence.model.IHasCustomValues

getCustomField, getCustomFieldPrototype, getCustomFieldsList, setCustomField

Methods inherited from interface com.polarion.platform.persistence.model.IPObject

can, copyTo, createStructureForKey, forget, getContextId, getDataRevision, getDataSvc, getEnumerationOptionForField, getEnumerationTypeForField, getFieldLabel, getFieldType, getIncompatibleCustomField, getIncompatibleCustomFieldPrototype, getIncompatibleCustomFieldsList, getLastRevision, getLocalId, getObjectId, getPrototype, getRevision, getUri, getValue, isModified, isPersisted, isReadOnly, isResolved, isUnresolvable, resolve, save, setEnumerationValue, setValue, update

Methods inherited from interface com.polarion.alm.projects.model.IUniqueObject

getId, getProject, getProjectId

Field Details

PROTO

static final String PROTO

See Also:

• Constant Field Values

KEY_AUTHOR

static final String KEY_AUTHOR

See Also:

• Constant Field Values

KEY_CREATED

static final String KEY_CREATED

See Also:

• Constant Field Values

KEY_UPDATED

static final String KEY_UPDATED

See Also:

• Constant Field Values

KEY_UPDATEDBY

static final String KEY_UPDATEDBY

See Also:

• Constant Field Values

KEY_HOMEPAGECONTENT

static final String KEY_HOMEPAGECONTENT

See Also:

• Constant Field Values

KEY_LOCATION

static final String KEY_LOCATION

See Also:

• Constant Field Values

KEY_PAGENAME

static final String KEY_PAGENAME

See Also:

• Constant Field Values

KEY_TITLE

static final String KEY_TITLE

Since:

3.8.2

See Also:

• Constant Field Values

KEY_SPACEID

static final String KEY_SPACEID

See Also:

• Constant Field Values

KEY_TYPE

static final String KEY_TYPE

See Also:

• Constant Field Values

KEY_LINKED_PAGES

static final String KEY_LINKED_PAGES

See Also:

• Constant Field Values

KEY_ATTACHMENTS

static final String KEY_ATTACHMENTS

See Also:

• Constant Field Values

Method Details

getAuthor

IUser getAuthor()

getCreated

Date getCreated()

getUpdated

Date getUpdated()

getUpdatedBy

IUser getUpdatedBy()

getHomepageContent

Text getHomepageContent()

getPageName

String getPageName()

getTitle

@Nullable
String getTitle()

Returns Wiki Page Title

Since:

3.8.2

getSpaceId

String getSpaceId()

getType

String getType()

getLinkedPages

IPObjectList getLinkedPages()

getBacklinkedPages

IPObjectList getBacklinkedPages()

getAttachments

IPObjectList getAttachments()

getAttachment

IWikiPageAttachment getAttachment(String fileName)

getPageNameWithSpace

String getPageNameWithSpace()

Method returns page name with space in readable form Format: Space Name / Page Name or Page Name only if it's located in default space

Returns:

page name with space

Since:

3.6.3

getTitleOrName

@NotNull
String getTitleOrName()

Returns:

Title or Page Name if Title is not set

Since:

3.8.2

getTitleWithSpace

@NotNull
String getTitleWithSpace()

Returns:

"Space Name / Title" or "Title" if located in default space (will use Page Name if Title is not set)

Since:

3.8.2

delete

void delete()

Deletes this Wiki Page.

Since:

3.10.1