wt.inf.template
Interface ContainerTemplateService

All Known Implementing Classes:

StandardContainerTemplateService

public interface ContainerTemplateService

Methods for manipulating templates.

Supported API: true

Extendable: false

Method Summary

WTContainerTemplate	getContainerTemplate(wt.inf.template.ContainerTemplateDefinition definition) Gets the latest iteration of a template given a container definition.
WTContainerTemplate	getContainerTemplate(WTContainerRef parent, String name, Class containerClass) Gets a template given a name and a container class object.
WTContainerTemplate	getContainerTemplate(WTContainerRef parent, String name, Class containerClass, boolean lookupFlag, String locale) Gets a template given a name and a container class.
WTContainerTemplate	getContainerTemplate(WTContainerRef parent, String name, String containerClassName) Gets a template given a name and a fully qualified container class name.
WTContainerTemplate	getContainerTemplate(WTContainerRef parent, String name, String containerClassName, boolean lookupFlag, String locale) Gets a template given a name and a contaienr class name.
wt.inf.container.WTContainerTemplateRef	getContainerTemplateRef(wt.inf.template.ContainerTemplateDefinition definition) Gets the latest iteration of a template given a container definition.
wt.inf.container.WTContainerTemplateRef	getContainerTemplateRef(WTContainerRef parent, String name, Class containerClass) Gets a template given a name and container class object.
wt.inf.container.WTContainerTemplateRef	getContainerTemplateRef(WTContainerRef parent, String name, Class containerClass, boolean lookup, String locale) Gets a template given a name and a fully qualified container class name.
wt.inf.container.WTContainerTemplateRef	getContainerTemplateRef(WTContainerRef parent, String name, String containerClassName) Gets a template given a name and a fully qualified container class name.
wt.inf.container.WTContainerTemplateRef	getContainerTemplateRef(WTContainerRef parent, String name, String containerClassName, boolean lookupflag, String locale) Gets a template given a name and a fully qualified container class name.
QueryResult	getEnabledTemplateMasters(wt.inf.container.LookupSpec lookupSpec) returns all template masters residing in the passed in container, the locale is the server side locale Supported API: true
QueryResult	getEnabledTemplateMasters(wt.inf.container.LookupSpec lookupSpec, Class containerClass) returns all enabled template masters that reside in the passed in LookupSpec Supported API: true
QueryResult	getEnabledTemplateMasters(wt.inf.container.LookupSpec lookupSpec, Class containerClass, Locale clientLocale) returns all enabled template masters that reside in the passed in container, the result set is ordered by name corresponding to the passed in Locale.
QueryResult	getEnabledTemplateMasters(WTContainerRef parentContainer) returns all template masters residing in the passed in container, the locale is the server side locale Supported API: true
QueryResult	getEnabledTemplateMasters(WTContainerRef parentContainer, Class containerClass) returns all enabled template masters that reside in the passed in container, the result set is ordered by name corresponding to the passed in Locale.
QueryResult	getEnabledTemplateMasters(WTContainerRef parentContainer, Class containerClass, Locale clientLocale) returns all enabled template masters that reside in the passed in container, the result set is ordered by name corresponding to the passed in Locale.

Method Detail

getEnabledTemplateMasters

QueryResult getEnabledTemplateMasters(WTContainerRef parentContainer,
                                      Class containerClass)
                                      throws WTException

returns all enabled template masters that reside in the passed in container, the result set is ordered by name corresponding to the passed in Locale.

Supported API: true

Parameters:

parentContainer -

containerClass -

Returns:

QueryResult

Throws:

WTException

getEnabledTemplateMasters

QueryResult getEnabledTemplateMasters(wt.inf.container.LookupSpec lookupSpec,
                                      Class containerClass)
                                      throws WTException

returns all enabled template masters that reside in the passed in LookupSpec

Supported API: true

Parameters:

lookupSpec -

containerClass -

Returns:

QueryResult

Throws:

WTException

getEnabledTemplateMasters

QueryResult getEnabledTemplateMasters(WTContainerRef parentContainer,
                                      Class containerClass,
                                      Locale clientLocale)
                                      throws WTException

returns all enabled template masters that reside in the passed in container, the result set is ordered by name corresponding to the passed in Locale.

Supported API: true

Parameters:

parentContainer -

containerClass -

clientLocale -

Returns:

QueryResult

Throws:

WTException

getEnabledTemplateMasters

QueryResult getEnabledTemplateMasters(wt.inf.container.LookupSpec lookupSpec,
                                      Class containerClass,
                                      Locale clientLocale)
                                      throws WTException

returns all enabled template masters that reside in the passed in container, the result set is ordered by name corresponding to the passed in Locale.

Supported API: true

Parameters:

lookupSpec -

containerClass -

clientLocale -

Returns:

QueryResult

Throws:

WTException

getEnabledTemplateMasters

QueryResult getEnabledTemplateMasters(WTContainerRef parentContainer)
                                      throws WTException

returns all template masters residing in the passed in container, the locale is the server side locale

Supported API: true

Parameters:

parentContainer -

Returns:

QueryResult

Throws:

WTException

getEnabledTemplateMasters

QueryResult getEnabledTemplateMasters(wt.inf.container.LookupSpec lookupSpec)
                                      throws WTException

