com.tcdng.unify.web.ui.PagePathInfoRepository Maven / Gradle / Ivy

/*
 * Copyright 2018-2023 The Code Department.
 * 
 * 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 com.tcdng.unify.web.ui;

import com.tcdng.unify.core.UnifyComponent;
import com.tcdng.unify.core.UnifyException;
import com.tcdng.unify.web.ControllerPathParts;
import com.tcdng.unify.web.ui.widget.Page;

/**
 * Page path information repository.
 * 
 * @author The Code Department
 * @since 1.0
 */
public interface PagePathInfoRepository extends UnifyComponent {

	/**
	 * Gets page path information.
	 * 
	 * @param page
	 *            the page object.
	 * 
	 * @return the page path information
	 * @throws UnifyException
	 *             if an error occurs
	 */
	PagePathInfo getPagePathInfo(Page page) throws UnifyException;

	/**
	 * Gets page path information.
	 * 
	 * @param controllerPath
	 *            the controller path
	 * @return the page path information
	 * @throws UnifyException
	 *             if an error occurs
	 */
	PagePathInfo getPagePathInfo(String controllerPath) throws UnifyException;

	/**
	 * Gets the supplied page controller path parts
	 * 
	 * @param page
	 *            the page object
	 * @return the path parts
	 * @throws UnifyException
	 *             if an error occurs
	 */
	ControllerPathParts getControllerPathParts(Page page) throws UnifyException;

    /**
     * Gets controller path parts
     * 
     * @param controllerPath
     *            the path
     * @return the controller path parts
     * @throws UnifyException
     *             if an error occurs
     */
    ControllerPathParts getControllerPathParts(String controllerPath) throws UnifyException;
}