org.alfresco.module.org_alfresco_module_wcmquickstart.util

Class SiteHelper

java.lang.Object

org.alfresco.module.org_alfresco_module_wcmquickstart.util.SiteHelper

All Implemented Interfaces:

WebSiteModel

public class SiteHelper
extends Object
implements WebSiteModel

Site helper class.

Author:

Brian

Field Summary

Fields inherited from interface org.alfresco.module.org_alfresco_module_wcmquickstart.model.WebSiteModel

ASPECT_HAS_ANCESTORS, ASPECT_TEMPORARY_MULTILINGUAL, ASPECT_WEBASSET, ASSOC_PRIMARY_IMAGE, ASSOC_PUBLISH_TARGET, ASSOC_PUBLISHING_QUEUE, ASSOC_RELEVANT_ASSET, ASSOC_SECONDARY_IMAGE, ASSOC_SUMMARISED_ASSET, ASSOC_WEBASSETS, NAMESPACE, PREFIX, PROCESS_READ_CONTACT, PROP_ANCESTOR_SECTIONS, PROP_AVAILABLE, PROP_AVAILABLE_FROM_DATE, PROP_AVAILABLE_TO_DATE, PROP_AVERAGE_RATING, PROP_COMMENT, PROP_COMMENT_COUNT, PROP_COMMENT_FLAGGED, PROP_CONTAINED_ASSETS, PROP_DERIVED_AVERAGE_RATING, PROP_DERIVED_COMMENT_COUNT, PROP_EXCLUDE_FROM_NAV, PROP_FAILED_ATTEMPTS_COUNT, PROP_FEEDBACK_CONFIG, PROP_FEEDBACK_TYPE, PROP_HOST_NAME, PROP_HOST_PORT, PROP_INHERIT_RENDITION_CONFIG, PROP_INITIALLY_ORPHANED, PROP_IS_DYNAMIC, PROP_LANGUAGE, PROP_MINS_TO_QUERY_REFRESH, PROP_ORDER_INDEX, PROP_PARENT_SECTIONS, PROP_PROCESSED_RATINGS, PROP_PUBLISHED_TIME, PROP_QUERY, PROP_QUERY_LANGUAGE, PROP_QUERY_RESULTS_MAX_SIZE, PROP_QUEUED_NODE, PROP_QUEUED_NODE_FOR_REMOVAL, PROP_RATING, PROP_RATING_PROCESSED, PROP_REFRESH_AT, PROP_RELEVANT_ASSET, PROP_RENDITION_CONFIG, PROP_SECTION_CONFIG, PROP_SITE_LOCALES, PROP_SUMMARISED_ASSET, PROP_TAGS, PROP_TRANSLATION_OF, PROP_VISITOR_EMAIL, PROP_VISITOR_NAME, PROP_WEB_APP_CONTEXT, PROP_WEBSITE_CONFIG, TYPE_ARTICLE, TYPE_IMAGE, TYPE_INDEX_PAGE, TYPE_PUBLISH_QUEUE_ENTRY, TYPE_SECTION, TYPE_VISITOR_FEEDBACK, TYPE_VISITOR_FEEDBACK_SUMMARY, TYPE_WEB_ROOT, TYPE_WEB_SITE, TYPE_WEBASSET_COLLECTION, TYPE_WEBASSET_COLLECTION_FOLDER, TYPE_WEBSITE_CONTAINER

Constructor Summary

Constructors

Constructor and Description
SiteHelper()

Method Summary

Methods

