AssignedEntitiesExplorer.java

/*
 * Copyright 2016 Red Hat, Inc. and/or its affiliates.
 *  
 * 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.uberfire.ext.security.management.client.widgets.management.editor;

import com.google.gwt.user.client.ui.IsWidget;
import org.uberfire.ext.security.management.client.widgets.management.list.EntitiesList;

/**
 * <p>An explorer view contract for showing the assigned users, groups or roles for a given entity.</p>
 * @since 0.8.0
 */
public interface AssignedEntitiesExplorer extends IsWidget {

    /**
     * Configure the view header and text when no assigned entities are added.
     * @param header The header text.
     * @param entitiesList The entities list view instance.
     * @return The view implementation.
     */
    AssignedEntitiesExplorer configure(final String header,
                                       final EntitiesList.View entitiesList);

    /**
     * Clears the view..
     * @return The view instance.
     */
    AssignedEntitiesExplorer clear();
}