returns all template masters residing in the passed in container, the locale is the server side locale

Supported API: true

Parameters:

lookupSpec -

Returns:

QueryResult

Throws:

WTException

getContainerTemplateRef

wt.inf.container.WTContainerTemplateRef getContainerTemplateRef(WTContainerRef parent,
                                                                String name,
                                                                Class containerClass)
                                                                throws WTException

Gets a template given a name and container class object. If a template matching the passed in criteria is not found in the target container, a lookup is performed.

Supported API: true

Parameters:

parent -

name -

containerClass - An Exception will be thrown if the class is not a subclass of WTContainer

Returns:

WTContainerTemplateRef

Throws:

WTException

getContainerTemplateRef

wt.inf.container.WTContainerTemplateRef getContainerTemplateRef(WTContainerRef parent,
                                                                String name,
                                                                Class containerClass,
                                                                boolean lookup,
                                                                String locale)
                                                                throws WTException

Gets a template given a name and a fully qualified container class name. This also for restricting the scope of the search to the passed in container, and to a specific locale.

Supported API: true

Parameters:

parent -

name -

containerClass -

lookup - If set to false the search is restricted to the target container, if set to true, a lookup is performed.

locale - This may be null or an empty string.

Returns:

WTContainerTemplateRef

Throws:

WTException

getContainerTemplateRef

wt.inf.container.WTContainerTemplateRef getContainerTemplateRef(WTContainerRef parent,
                                                                String name,
                                                                String containerClassName)
                                                                throws WTException

Gets a template given a name and a fully qualified container class name. If the template is not found, a lookup is performed.

Supported API: true

Parameters:

parent -

name -

containerClassName - An Exception will be thrown if this is not the class name of a subclass of WTContainer

Returns:

WTContainerTemplateRef

Throws:

WTException

getContainerTemplateRef

wt.inf.container.WTContainerTemplateRef getContainerTemplateRef(WTContainerRef parent,
                                                                String name,
                                                                String containerClassName,
                                                                boolean lookupflag,
                                                                String locale)
                                                                throws WTException

Gets a template given a name and a fully qualified container class name.

Supported API: true

Parameters:

parent -

name -

containerClassName -

lookupflag - If the flag is set to false the search is restricted to the target contaner.

locale -

Returns:

WTContainerTemplateRef

Throws:

WTException

getContainerTemplateRef

wt.inf.container.WTContainerTemplateRef getContainerTemplateRef(wt.inf.template.ContainerTemplateDefinition definition)
                                                                throws WTException

Gets the latest iteration of a template given a container definition.

Supported API: true

Parameters:

definition - Either a WTContainerTemplate or a WTContainerTemplateMaster object

Returns:

WTContainerTemplateRef

Throws:

WTException

getContainerTemplate

WTContainerTemplate getContainerTemplate(WTContainerRef parent,
                                         String name,
                                         String containerClassName)
                                         throws WTException

Gets a template given a name and a fully qualified container class name. If a template matching this criteria is not found in the target container a lookup will be performed.

Supported API: true

Parameters:

parent -

name -

containerClassName -

Returns:

WTContainerTemplate

Throws:

WTException

getContainerTemplate

WTContainerTemplate getContainerTemplate(WTContainerRef parent,
                                         String name,
                                         String containerClassName,
                                         boolean lookupFlag,
                                         String locale)
                                         throws WTException

Gets a template given a name and a contaienr class name. This signature allows for filtering by container and locale. By specifying the lookup flag to false, the search is restricted to the passed in template. If it is set to true a lookup is performed that will return the first match to the passed in criteria.

Supported API: true

Parameters:

parent -

name -

containerClassName -

lookupFlag - If set to true a lookup is performed.

locale - If you are only interested in a specific locale pass in a locale this will filter the query, other wise this value may be null or an empty string

Returns:

WTContainerTemplate

Throws:

WTException

getContainerTemplate

WTContainerTemplate getContainerTemplate(WTContainerRef parent,
                                         String name,
                                         Class containerClass)
                                         throws WTException

Gets a template given a name and a container class object. A lookup will be performed if the container matching the passed in criteria is not in the target container

Supported API: true

Parameters:

parent -

name -

containerClass -

Returns:

WTContainerTemplate

Throws:

WTException

getContainerTemplate

WTContainerTemplate getContainerTemplate(wt.inf.template.ContainerTemplateDefinition definition)
                                         throws WTException

Gets the latest iteration of a template given a container definition.

Supported API: true

Parameters:

definition - Either a WTContainerTemplate or a WTContainerTemplateMaster object

Returns:

WTContainerTemplate

Throws:

WTException

getContainerTemplate

WTContainerTemplate getContainerTemplate(WTContainerRef parent,
                                         String name,
                                         Class containerClass,
                                         boolean lookupFlag,
                                         String locale)
                                         throws WTException

Gets a template given a name and a container class. This signature allows for filtering by container and locale

Supported API: true

Parameters:

parent -

name -

containerClass -

lookupFlag - If set to true a lookup is performed.

locale - If you are only interested in a specific locale pass in a locale this will filter the query, other wise this value may be null or an empty string

Returns:

WTContainerTemplate

Throws:

WTException