Package com.terminalfour.publish.api.page

Interface IPageAPI

All Superinterfaces:

T4PublishAPI

public interface IPageAPI
extends T4PublishAPI

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IPageAPI.PageActions

Method Summary

Modifier and Type	Method	Description
String	getActionURL(IPageAPI.PageActions action)
String	getCanonicalURL()
String	getPageURL()	Returns a URL to currently publishing page using the current language in preview or publish.
String	getPageURL(String language)	Returns a URL to currently publishing page in the language if exists in preview or publish.
String	getPreviewURL()	Returns a URL to currently publishing page using the current language in preview.
String	getPreviewURL(String language)	Returns a URL to currently publishing page in the language if exists in preview.
String	getPublishURL()	Returns a URL to currently publishing page using the current language in publish.
String	getPublishURL(String language)	Returns a URL to currently publishing page in the language if exists in publish.
boolean	isFulltextPage()
boolean	isPreview()
String	processSnippet(String layout, boolean useMetaContent)

Method Detail

isPreview

boolean isPreview()

isFulltextPage

boolean isFulltextPage()

getPageURL

String getPageURL()
           throws com.terminalfour.publish.PublishException,
                  com.terminalfour.tag.parser.TagParserException

Returns a URL to currently publishing page using the current language in preview or publish.

Returns:

URL to current page, empty string when does not exists or cannot build it.

Throws:

com.terminalfour.publish.PublishException - If the section or its' link information is invalid.

com.terminalfour.tag.parser.TagParserException - If there is a problem parsing the underlying t4 link tag.

getPageURL

String getPageURL(String language)
           throws com.terminalfour.publish.PublishException,
                  com.terminalfour.tag.parser.TagParserException

Returns a URL to currently publishing page in the language if exists in preview or publish.

Parameters:

language - Language to use to build the page URL.

Returns:

URL to current page in the language, empty string when does not exists or cannot build it.

Throws:

com.terminalfour.publish.PublishException - If the section or its' link information is invalid.

com.terminalfour.tag.parser.TagParserException - If there is a problem parsing the underlying t4 link tag.

getPublishURL

String getPublishURL()
              throws com.terminalfour.publish.PublishException,
                     com.terminalfour.tag.parser.TagParserException

Returns a URL to currently publishing page using the current language in publish.

Returns:

URL to current page, empty string when does not exists or cannot build it.

Throws:

com.terminalfour.publish.PublishException - If the section or its' link information is invalid.

com.terminalfour.tag.parser.TagParserException - If there is a problem parsing the underlying t4 link tag.

getPublishURL

String getPublishURL(String language)
              throws com.terminalfour.publish.PublishException,
                     com.terminalfour.tag.parser.TagParserException

Returns a URL to currently publishing page in the language if exists in publish.

Parameters:

language - Language to use to build the page URL.

Returns:

URL to current page in the language, empty string when does not exists or cannot build it.

Throws:

com.terminalfour.publish.PublishException - If the section or its' link information is invalid.

com.terminalfour.tag.parser.TagParserException - If there is a problem parsing the underlying t4 link tag.

getPreviewURL

String getPreviewURL()

Returns a URL to currently publishing page using the current language in preview.

Returns:

URL to current page, empty string when does not exists or cannot build it.

getPreviewURL

String getPreviewURL(String language)

Returns a URL to currently publishing page in the language if exists in preview.

Parameters:

language - Language to use to build the page URL.

Returns:

URL to current page in the language, empty string when does not exists or cannot build it.

getCanonicalURL

String getCanonicalURL()
                throws com.terminalfour.publish.PublishException,
                       com.terminalfour.tag.parser.TagParserException

Throws:

com.terminalfour.publish.PublishException

com.terminalfour.tag.parser.TagParserException

getActionURL

String getActionURL(IPageAPI.PageActions action)

processSnippet

String processSnippet(String layout,
                      boolean useMetaContent)
               throws com.terminalfour.publish.PublishException

Throws:

com.terminalfour.publish.PublishException