org.alfresco.wcm.client

Interface Section

All Superinterfaces:

Resource, Serializable

All Known Implementing Classes:

SectionImpl

public interface Section
extends Resource

Web Site Section Interface

Author:

Roy Wetherall

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_EXCLUDE_FROM_NAV
static String	PROPERTY_REDIRECT_CONFIG
static String	PROPERTY_SECTION_CONFIG Section properties

Fields inherited from interface org.alfresco.wcm.client.Resource

PROPERTY_AUTHOR, PROPERTY_DESCRIPTION, PROPERTY_MODIFIED_TIME, PROPERTY_TITLE

Method Summary

Methods

Modifier and Type	Method and Description
Query	createQuery() A factory method for returning an empty search query object.
Asset	getAsset(String name) Gets the asset with the given name in this section.
AssetCollection	getAssetCollection(String name) Retrieve the named asset collection from this section.
AssetCollection	getAssetCollection(String name, int resultsToSkip, int maxResults)
boolean	getExcludeFromNav() Should this section be excluded from navigation components?
Asset	getIndexPage() Gets a section's index page
String	getPath() Gets the path of the section
Section	getSection(String sectionName) Find a subsection with the specified name
List<Section>	getSections() Gets the child sections.
List<Tag>	getTags() Gets the tags used within this section (and below) order by their usage (most popular first)
String	getTemplate(String type) Gets the template for a given type of asset for this section
Map<String,String>	getTemplateMappings() Get the template mappings for this section
PathResolutionDetails	resolvePath(String path)
SearchResults	search(Query query) Carry out a search for resources below this section
SearchResults	search(String phrase, int maxResults, int resultsToSkip) Carry out a search for resources below this section that contain all the words in the supplied phrase
SearchResults	searchByTag(String tag, int maxResults, int resultsToSkip) Carry out a search for resources below this section that are tagged with the specified tag

Methods inherited from interface org.alfresco.wcm.client.Resource

getContainingSection, getDescription, getId, getName, getProperties, getProperty, getTitle, getType

Field Detail

PROPERTY_SECTION_CONFIG

static final String PROPERTY_SECTION_CONFIG

Section properties

See Also:

Constant Field Values

PROPERTY_EXCLUDE_FROM_NAV

static final String PROPERTY_EXCLUDE_FROM_NAV

See Also:

Constant Field Values

PROPERTY_REDIRECT_CONFIG

static final String PROPERTY_REDIRECT_CONFIG

See Also:

Constant Field Values

Method Detail

getSections

List<Section> getSections()

Gets the child sections.

Returns:

List

child sections

getSection

Section getSection(String sectionName)

Find a subsection with the specified name

Parameters:

sectionName - The name of the section that the caller is asking for

Returns:

The subsection of this section that has the request name (case-sensitive) or null if not found

getTemplateMappings

Map<String,String> getTemplateMappings()

Get the template mappings for this section

Returns:

Map the template mappings. Key/value pairs where the key is the name of the content type and the value is the name of the template to use when rendering content of that type.

getAsset

Asset getAsset(String name)

Gets the asset with the given name in this section.

Parameters:

String - the name of the required asset. If null or empty then the section's index page is returned

Returns:

Asset the named asset if it exists or null otherwise

getTemplate

String getTemplate(String type)

Gets the template for a given type of asset for this section

Parameters:

type - type

Returns:

String template

getPath

String getPath()

Gets the path of the section

Returns:

String url

getIndexPage

Asset getIndexPage()

Gets a section's index page

Returns:

Asset index page for the section

getExcludeFromNav

boolean getExcludeFromNav()

Should this section be excluded from navigation components?

Returns:

search

SearchResults search(Query query)

Carry out a search for resources below this section

Parameters:

query - The query attributes to use

Returns:

The results of the search

search

SearchResults search(String phrase,
                   int maxResults,
                   int resultsToSkip)

Carry out a search for resources below this section that contain all the words in the supplied phrase

Parameters:

phrase - The words to search for. This is considered to be a space-separated set of words that must all appear in an asset for it to match.

maxResults - The maximum number of results to return

resultsToSkip - The number of results to skip over before returning. In combination with maxResults, this is useful for pagination of results. For example, calling this operation with maxResults set to 10 and resultsToSkip set to 0 will return the first "page" of 10 results. Calling it with maxResults set to 10 and resultsToSkip set to 10 will return the second "page" of 10 results, and so on.

Returns:

The results of the search

getTags

List<Tag> getTags()

Gets the tags used within this section (and below) order by their usage (most popular first)

Returns:

the tags

searchByTag

SearchResults searchByTag(String tag,
                        int maxResults,
                        int resultsToSkip)

Carry out a search for resources below this section that are tagged with the specified tag

Parameters:

phrase - The words to search for. This is considered to be a space-separated set of words that must all appear in an asset for it to match.

maxResults - The maximum number of results to return

resultsToSkip - The number of results to skip over before returning. In combination with maxResults, this is useful for pagination of results. For example, calling this operation with maxResults set to 10 and resultsToSkip set to 0 will return the first "page" of 10 results. Calling it with maxResults set to 10 and resultsToSkip set to 10 will return the second "page" of 10 results, and so on.

Returns:

The results of the search

createQuery

Query createQuery()

A factory method for returning an empty search query object.

Returns:

getAssetCollection

AssetCollection getAssetCollection(String name)

Retrieve the named asset collection from this section. Returns null if this section does not have an asset collection with that name.

Parameters:

name -

Returns:

getAssetCollection

AssetCollection getAssetCollection(String name,
                                 int resultsToSkip,
                                 int maxResults)

resolvePath

PathResolutionDetails resolvePath(String path)