com.gentics.contentnode.rest.resource
Interface TemplateResource

All Superinterfaces:
AuthenticatedResource

public interface TemplateResource
extends AuthenticatedResource

Resource used for loading, saving and manipulating GCN templates.


Method Summary
 LocalizationInfo getLocalizationInfo(List<Integer> ids, Integer nodeId)
          Get localization info for a list of templates for a given channel and all master channels
 LocalizationInfo getLocalizationInfo(String id, Integer nodeId)
          Get localization info for a template for a given channel and all master channels
 TagListResponse getTags(String id, Integer skipCount, Integer maxItems, TagSortAttribute sortBy, SortOrder sortOrder, String search)
          Get the list of templatetags for this template
 TemplateLoadResponse load(String id, Integer nodeId)
          Load the template with the given id and return it.
 GenericResponse pushToMaster(Integer id, PushToMasterRequest request)
          Push a template from a channel into a master
 GenericResponse pushToMaster(MultiPushToMasterRequest request)
          Push a list of templates from a channel into a master
 GenericResponse unlocalize(Integer id, UnlocalizeRequest request)
          Unlocalize the given template
 GenericResponse unlocalize(MultiUnlocalizeRequest request)
          Unlocalize templates in a channel
 
Methods inherited from interface com.gentics.contentnode.rest.resource.AuthenticatedResource
setSessionId
 

Method Detail

load

TemplateLoadResponse load(String id,
                          Integer nodeId)
Load the template with the given id and return it.

Parameters:
id - The template id
nodeId - channel id
Returns:

getTags

TagListResponse getTags(String id,
                        Integer skipCount,
                        Integer maxItems,
                        TagSortAttribute sortBy,
                        SortOrder sortOrder,
                        String search)
Get the list of templatetags for this template

Parameters:
id - id of the template. The local or global id
Returns:
response object

pushToMaster

GenericResponse pushToMaster(Integer id,
                             PushToMasterRequest request)
Push a template from a channel into a master

Parameters:
id - id of the template
request - request
Returns:
generic response

pushToMaster

GenericResponse pushToMaster(MultiPushToMasterRequest request)
Push a list of templates from a channel into a master

Parameters:
request - request
Returns:
generic response

unlocalize

GenericResponse unlocalize(Integer id,
                           UnlocalizeRequest request)
Unlocalize the given template

Parameters:
id - id of the template to unlocalize
request - request
Returns:
generic response

unlocalize

GenericResponse unlocalize(MultiUnlocalizeRequest request)
Unlocalize templates in a channel

Parameters:
request - request
Returns:
generic response

getLocalizationInfo

LocalizationInfo getLocalizationInfo(List<Integer> ids,
                                     Integer nodeId)
Get localization info for a list of templates for a given channel and all master channels

Parameters:
ids - list of template ids
nodeId - id of the node to start with
Returns:
localization info

getLocalizationInfo

LocalizationInfo getLocalizationInfo(String id,
                                     Integer nodeId)
Get localization info for a template for a given channel and all master channels

Parameters:
id - id of the template. This can either be the local or global id of the template.
nodeId - id of the node to start with
Returns:
localization info


Copyright © 2015 Gentics Software GmbH. All Rights Reserved.