com.day.cq.wcm.api.TemplateManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2015 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 *
 **************************************************************************/
package com.day.cq.wcm.api;

import java.util.List;
import java.util.function.Predicate;

import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ValueMap;
import org.osgi.annotation.versioning.ProviderType;

import com.day.cq.wcm.api.components.ComponentContext;

/**
 * Template Manger API.
 *
 * API for managing 'authored' templates and related components.
 */
@ProviderType
public interface TemplateManager {

    /**
     * Creates a new template
     * @param parentPath the parent path
     * @param templateName the template name
     * @param templateProperties properties of template
     * @param templateType type of template
     * @return Template
     * @throws WCMException is thrown if the template is still used on pages.
     */
    public Template createTemplate(String parentPath, String templateType, String templateName, ValueMap templateProperties) throws WCMException;

    /**
     * @param template the template
     *
     * @throws com.day.cq.wcm.api.WCMException is thrown if the template is still used on pages.
     */
    public void deleteTemplate(Template template) throws WCMException;

    /**
     * @param template the template
     *
     * @return Containing Pages
     */
    public List getContainingPages(Template template);


    /**
     * @param componentContext the component context
     *
     * @return list of structureResources
     */
    public List getStructureResources(ComponentContext componentContext);

    /**
     * @param resource the resource that contains template
     *
     * @return Template
     */
    public Template getContainingTemplate(Resource resource);

    /**
     * @return List of All Templates
     */
    public List