org.infoglue.cms.controllers.delivery.kernel.impl.simple
Interface TemplateController

All Known Implementing Classes:

BasicTemplateController

public interface TemplateController

Method Summary

java.lang.String	getArchiveBaseUrl(java.lang.Integer contentId, java.lang.String assetKey) This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset.
java.lang.String	getArchiveBaseUrl(java.lang.String contentBindningName, int index, java.lang.String assetKey) This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset.
java.lang.String	getArchiveBaseUrl(java.lang.String contentBindningName, java.lang.String assetKey) This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset.
java.util.Vector	getArchiveEntries(java.lang.Integer contentId, java.lang.String assetKey)
java.lang.Integer	getAssetFileSize(java.lang.Integer contentId)
java.lang.Integer	getAssetFileSize(java.lang.Integer contentId, java.lang.String assetKey)
java.lang.Integer	getAssetFileSize(java.lang.String contentBindningName, int index)
java.lang.Integer	getAssetFileSize(java.lang.String contentBindningName, java.lang.String assetKey)
java.util.Collection	getAssetKeys(java.lang.String contentBindningName) This method deliveres a list of strings which represents all assetKeys for a content.
java.lang.String	getAssetUrl(java.lang.Integer contentId) This method deliveres a String with the URL to the digital asset asked for.
java.lang.String	getAssetUrl(java.lang.Integer contentId, java.lang.String assetKey) This method deliveres a String with the URL to the digital asset asked for.
java.lang.String	getAssetUrl(java.lang.String contentBindningName) This method deliveres a String with the URL to the digital asset asked for.
java.lang.String	getAssetUrl(java.lang.String contentBindningName, int index) This method deliveres a String with the URL to the digital asset asked for.
java.lang.String	getAssetUrl(java.lang.String contentBindningName, java.lang.String assetKey) This method deliveres a String with the URL to the digital asset asked for.
java.util.List	getAvailableLanguages() This method returns a list of all languages available on the current site/repository.
org.infoglue.cms.entities.content.ContentVO	getBoundContent(java.lang.String structureBindningName) The method returns a single ContentVO-objects that is the bound content of named binding.
java.util.List	getBoundContents(java.lang.String structureBindningName) The method returns a list of ContentVO-objects that is the bound content of named binding.
java.util.List	getBoundFolderContents(java.lang.Integer siteNodeId, java.lang.String structureBindningName, boolean searchRecursive, java.lang.String sortAttribute, java.lang.String sortOrder) The method returns a list of ContentVO-objects that is children to the bound content of named binding on the siteNode sent in.
java.util.List	getBoundFolderContents(java.lang.String structureBindningName, boolean searchRecursive, java.lang.String sortAttribute, java.lang.String sortOrder) The method returns a list of ContentVO-objects that is children to the bound content of named binding.
WebPage	getBoundPage(java.lang.String structureBindningName, int position) The method returns a list of WebPage-objects that is the bound sitenodes of named binding.
java.util.List	getBoundPages(java.lang.Integer siteNodeId, java.lang.String structureBindningName) This methods get a list of bound pages with the structureBindningName sent in which resides on the siteNodeId sent in.
java.util.List	getBoundPages(java.lang.String structureBindningName)
BrowserBean	getBrowserBean() Getter for the browserBean which supplies information about the users browser, OS and other stuff.
java.util.List	getChildPages() The method returns a list of WebPage-objects that is the children of the current siteNode.
ColorHelper	getColorHelper() This method gets the color utility.
ComponentLogic	getComponentLogic() This method gets a component logic helper object.
org.infoglue.cms.entities.content.ContentVO	getContent() Getter for the current content
java.lang.String	getContentAttribute(java.lang.Integer contentId, java.lang.String attributeName) This method deliveres a String with the content-attribute asked for.
java.lang.String	getContentAttribute(java.lang.Integer contentId, java.lang.String attributeName, boolean clean) This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.
java.lang.String	getContentAttribute(java.lang.String attributeName) This method deliveres a String with the content-attribute asked for if it exists in the content defined in the url-parameter contentId.
java.lang.String	getContentAttribute(java.lang.String contentBindningName, java.lang.String attributeName) This method deliveres a String with the content-attribute asked for.
java.lang.String	getContentAttributeAsImageUrl(java.lang.Integer contentId, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.awt.Color foregroundColor, java.awt.Color backgroundColor)
java.lang.String	getContentAttributeAsImageUrl(java.lang.Integer contentId, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.lang.String foregroundColor, java.lang.String backgroundColor)
java.lang.String	getContentAttributeAsImageUrl(java.lang.String contentBindningName, java.lang.String attributeName, int canvasWidth, int canvasHeight) This method deliveres a String with the content-attribute asked for generated as a gif-file.
java.lang.String	getContentAttributeAsImageUrl(java.lang.String contentBindningName, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.awt.Color foregroundColor, java.awt.Color backgroundColor)
java.lang.String	getContentAttributeAsImageUrl(java.lang.String contentBindningName, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.lang.String foregroundColor, java.lang.String backgroundColor)
java.lang.Integer	getContentId() Getter for the contentId
org.infoglue.cms.entities.management.ContentTypeDefinitionVO	getContentTypeDefinitionVO(java.lang.Integer contentId) The method returns the ContentTypeVO-objects of the given contentId.
java.lang.String	getCurrentPagePath() This method constructs a string representing the path to the page with respect to where in the structure the page is.
java.lang.String	getCurrentPageUrl() This method deliveres a new url pointing to the same address as now but in the language corresponding to the code sent in.
java.lang.String	getEncodedUrl(java.lang.String s, java.lang.String enc)
FontHelper	getFontHelper() This method gets the color utility.
boolean	getHasLocalizedVersion(java.lang.Integer contentId) This method return true if a localized version with the current language exist
boolean	getIsPageCacheDisabled() This method returns true if the page in question (ie sitenode) has page-caching disabled.
boolean	getIsPageProtected() This method returns true if the page in question (ie sitenode) has it's protected property enabled.
boolean	getIsParentToCurrent(java.lang.Integer siteNodeId) This method helps us find out if the current site node is the same or a child to the sent in one.
java.lang.Integer	getLanguageId() Getter for the languageId
java.util.List	getLocalizedBoundPages(java.lang.String structureBindningName) The method returns a list of WebPage-objects that is the bound sitenodes of named binding.
MathHelper	getMathHelper() This method gets the math utility.
java.util.List	getNodeAvailableLanguages() This method returns a list of all languages available on the current sitenode.
java.util.List	getNodeAvailableLanguages(java.lang.Integer siteNodeId)
java.text.NumberFormat	getNumberFormatHelper() This method gets the NumberFormat instance with the proper locale.
java.lang.Object	getObjectWithName(java.lang.String classname)
java.lang.String	getPageBaseUrl(java.lang.String structureBindningName) This method deliveres a String with the URL to the page asked for.
java.lang.String	getPageContentType() This method returns the contenttype this page should return.
java.lang.String	getPageNavTitle(java.lang.Integer siteNodeId) This method deliveres a String with the Navigation title the page asked for has.
java.lang.String	getPageNavTitle(java.lang.String structureBindningName) This method deliveres a String with the Navigation title the page asked for has.
java.lang.String	getPageNavTitle(java.lang.String structureBindningName, int index) This method deliveres a String with the Navigation title the page asked for has.
java.lang.String	getPageTitle() This method deliveres a String with the Navigation title the page the user are on has.
java.lang.String	getPageUrl(java.lang.Integer siteNodeId, java.lang.Integer languageId, java.lang.Integer contentId) This method deliveres a new url pointing to the same address as now but with new parameters.
java.lang.String	getPageUrl(java.lang.String structureBindningName) This method deliveres a String with the URL to the page asked for.
java.lang.String	getPageUrl(java.lang.String structureBindningName, java.lang.Integer contentId) This method deliveres a String with the URL to the page asked for.
java.lang.String	getPageUrl(java.lang.String structureBindningName, int position, java.lang.Integer contentId) This method deliveres a String with the URL to the page asked for.
java.lang.String	getPageUrl(WebPage webpage, java.lang.Integer contentId) This method just gets a new URL but with the given contentId in it.
java.lang.String	getPageUrlAfterLanguageChange(java.lang.String languageCode) This method deliveres a new url pointing to the same address as now but in the language corresponding to the code sent in.
java.lang.String	getPageUrlOnPosition(java.lang.String structureBindningName, int position) This method deliveres a String with the URL to the page asked for.
java.lang.String	getParsedContentAttribute(java.lang.Integer contentId, java.lang.String attributeName) This method deliveres a String with the content-attribute asked for after it has been parsed and all special tags have been converted.
java.lang.String	getParsedContentAttribute(java.lang.String attributeName) This method deliveres a String with the content-attribute asked for after it has been parsed and all special tags have been converted.
java.lang.String	getParsedContentAttribute(java.lang.String contentBindningName, java.lang.String attributeName) This method deliveres a String with the content-attribute asked for after it has been parsed and all special tags have been converted.
java.util.Enumeration	getRequestParamenterNames() Getter for request-parameters
java.lang.String	getRequestParameter(java.lang.String parameterName) Getter for request-parameter
java.lang.String[]	getRequestParameterValues(java.lang.String parameterName) Getter for request-parameters
java.lang.Integer	getSiteNodeId() Getter for the siteNodeId
java.lang.Integer	getSiteNodeId(java.lang.String structureBindningName) Getter for the siteNodeId on a specific bound page
java.lang.String	getStringAsImageUrl(java.lang.String text, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.awt.Color foregroundColor, java.awt.Color backgroundColor) This method deliveres a String with the content-attribute asked for generated as a png-file.
java.lang.String	getTemplateAttributeName()
TemplateController	getTemplateController(java.lang.Integer siteNodeId, java.lang.Integer languageId, java.lang.Integer contentId) This method should be much more sophisticated later and include a check to see if there is a digital asset uploaded which is more specialized and can be used to act as serverside logic to the template.
TemplateController	getTemplateController(java.lang.Integer siteNodeId, java.lang.Integer languageId, java.lang.Integer contentId, javax.servlet.http.HttpServletRequest request)
java.lang.String	getUrlContent(java.lang.String url) This method fetches a given URL contents.
java.lang.String	getUrlContent(java.lang.String url, boolean includeRequest) This method fetches a given URL contents.
org.infoglue.cms.applications.common.VisualFormatter	getVisualFormatter() This method gets the formatter object that helps with formatting of data.
java.lang.String	include(java.lang.String contentBindningName, java.lang.String attributeName) This method allows the current template to include another template which is also rendered in the current context as if it were a part.
java.lang.String	include(java.lang.String contentBindningName, java.lang.String attributeName, boolean cacheInclude)
java.lang.String	include(java.lang.String contentBindningName, java.lang.String attributeName, boolean cacheInclude, java.lang.String cName, java.lang.Object cObject) This method allows the current template to include another template which is also rendered in the current context as if it were a part.
java.lang.String	replace(java.lang.String originalString, java.lang.String expressionToReplace, java.lang.String newString) This method lets a user substitute a string located in the page by a regular expression with another string.
java.lang.String	replace(java.lang.String originalString, java.lang.String substring, java.lang.String stringToReplace, java.lang.String newString) This method lets a user substitute a string located in the page by a regular expression with another string.
void	setBrowserBean(BrowserBean browserBean) Setter for the bean which contains information about the users browser.
void	setComponentLogic(ComponentLogic componentLogic) This method gets a component logic helper object.
void	setDeliveryControllers(NodeDeliveryController nodeDeliveryController, ContentDeliveryController contentDeliveryController, IntegrationDeliveryController integrationDeliveryController) Setting to enable us to set initialized versions of the Node and Content delivery Controllers.
void	setHttpRequest(javax.servlet.http.HttpServletRequest request) Setter for the template to get all the parameters from the user.
void	setStandardRequestParameters(java.lang.Integer siteNodeId, java.lang.Integer languageId, java.lang.Integer contentId) Setter for the template to get all the parameters from the user.

