com.day.cq.wcm.foundation.forms.FormsManager 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

/*
 * Copyright 1997-2009 Day Management AG
 * Barfuesserplatz 6, 4001 Basel, Switzerland
 * All Rights Reserved.
 *
 * This software is the confidential and proprietary information of
 * Day Management AG, ("Confidential Information"). You shall not
 * disclose such Confidential Information and shall use it only in
 * accordance with the terms of the license agreement you entered into
 * with Day.
 */
package com.day.cq.wcm.foundation.forms;

import java.util.Iterator;

/**
 * The forms manager keeps track of all available actions
 * and constraints.
 */
public interface FormsManager {

    /**
     * Return the paths for all action resources.
     * @return An iterator for paths.
     */
    Iterator getActions();

    /**
     * Return the paths for all constraint resources.
     * @return An iterator for paths.
     */
    Iterator getConstraints();

    /**
     * Return the dialog path (resource path) for the
     * form action.
     * @param resourceType The resource type of the form action
     * @return The full path or null.
     */
    String getDialogPathForAction(String resourceType);

    public static interface ComponentDescription extends Comparable {

        /**
         * Return the resource type for this component.
         *
         * @return resource type
         */
        String getResourceType();

        /**
         * Return the title.
         *
         * @return title
         */
        String getTitle();

        /**
         * Return a hint (text) for this component.
         * @return A hint or null.
         * @since 5.3
         */
        String getHint();
    }
}