Modifier and Type	Method and Description
org.alfresco.service.cmr.repository.NodeRef	getFeedbackList(String websiteName, String shareSiteName, boolean create)
org.alfresco.service.cmr.repository.NodeRef	getRelevantSection(org.alfresco.service.cmr.repository.NodeRef nodeRef) Gets the section that the node resides within
org.alfresco.service.cmr.repository.NodeRef	getRelevantSection(org.alfresco.service.cmr.repository.NodeRef nodeRef, boolean allowSelf) Gets the section that the node resides within
org.alfresco.service.cmr.site.SiteInfo	getRelevantShareSite(org.alfresco.service.cmr.repository.NodeRef noderef) For the specified node, find the Share site that it is located in (if any)
org.alfresco.service.cmr.repository.NodeRef	getRelevantWebRoot(org.alfresco.service.cmr.repository.NodeRef nodeRef) Gets the web root that the node resides within
org.alfresco.service.cmr.repository.NodeRef	getRelevantWebSite(org.alfresco.service.cmr.repository.NodeRef noderef) Gets the web site that a node resides within
String	getWebAssetURL(org.alfresco.service.cmr.repository.NodeRef nodeRef) Given a webasset, return the full URL calculated from the containing web site.
org.alfresco.service.cmr.repository.NodeRef	getWebSiteContainer(org.alfresco.service.cmr.repository.NodeRef noderef, String containerName) Gets the named site container that a given node reference resides within
List<Locale>	getWebSiteLocales(org.alfresco.service.cmr.repository.NodeRef website)
boolean	isTranslationParentLimitReached(org.alfresco.service.cmr.repository.NodeRef nodeRef) When checking for translation parents for quickstart, should this node (and potentially those above it) be checked or not?
void	renameFeedbackList(org.alfresco.service.cmr.repository.NodeRef feedbackList, String newName)
void	setDefaultWebsiteLocales(List<Locale> defaultWebsiteLocales)
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void	setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) Set the node service
void	setSearchService(org.alfresco.service.cmr.search.SearchService searchService)
void	setSiteService(org.alfresco.service.cmr.site.SiteService siteService) Set the site service

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SiteHelper

public SiteHelper()

Method Detail

setDefaultWebsiteLocales

public void setDefaultWebsiteLocales(List<Locale> defaultWebsiteLocales)

getWebAssetURL

public String getWebAssetURL(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Given a webasset, return the full URL calculated from the containing web site.

Parameters:

nodeRef - node reference

Returns:

String URL

getRelevantShareSite

public org.alfresco.service.cmr.site.SiteInfo getRelevantShareSite(org.alfresco.service.cmr.repository.NodeRef noderef)

For the specified node, find the Share site that it is located in (if any)

Parameters:

noderef -

Returns:

The SiteInfo object representing the relevant Share site or null if the specified node is not within a Share site

getRelevantWebSite

public org.alfresco.service.cmr.repository.NodeRef getRelevantWebSite(org.alfresco.service.cmr.repository.NodeRef noderef)

Gets the web site that a node resides within

Parameters:

noderef - node reference

Returns:

NodeRef web site node reference, null otherwise

getRelevantWebRoot

public org.alfresco.service.cmr.repository.NodeRef getRelevantWebRoot(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Gets the web root that the node resides within

Parameters:

nodeRef - node reference

Returns:

NodeRef web root node reference, null otherwise

getRelevantSection

public org.alfresco.service.cmr.repository.NodeRef getRelevantSection(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Gets the section that the node resides within

Parameters:

nodeRef - node reference

Returns:

NodeRef section node reference, null otherwise

getRelevantSection

public org.alfresco.service.cmr.repository.NodeRef getRelevantSection(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                             boolean allowSelf)

Gets the section that the node resides within

Parameters:

nodeRef - node reference

allowSelf - true if the supplied noderef is included in the "relevant section" test. That is to say that if this flag is true and the supplied node ref identifies a Section then this method will return the supplied node ref.

Returns:

NodeRef section node reference, null otherwise

getWebSiteLocales

public List<Locale> getWebSiteLocales(org.alfresco.service.cmr.repository.NodeRef website)

getWebSiteContainer

public org.alfresco.service.cmr.repository.NodeRef getWebSiteContainer(org.alfresco.service.cmr.repository.NodeRef noderef,
                                                              String containerName)

Gets the named site container that a given node reference resides within

Parameters:

noderef - node reference

containerName - container name

Returns:

NodeRef container node reference, null otherwise

getFeedbackList

public org.alfresco.service.cmr.repository.NodeRef getFeedbackList(String websiteName,
                                                          String shareSiteName,
                                                          boolean create)

renameFeedbackList

public void renameFeedbackList(org.alfresco.service.cmr.repository.NodeRef feedbackList,
                      String newName)

isTranslationParentLimitReached

public boolean isTranslationParentLimitReached(org.alfresco.service.cmr.repository.NodeRef nodeRef)

When checking for translation parents for quickstart, should this node (and potentially those above it) be checked or not?

Parameters:

nodeRef - The node to check for

setSiteService

public void setSiteService(org.alfresco.service.cmr.site.SiteService siteService)

Set the site service

Parameters:

siteService - site service

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Set the node service

Parameters:

nodeService - node service

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

setSearchService

public void setSearchService(org.alfresco.service.cmr.search.SearchService searchService)

setNamespaceService

public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)