Method Detail

getTemplateAttributeName

public java.lang.String getTemplateAttributeName()

setStandardRequestParameters

public void setStandardRequestParameters(java.lang.Integer siteNodeId,
                                         java.lang.Integer languageId,
                                         java.lang.Integer contentId)

Setter for the template to get all the parameters from the user.

setHttpRequest

public void setHttpRequest(javax.servlet.http.HttpServletRequest request)

Setter for the template to get all the parameters from the user.

setBrowserBean

public void setBrowserBean(BrowserBean browserBean)

Setter for the bean which contains information about the users browser.

getSiteNodeId

public java.lang.Integer getSiteNodeId()

Getter for the siteNodeId

getLanguageId

public java.lang.Integer getLanguageId()

Getter for the languageId

getContentId

public java.lang.Integer getContentId()

Getter for the contentId

getComponentLogic

public ComponentLogic getComponentLogic()

This method gets a component logic helper object.

setComponentLogic

public void setComponentLogic(ComponentLogic componentLogic)

This method gets a component logic helper object.

getVisualFormatter

public org.infoglue.cms.applications.common.VisualFormatter getVisualFormatter()

This method gets the formatter object that helps with formatting of data.

getColorHelper

public ColorHelper getColorHelper()

This method gets the color utility.

getFontHelper

