GlossaryManager.java

/**
 * <a href="http://www.openolat.org">
 * OpenOLAT - Online Learning and Training</a><br>
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License"); <br>
 * you may not use this file except in compliance with the License.<br>
 * You may obtain a copy of the License at the
 * <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache homepage</a>
 * <p>
 * Unless required by applicable law or agreed to in writing,<br>
 * software distributed under the License is distributed on an "AS IS" BASIS, <br>
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
 * See the License for the specific language governing permissions and <br>
 * limitations under the License.
 * <p>
 * Initial code contributed and copyrighted by<br>
 * frentix GmbH, http://www.frentix.com
 * <p>
 */
package org.olat.modules.glossary;

import java.io.File;

import org.apache.lucene.document.Document;
import org.olat.core.commons.modules.bc.vfs.OlatRootFolderImpl;
import org.olat.core.gui.media.MediaResource;
import org.olat.core.id.OLATResourceable;
import org.olat.core.manager.BasicManager;
import org.olat.fileresource.types.GlossaryResource;
import org.olat.repository.RepositoryEntry;
import org.olat.repository.RepositoryEntryImportExport;
import org.olat.search.service.SearchResourceContext;

/**
 * Description:<br>
 * Manager to create, delete etc. glossary learning resources. The OLAT glossary
 * functionality is based on the core framework glossary / textmarker functions.
 * 
 * in case new glossary should be replaced by old one, use GlossaryManagerOld --> see olat_extensions.xml
 * 
 * <P>
 * Initial Date:  16.01.2009 <br>
 * @author Roman Haag, frentix GmbH, roman.haag@frentix.com
 */
public abstract class GlossaryManager extends BasicManager {
	protected static GlossaryManager INSTANCE;
	public static final String GLOSSARY_REPO_REF_IDENTIFYER = "glossary.repo.ref.identifyer";
	public static final String INTERNAL_FOLDER_NAME = "_glossary_";
	
	public static synchronized GlossaryManager getInstance(){
		return INSTANCE;
	}
	
	public abstract OlatRootFolderImpl getGlossaryRootFolder(OLATResourceable res);
	
	public abstract Document getIndexerDocument(RepositoryEntry repositoryEntry, SearchResourceContext searchResourceContext);
	
	public abstract boolean exportGlossary(String glossarySoftkey, File exportedDataDir);
	
	public abstract MediaResource getAsMediaResource(OLATResourceable res);
	
	public abstract GlossaryResource createGlossary();
	
	public abstract RepositoryEntryImportExport getRepositoryImportExport(File importDataDir);
	
	public abstract void deleteGlossary(OLATResourceable res);
	
}