IComponentDescriptorProvider.java example

Explorer
jspresso-ce-master
/*
 * Copyright (c) 2005-2016 Vincent Vandenschrick. All rights reserved.
 *
 *  This file is part of the Jspresso framework.
 *
 *  Jspresso is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  Jspresso is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with Jspresso.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.jspresso.framework.model.descriptor;

import java.util.List;

import org.jspresso.framework.security.ISecurable;

/**
 * Marks classes capable of providing a component descriptor.
 *
 * @author Vincent Vandenschrick
 * @param <E>
 *          the concrete component type.
 */
public interface IComponentDescriptorProvider<E> extends IModelDescriptor,
    ISecurable {

  /**
   * Gets the referenced component descriptor.
   *
   * @return the referenced component descriptor.
   */
  IComponentDescriptor<? extends E> getComponentDescriptor();

  /**
   * Get the default queryable properties of this component.
   *
   * @return the default queryable properties of this component.
   */
  List<String> getQueryableProperties();

  /**
   * Get the default rendered properties of this component.
   *
   * @return the default rendered properties of this component.
   */
  List<String> getRenderedProperties();
}