public FontHelper getFontHelper()

This method gets the color utility.

getMathHelper

public MathHelper getMathHelper()

This method gets the math utility.

getNumberFormatHelper

public java.text.NumberFormat getNumberFormatHelper()

This method gets the NumberFormat instance with the proper locale.

getContent

public org.infoglue.cms.entities.content.ContentVO getContent()

Getter for the current content

getRequestParamenterNames

public java.util.Enumeration getRequestParamenterNames()

Getter for request-parameters

getRequestParameter

public java.lang.String getRequestParameter(java.lang.String parameterName)

Getter for request-parameter

getRequestParameterValues

public java.lang.String[] getRequestParameterValues(java.lang.String parameterName)

Getter for request-parameters

getBrowserBean

public BrowserBean getBrowserBean()

Getter for the browserBean which supplies information about the users browser, OS and other stuff.

setDeliveryControllers

public void setDeliveryControllers(NodeDeliveryController nodeDeliveryController,
                                   ContentDeliveryController contentDeliveryController,
                                   IntegrationDeliveryController integrationDeliveryController)

Setting to enable us to set initialized versions of the Node and Content delivery Controllers.

getContentAttribute

public java.lang.String getContentAttribute(java.lang.String attributeName)

This method deliveres a String with the content-attribute asked for if it exists in the content defined in the url-parameter contentId.

