• Home
• org.daisy.streamline
• streamline-api
• 1.6.0
• source code
• TaskGroupFactoryMakerService.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.daisy.streamline.api.tasks.TaskGroupFactoryMakerService Maven / Gradle / Ivy

package org.daisy.streamline.api.tasks;

import java.util.Set;

/**
 * 

 * Provides an interface for a TaskGroupFactoryMaker service. The purpose of
 * this interface is to expose an implementation of a TaskGroupFactoryMaker as
 * an OSGi service.
 * 
 * 
 * 

 * To comply with this interface, an implementation must be thread safe and
 * address both the possibility that only a single instance is created and used
 * throughout and that new instances are created as desired.
 * 
 * 
 * @author Joel Håkansson
 * 
 */
public interface TaskGroupFactoryMakerService {

	/**
	 * Gets the task group factory that provided this information.
	 * @param info the information
	 * @return the task group factory that provided this information
	 * @throws IllegalArgumentException if no known task group factory provided this information
	 */
	public TaskGroupFactory getFactory(TaskGroupInformation info);

	/**
	 * Attempts to find a new task group that matches the supplied specification.
	 * @param specification the specification
	 * @return returns a new task group
	 * @throws IllegalArgumentException if the specified configuration isn't supported
	 */
	public TaskGroup newTaskGroup(TaskGroupSpecification specification);
	
	/**
	 * Gets the task group what provided this information.
	 * @param info the information
	 * @param locale the locale
	 * @return returns the task group
	 * @throws IllegalArgumentException if no known task group provided this information
	 */
	public TaskGroup newTaskGroup(TaskGroupInformation info, String locale);

	/**
	 * Gets a list with information about supported task groups.
	 * @return returns a list of information
	 */
	public Set listAll();
	
	/**
	 * Gets a list with information about supported task groups for the specified locale.
	 * @param locale the locale
	 * @return returns a list of information for the specified locale
	 */
	public Set list(String locale);

}