001/*
002 *  Copyright 2015 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.cms.indexing;
017
018import org.ametys.core.ui.Callable;
019
020/**
021 * Component indexing a workspace.
022 */
023public interface WorkspaceIndexer
024{
025    
026    /** The component role. */
027    public static final String ROLE = WorkspaceIndexer.class.getName();
028    
029    /**
030     * Index all the workspaces.
031     * @throws IndexingException If an error occurs while indexing.
032     */
033    @Callable
034    void indexAllWorkspaces() throws IndexingException;
035    
036    /**
037     * Index a workspace.
038     * @param workspaceName The workspace name.
039     * @throws IndexingException If an error occurs while indexing the workspace.
040     */
041    @Callable
042    void index(String workspaceName) throws IndexingException;
043    
044}