getContentAttribute

public java.lang.String getContentAttribute(java.lang.String contentBindningName,
                                            java.lang.String attributeName)

This method deliveres a String with the content-attribute asked for. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getContentAttribute

public java.lang.String getContentAttribute(java.lang.Integer contentId,
                                            java.lang.String attributeName,
                                            boolean clean)

This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.

getContentAttribute

public java.lang.String getContentAttribute(java.lang.Integer contentId,
                                            java.lang.String attributeName)

This method deliveres a String with the content-attribute asked for. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getParsedContentAttribute

public java.lang.String getParsedContentAttribute(java.lang.String attributeName)

This method deliveres a String with the content-attribute asked for after it has been parsed and all special tags have been converted. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getParsedContentAttribute

public java.lang.String getParsedContentAttribute(java.lang.String contentBindningName,
                                                  java.lang.String attributeName)

This method deliveres a String with the content-attribute asked for after it has been parsed and all special tags have been converted. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getParsedContentAttribute

public java.lang.String getParsedContentAttribute(java.lang.Integer contentId,
                                                  java.lang.String attributeName)

This method deliveres a String with the content-attribute asked for after it has been parsed and all special tags have been converted. The attribute is fetched from the specified content.

getAssetKeys

public java.util.Collection getAssetKeys(java.lang.String contentBindningName)

