com.atlassian.confluence.plugins.soy

Class SectionsForLocationFunction

java.lang.Object

com.atlassian.confluence.plugins.soy.SectionsForLocationFunction

All Implemented Interfaces:

com.atlassian.soy.renderer.SoyFunction, com.atlassian.soy.renderer.SoyServerFunction<Iterable<WebSectionView>>

public class SectionsForLocationFunction
extends Object
implements com.atlassian.soy.renderer.SoyServerFunction<Iterable<WebSectionView>>

A soy server function that retrieves web-sections for a given location.

Usage: {let $sections: sectionsForLocation(contentId, 'system.main.nav') /}

where contentId is used to provide additional information to the WebInterfaceContext. Pass null if the sections are not associated with a specific CEO.

Constructor Summary

Constructors

Constructor and Description
SectionsForLocationFunction(WebViewService webViewService)

Method Summary

Modifier and Type	Method and Description
Iterable<WebSectionView>	apply(Object... args)
String	getName()
Set<Integer>	validArgSizes()

Methods inherited from class java.lang.Object

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

Constructor Detail

SectionsForLocationFunction

public SectionsForLocationFunction(WebViewService webViewService)

Method Detail

getName

public String getName()

Specified by:

getName in interface com.atlassian.soy.renderer.SoyFunction

apply

public Iterable<WebSectionView> apply(Object... args)

Specified by:

apply in interface com.atlassian.soy.renderer.SoyServerFunction<Iterable<WebSectionView>>

validArgSizes

public Set<Integer> validArgSizes()

Specified by:

validArgSizes in interface com.atlassian.soy.renderer.SoyFunction