// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package org.apache.tapestry5.internal.services;

import org.apache.tapestry5.http.Link;
import org.apache.tapestry5.internal.structure.Page;
import org.apache.tapestry5.ioc.annotations.UsesOrderedConfiguration;
import org.apache.tapestry5.services.LinkCreationHub;
import org.apache.tapestry5.services.LinkCreationListener2;

/**
 * A source for {@link org.apache.tapestry5.http.Link} objects.
 *
 * @see org.apache.tapestry5.services.LinkCreationListener2
 * @since 5.1.0.0
 */
@UsesOrderedConfiguration(LinkCreationListener2.class)
public interface LinkSource
{
    /**
     * Creates a stateful action link. Action links are built for components. Action links are encoded by the current
     * request (that is, bound to the current request's session, if any).
     *
     * @param page
     *         the page holding the component
     * @param nestedId
     *         the component's qualified id (a sequence of simple ids, separated by dots).
     * @param eventType
     *         the type of event to trigger
     * @param forForm
     *         true if the link is for a form, false otherwise
     * @param context
     *         Additional path data, each value will be converted to a string and appended to the URI @return a
     *         link
     * @see org.apache.tapestry5.ComponentResources#createEventLink(String, Object...)
     */
    Link createComponentEventLink(Page page, String nestedId, String eventType, boolean forForm, Object... context);

    /**
     * Creates a render link for the page. If an activation context is supplied then that context is built into the URI.
     * If no activation context is supplied, then the activation context is obtained from the page itself, by triggering
     * a passivate event on its root component.
     *
     * When the activationContext is an empty array, the targeted page is checked to see if it can provide an activation
     * context. This is accomplished by triggering a "passivate" event on the targeted page. If the override parameter
     * is true, this will not occur (even when the activation context is empty).
     *
     * @param pageName
     *         name of the page to which a link should be created
     * @param override
     *         if true, then the provided activation context is always used even if empty
     * @param pageActivationContext
     *         the activation context for the page
     * @return a link
     * @see org.apache.tapestry5.services.PageRenderLinkSource#createPageRenderLink(String)
     * @see org.apache.tapestry5.services.PageRenderLinkSource#createPageRenderLinkWithContext(String, Object[])
     */
    Link createPageRenderLink(String pageName, boolean override, Object... pageActivationContext);

    /**
     * Returns the hub, used to register and de-register {@link org.apache.tapestry5.services.LinkCreationListener2}s.
     *
     * @return the hub
     */
    LinkCreationHub getLinkCreationHub();
}
