com.tcdng.unify.web.ui.widget.data.TreePolicy 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.widget.data;

import com.tcdng.unify.core.UnifyException;
import com.tcdng.unify.core.data.MarkedTree.MarkedTreePolicy;

/**
 * Handles rules relating to a tree.
 * 
 * @author The Code Department
 * @since 1.0
 */
public interface TreePolicy extends MarkedTreePolicy {

    /**
     * Gets a tree item caption based on this policy for supplied category and tree
     * item.
     * 
     * @param category
     *            the tree item category
     * @param item
     *            the tree item
     * @return the tree item caption
     * @throws UnifyException
     *             if an error occurs
     */
    String getTreeItemCaption(TreeItemTypeInfo category, Object item) throws UnifyException;

    /**
     * Get the tree item expander.
     * 
     * @return the tree item expander
     * @throws UnifyException
     *             if an error occurs
     */
    TreeItemUpdater getTreeItemExpander() throws UnifyException;

    /**
     * Get the tree item collapser.
     * 
     * @return the tree item collapser
     * @throws UnifyException
     *             if an error occurs
     */
    TreeItemUpdater getTreeItemCollapser() throws UnifyException;
}