com.fatwire.services

Interface TemplateService

All Superinterfaces:

Service

@Exported
public interface TemplateService
extends Service

The Template Service is the interface providing template related services.

Method Summary

Modifier and Type	Method and Description
TemplatesBean	fetchTemplates(Long site, TypeBean type, List<TemplateBean.Type> templateType, String nameRegex, Integer start, Integer pageSize) Fetches the templates in the specified editorial site as per specified filter criteria and returns paged results.
TemplatesBean	fetchTemplates(Long site, TypeBean type, List<TemplateBean.Type> templateType, String nameRegex, Integer start, Integer pageSize, String deviceGroupSuffix) Fetches the templates in the specified editorial site as per specified filter criteria and returns paged results.
List<ArgumentBean>	getArguments(AssetId assetId) Returns a list containing the arguments associated with a template for the specified asset type.
List<ArgumentBean>	getTemplateArguments(String templateName, String assetType) Returns a list containing the arguments associated with a template for the specified asset type.
List<TemplateBean>	getTemplates(Long site, TypeBean type, List<TemplateBean.Type> templateType, String nameRegex) Returns the templates in the specified editorial site as per specified filter criteria.

Methods inherited from interface com.fatwire.services.Service

getManager, getResponse, setManager

Method Detail

getTemplates

List<TemplateBean> getTemplates(Long site,
                                TypeBean type,
                                List<TemplateBean.Type> templateType,
                                String nameRegex)
                         throws ServiceException

Returns the templates in the specified editorial site as per specified filter criteria.

Parameters:

site - the editorial site for which the templates are being retrieved.

type - filter for a specific asset type and sub-type, or null for Typeless.

templateType - filter for a specific template type.

nameRegex - comma-separated list of regular expression to match the template name against, null for no name restriction.

Returns:

a list containing all templates matching the filter criteria.

Throws:

ServiceException - wraps any exception underlying the service call.

fetchTemplates

TemplatesBean fetchTemplates(Long site,
                             TypeBean type,
                             List<TemplateBean.Type> templateType,
                             String nameRegex,
                             Integer start,
                             Integer pageSize)
                      throws ServiceException

Fetches the templates in the specified editorial site as per specified filter criteria and returns paged results.

Parameters:

site - the editorial site for which the templates are being fetched.

type - filter for a specific asset type and sub-type, or null for Typeless.

templateType - filter for a specific template type.

nameRegex - comma-separated list of regular expression to match the template name against, null for no name restriction.

start - the start index for the paged result.

pageSize - the page size for the result.

Returns:

a list containing all templates matching the filter criteria.

Throws:

ServiceException - wraps any exception underlying the service call.

fetchTemplates

TemplatesBean fetchTemplates(Long site,
                             TypeBean type,
                             List<TemplateBean.Type> templateType,
                             String nameRegex,
                             Integer start,
                             Integer pageSize,
                             String deviceGroupSuffix)
                      throws ServiceException

Fetches the templates in the specified editorial site as per specified filter criteria and returns paged results.

Parameters:

site - the editorial site for which the templates are being fetched.

type - filter for a specific asset type and sub-type, or null for Typeless.

templateType - filter for a specific template type.

nameRegex - comma-separated list of regular expression to match the template name against, null for no name restriction.

start - the start index for the paged result.

pageSize - the page size for the result.

deviceGroupSuffix - The suffix of the selected device's device group.

Returns:

a list containing all templates matching the filter criteria.

Throws:

ServiceException - wraps any exception underlying the service call.

getTemplateArguments

List<ArgumentBean> getTemplateArguments(String templateName,
                                        String assetType)
                                 throws ServiceException

Returns a list containing the arguments associated with a template for the specified asset type.

Parameters:

templateName - name of the temaplate for which the arguments need to be retrieved.

assetType - the asset type for which the templates are to be retrieved.

Returns:

a list containing the arguments associated with this template and the asset type.

Throws:

ServiceException - wraps any exception underlying the service call.

getArguments

List<ArgumentBean> getArguments(AssetId assetId)
                         throws ServiceException

Returns a list containing the arguments associated with a template for the specified asset type.

Parameters:

assetId - AssetId of template,cs element,site entry for which the arguments need to be retrieved.

Returns:

a list containing the arguments associated with this template and the asset type.

Throws:

ServiceException - wraps any exception underlying the service call.