This method deliveres a list of strings which represents all assetKeys for a content.

getAssetUrl

public java.lang.String getAssetUrl(java.lang.String contentBindningName)

This method deliveres a String with the URL to the digital asset asked for. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getEncodedUrl

public java.lang.String getEncodedUrl(java.lang.String s,
                                      java.lang.String enc)

getAssetUrl

public java.lang.String getAssetUrl(java.lang.Integer contentId)

This method deliveres a String with the URL to the digital asset asked for.

getAssetUrl

public java.lang.String getAssetUrl(java.lang.Integer contentId,
                                    java.lang.String assetKey)

This method deliveres a String with the URL to the digital asset asked for.

getAssetUrl

public java.lang.String getAssetUrl(java.lang.String contentBindningName,
                                    int index)

This method deliveres a String with the URL to the digital asset asked for. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getAssetUrl

public java.lang.String getAssetUrl(java.lang.String contentBindningName,
                                    java.lang.String assetKey)

This method deliveres a String with the URL to the digital asset asked for. As the siteNode can have multiple bindings as well as a content as a parameter this parameter requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getAssetFileSize

public java.lang.Integer getAssetFileSize(java.lang.Integer contentId)

getAssetFileSize

public java.lang.Integer getAssetFileSize(java.lang.Integer contentId,
                                          java.lang.String assetKey)

getAssetFileSize

public java.lang.Integer getAssetFileSize(java.lang.String contentBindningName,
                                          int index)

getAssetFileSize

public java.lang.Integer getAssetFileSize(java.lang.String contentBindningName,
                                          java.lang.String assetKey)

getArchiveBaseUrl

public java.lang.String getArchiveBaseUrl(java.lang.String contentBindningName,
                                          java.lang.String assetKey)

This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset.

getArchiveBaseUrl

public java.lang.String getArchiveBaseUrl(java.lang.Integer contentId,
                                          java.lang.String assetKey)

This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset.

getArchiveEntries

public java.util.Vector getArchiveEntries(java.lang.Integer contentId,
                                          java.lang.String assetKey)

getArchiveBaseUrl

public java.lang.String getArchiveBaseUrl(java.lang.String contentBindningName,
                                          int index,
                                          java.lang.String assetKey)

This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset.

getContentAttributeAsImageUrl

public java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName,
                                                      java.lang.String attributeName,
                                                      int canvasWidth,
                                                      int canvasHeight)

This method deliveres a String with the content-attribute asked for generated as a gif-file. That is - the text is printed as an image. You can specify a number of things to control the generation. Just experiment and the names are pretty much self explainatory. The method checks if a previous file exists that has the same attributes as the wanted one and if so - we don't generate it again. TODO: consider implement a more general getTextAsImageUrl so we dont need a zillion different variants for different ways to access the contentAttribute. (we need to calculate a unique string from the text and all the other stuff.)

getContentAttributeAsImageUrl

public java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName,
                                                      java.lang.String attributeName,
                                                      int canvasWidth,
                                                      int canvasHeight,
                                                      int textStartPosX,
                                                      int textStartPosY,
                                                      int textWidth,
                                                      int textHeight,
                                                      java.lang.String fontName,
                                                      int fontStyle,
                                                      int fontSize,
                                                      java.lang.String foregroundColor,
                                                      java.lang.String backgroundColor)

getContentAttributeAsImageUrl

public java.lang.String getContentAttributeAsImageUrl(java.lang.Integer contentId,
                                                      java.lang.String attributeName,
                                                      int canvasWidth,
                                                      int canvasHeight,
                                                      int textStartPosX,
                                                      int textStartPosY,
                                                      int textWidth,
                                                      int textHeight,
                                                      java.lang.String fontName,
                                                      int fontStyle,
                                                      int fontSize,
                                                      java.lang.String foregroundColor,
                                                      java.lang.String backgroundColor)

getContentAttributeAsImageUrl

