001    /*
002     *   Licensed to the Apache Software Foundation (ASF) under one
003     *   or more contributor license agreements.  See the NOTICE file
004     *   distributed with this work for additional information
005     *   regarding copyright ownership.  The ASF licenses this file
006     *   to you under the Apache License, Version 2.0 (the
007     *   "License"); you may not use this file except in compliance
008     *   with the License.  You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     *   Unless required by applicable law or agreed to in writing,
013     *   software distributed under the License is distributed on an
014     *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *   KIND, either express or implied.  See the License for the
016     *   specific language governing permissions and limitations
017     *   under the License.
018     *
019     */
020    package org.apache.directory.server.core.changelog;
021    
022    import org.apache.directory.server.core.partition.Partition;
023    
024    
025    
026    /**
027     * TODO TaggableSearchableChangeLogStore.
028     *
029     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
030     * @version $Rev$, $Date$
031     */
032    public interface TaggableSearchableChangeLogStore extends TaggableChangeLogStore, SearchableChangeLogStore
033    {
034        /**
035         * Get's the tag search engine for this TaggableSearchableChangeLogStore.
036         *
037         * @return the snapshot query engine for this store.
038         */
039        TagSearchEngine getTagSearchEngine();
040        
041        /**
042         * 
043         * Gets the read only Partition backed by this ChangeLogStore.
044         * The init() method on this partition needs to be called by the caller.<br><br>
045         * Note: This partition allows add/delete operation on the tags container
046         *       The revisions container is read-only.<br><br>  
047         * The default containers of the partition are
048         *    <li>ou=changelog</li>
049         *    <li>ou=tags,ou=changelog</li>
050         *    <li>ou=revisions,ou=changelog</li> 
051         * 
052         * @param partitionSuffix the suffix of the partition e.x ou=chnagelog
053         * @param revContainerName the container's name for holding the revisions ex. ou=revisions
054         * @param tagContainerName the container's name for holding the tags ex. ou=tags
055         */
056        void createPartition( String partitionSuffix, String revContainerName, String tagContainerName );
057        
058        /**
059         * Gets the partition associated with this store
060         *
061         * @return the partition associated with this store, null if not initialized
062         */
063        Partition getPartition();
064        
065    }