public java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName,
                                                      java.lang.String attributeName,
                                                      int canvasWidth,
                                                      int canvasHeight,
                                                      int textStartPosX,
                                                      int textStartPosY,
                                                      int textWidth,
                                                      int textHeight,
                                                      java.lang.String fontName,
                                                      int fontStyle,
                                                      int fontSize,
                                                      java.awt.Color foregroundColor,
                                                      java.awt.Color backgroundColor)

getContentAttributeAsImageUrl

public java.lang.String getContentAttributeAsImageUrl(java.lang.Integer contentId,
                                                      java.lang.String attributeName,
                                                      int canvasWidth,
                                                      int canvasHeight,
                                                      int textStartPosX,
                                                      int textStartPosY,
                                                      int textWidth,
                                                      int textHeight,
                                                      java.lang.String fontName,
                                                      int fontStyle,
                                                      int fontSize,
                                                      java.awt.Color foregroundColor,
                                                      java.awt.Color backgroundColor)

getStringAsImageUrl

public java.lang.String getStringAsImageUrl(java.lang.String text,
                                            int canvasWidth,
                                            int canvasHeight,
                                            int textStartPosX,
                                            int textStartPosY,
                                            int textWidth,
                                            int textHeight,
                                            java.lang.String fontName,
                                            int fontStyle,
                                            int fontSize,
                                            java.awt.Color foregroundColor,
                                            java.awt.Color backgroundColor)

This method deliveres a String with the content-attribute asked for generated as a png-file. That is - the text is printed as an image. You can specify a number of things to control the generation. Just experiment and the names are pretty much self explainatory. The method checks if a previous file exists that has the same attributes as the wanted one and if so - we don't generate it again.

getPageUrl

public java.lang.String getPageUrl(java.lang.String structureBindningName)

This method deliveres a String with the URL to the page asked for. As the siteNode can have multiple bindings the method requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getPageUrl

public java.lang.String getPageUrl(WebPage webpage,
                                   java.lang.Integer contentId)

This method just gets a new URL but with the given contentId in it.

getPageBaseUrl

public java.lang.String getPageBaseUrl(java.lang.String structureBindningName)

This method deliveres a String with the URL to the page asked for. As the siteNode can have multiple bindings the method requires a bindingName which refers to the AvailableServiceBinding.name-attribute.

getSiteNodeId

public java.lang.Integer getSiteNodeId(java.lang.String structureBindningName)

Getter for the siteNodeId on a specific bound page

getPageUrl

public java.lang.String getPageUrl(java.lang.String structureBindningName,
                                   java.lang.Integer contentId)

This method deliveres a String with the URL to the page asked for. As the siteNode can have multiple bindings the method requires a bindingName which refers to the AvailableServiceBinding.name-attribute. This method also allows the user to specify that the content is important. This method is mostly used for master/detail-pages.

getPageUrlOnPosition

public java.lang.String getPageUrlOnPosition(java.lang.String structureBindningName,
                                             int position)

This method deliveres a String with the URL to the page asked for. As the siteNode can have multiple bindings the method requires a bindingName and also allows the user to specify a special siteNode in an ordered collection. which refers to the AvailableServiceBinding.name-attribute.

getPageUrl

public java.lang.String getPageUrl(java.lang.String structureBindningName,
                                   int position,
                                   java.lang.Integer contentId)

This method deliveres a String with the URL to the page asked for. As the siteNode can have multiple bindings the method requires a bindingName and also allows the user to specify a special siteNode in an ordered collection. which refers to the AvailableServiceBinding.name-attribute. This method also allows the user to specify that the content is important. This method is mostly used for master/detail-pages.

getCurrentPageUrl

public java.lang.String getCurrentPageUrl()

This method deliveres a new url pointing to the same address as now but in the language corresponding to the code sent in.

getPageUrl

public java.lang.String getPageUrl(java.lang.Integer siteNodeId,
                                   java.lang.Integer languageId,
                                   java.lang.Integer contentId)

This method deliveres a new url pointing to the same address as now but with new parameters.

getCurrentPagePath

public java.lang.String getCurrentPagePath()

This method constructs a string representing the path to the page with respect to where in the structure the page is. It also takes the page title into consideration.

getPageUrlAfterLanguageChange

public java.lang.String getPageUrlAfterLanguageChange(java.lang.String languageCode)

This method deliveres a new url pointing to the same address as now but in the language corresponding to the code sent in.

getPageTitle

public java.lang.String getPageTitle()

This method deliveres a String with the Navigation title the page the user are on has. The navigation-title is fetched from the meta-info-content bound to the site node.

getPageNavTitle

public java.lang.String getPageNavTitle(java.lang.String structureBindningName)

This method deliveres a String with the Navigation title the page asked for has. As the siteNode can have multiple bindings the method requires a bindingName which refers to the AvailableServiceBinding.name-attribute. The navigation-title is fetched from the meta-info-content bound to the site node.

getPageNavTitle

public java.lang.String getPageNavTitle(java.lang.Integer siteNodeId)

This method deliveres a String with the Navigation title the page asked for has. The navigation-title is fetched from the meta-info-content bound to the site node.

getPageNavTitle

public java.lang.String getPageNavTitle(java.lang.String structureBindningName,
                                        int index)

This method deliveres a String with the Navigation title the page asked for has. As the siteNode can have multiple bindings the method requires a bindingName and a collection index. The navigation-title is fetched from the meta-info-content bound to the site node.

getIsPageCacheDisabled

public boolean getIsPageCacheDisabled()

This method returns true if the page in question (ie sitenode) has page-caching disabled. This is essential to turn off when you have a dynamic page like an external application or searchresult.

getPageContentType

public java.lang.String getPageContentType()

This method returns the contenttype this page should return. This is important when sending assets or css:contents.

getIsPageProtected

public boolean getIsPageProtected()

This method returns true if the page in question (ie sitenode) has it's protected property enabled. This is essential when checking if we should authenticate users before allowing them access.

getAvailableLanguages

public java.util.List getAvailableLanguages()

This method returns a list of all languages available on the current site/repository.

getNodeAvailableLanguages

public java.util.List getNodeAvailableLanguages()

This method returns a list of all languages available on the current sitenode. The logic is that we check which languages are found in the meta-content in the current mode.

getNodeAvailableLanguages

public java.util.List getNodeAvailableLanguages(java.lang.Integer siteNodeId)

getChildPages

public java.util.List getChildPages()

The method returns a list of WebPage-objects that is the children of the current siteNode. The method is great for navigation-purposes on a structured site.

getBoundPages

public java.util.List getBoundPages(java.lang.String structureBindningName)

getBoundPages

public java.util.List getBoundPages(java.lang.Integer siteNodeId,
                                    java.lang.String structureBindningName)

This methods get a list of bound pages with the structureBindningName sent in which resides on the siteNodeId sent in.

getLocalizedBoundPages

public java.util.List getLocalizedBoundPages(java.lang.String structureBindningName)

The method returns a list of WebPage-objects that is the bound sitenodes of named binding. The method is great for navigation-purposes on any site. We also filter out all pages that don't have a localized version of the page meta-content.

getBoundContent

public org.infoglue.cms.entities.content.ContentVO getBoundContent(java.lang.String structureBindningName)

The method returns a single ContentVO-objects that is the bound content of named binding. It's used for getting one content.

getBoundContents

public java.util.List getBoundContents(java.lang.String structureBindningName)

The method returns a list of ContentVO-objects that is the bound content of named binding. The method is great for collection-pages on any site.

getBoundFolderContents

public java.util.List getBoundFolderContents(java.lang.String structureBindningName,
                                             boolean searchRecursive,
                                             java.lang.String sortAttribute,
                                             java.lang.String sortOrder)

The method returns a list of ContentVO-objects that is children to the bound content of named binding. The method is great for collection-pages on any site where you want to bind to a folder containing all contents to list. You can also state if the method should recurse into subfolders and how the contents should be sorted. The recursion only deals with three levels at the moment for performance-reasons.

getBoundFolderContents

public java.util.List getBoundFolderContents(java.lang.Integer siteNodeId,
                                             java.lang.String structureBindningName,
                                             boolean searchRecursive,
                                             java.lang.String sortAttribute,
                                             java.lang.String sortOrder)

The method returns a list of ContentVO-objects that is children to the bound content of named binding on the siteNode sent in. The method is great for collection-pages on any site where you want to bind to a folder containing all contents to list. You can also state if the method should recurse into subfolders and how the contents should be sorted. The recursion only deals with three levels at the moment for performance-reasons.

getContentTypeDefinitionVO

public org.infoglue.cms.entities.management.ContentTypeDefinitionVO getContentTypeDefinitionVO(java.lang.Integer contentId)

The method returns the ContentTypeVO-objects of the given contentId.

getBoundPage

public WebPage getBoundPage(java.lang.String structureBindningName,
                            int position)

The method returns a list of WebPage-objects that is the bound sitenodes of named binding. The method is great for navigation-purposes on any site. Improve later so the list is cached once for every instance. Otherwise we fetch the whole list again and its not necessairy as this controller only concerns one request.

include

public java.lang.String include(java.lang.String contentBindningName,
                                java.lang.String attributeName)

This method allows the current template to include another template which is also rendered in the current context as if it were a part. The method assumes that the result can be cached. Use the other include method if you wish to be able to control if the result is cached or not.

include

public java.lang.String include(java.lang.String contentBindningName,
                                java.lang.String attributeName,
                                boolean cacheInclude)

include

public java.lang.String include(java.lang.String contentBindningName,
                                java.lang.String attributeName,
                                boolean cacheInclude,
                                java.lang.String cName,
                                java.lang.Object cObject)

This method allows the current template to include another template which is also rendered in the current context as if it were a part. Use this method if you wish to be able to control if the result is cached or not.

getUrlContent

public java.lang.String getUrlContent(java.lang.String url)

This method fetches a given URL contents. This means that we can include a external url's contents in our application.

getUrlContent

public java.lang.String getUrlContent(java.lang.String url,
                                      boolean includeRequest)

This method fetches a given URL contents. This means that we can include a external url's contents in our application. This second method is used to not send extra params through.

getObjectWithName

public java.lang.Object getObjectWithName(java.lang.String classname)

replace

public java.lang.String replace(java.lang.String originalString,
                                java.lang.String expressionToReplace,
                                java.lang.String newString)

This method lets a user substitute a string located in the page by a regular expression with another string. Very useful in certain situations.

replace

public java.lang.String replace(java.lang.String originalString,
                                java.lang.String substring,
                                java.lang.String stringToReplace,
                                java.lang.String newString)

This method lets a user substitute a string located in the page by a regular expression with another string. This method also lets the user specify a subpart of the string to be able to be more specific. Very useful in certain situations.

getIsParentToCurrent

public boolean getIsParentToCurrent(java.lang.Integer siteNodeId)

This method helps us find out if the current site node is the same or a child to the sent in one. So if the current page is a child(in the entire hierarchy below) below the siteNode sent in the method returns true. Useful for navigational purposes.

getHasLocalizedVersion

public boolean getHasLocalizedVersion(java.lang.Integer contentId)

This method return true if a localized version with the current language exist

getTemplateController

public TemplateController getTemplateController(java.lang.Integer siteNodeId,
                                                java.lang.Integer languageId,
                                                java.lang.Integer contentId)
                                         throws org.infoglue.cms.exception.SystemException,
                                                java.lang.Exception

This method should be much more sophisticated later and include a check to see if there is a digital asset uploaded which is more specialized and can be used to act as serverside logic to the template.

org.infoglue.cms.exception.SystemException

java.lang.Exception

getTemplateController

public TemplateController getTemplateController(java.lang.Integer siteNodeId,
                                                java.lang.Integer languageId,
                                                java.lang.Integer contentId,
                                                javax.servlet.http.HttpServletRequest request)
                                         throws org.infoglue.cms.exception.SystemException,
                                                java.lang.Exception

org.infoglue.cms.exception.SystemException

java.lang.Exception