Package org.opencastproject.list.common.provider

Class JobsListProvider

java.lang.Object

org.opencastproject.list.common.provider.JobsListProvider

All Implemented Interfaces:

ResourceListProvider

public class JobsListProvider
extends Object
implements ResourceListProvider

Jobs list provider.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JOB_STATUS_FILTER_PREFIX	Job status label prefix.
static final String	LIST_STATUS	Status list name.
static final String	LIST_WORKFLOW	Workflow list name.
protected static final String[]	NAMES	The names of the different list available through this provider.

Constructor Summary

Constructors

Constructor	Description
JobsListProvider()

Method Summary

Modifier and Type	Method	Description
protected void	activate(org.osgi.framework.BundleContext bundleContext)	OSGi service activation callback.
String	getDefault()	Returns the key of the default value in the list if customized, else null.
Map<String,String>	getList(String listName, ResourceListQuery query)	Returns the key-value list for the generator resource filtered with the given filter and based on the given organization context.
String[]	getListNames()	Returns the names of the list(s) provided
boolean	isTranslatable(String listName)	Defines if keys and values of the given list should be translated in the administrative user interface.
void	setWorkflowService(WorkflowService workflowService)	OSGi callback for the workflow service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LIST_STATUS

public static final String LIST_STATUS

Status list name.

See Also:

• Constant Field Values

LIST_WORKFLOW

public static final String LIST_WORKFLOW

Workflow list name.

See Also:

• Constant Field Values

JOB_STATUS_FILTER_PREFIX

public static final String JOB_STATUS_FILTER_PREFIX

Job status label prefix.

See Also:

• Constant Field Values

NAMES

protected static final String[] NAMES

The names of the different list available through this provider.

Constructor Details

JobsListProvider

public JobsListProvider()

Method Details

getListNames

public String[] getListNames()

Description copied from interface: ResourceListProvider

Returns the names of the list(s) provided

Specified by:

getListNames in interface ResourceListProvider

Returns:

an array containing the lists available

getList

public Map<String,String> getList(String listName,
 ResourceListQuery query)

Description copied from interface: ResourceListProvider

Returns the key-value list for the generator resource filtered with the given filter and based on the given organization context.

Specified by:

getList in interface ResourceListProvider

Parameters:

listName - the list name

query - the list query

Returns:

the key-value list for the generator resource

activate

protected void activate(org.osgi.framework.BundleContext bundleContext)

OSGi service activation callback.

setWorkflowService

public void setWorkflowService(WorkflowService workflowService)

OSGi callback for the workflow service.

isTranslatable

public boolean isTranslatable(String listName)

Description copied from interface: ResourceListProvider

Defines if keys and values of the given list should be translated in the administrative user interface.

Specified by:

isTranslatable in interface ResourceListProvider

Parameters:

listName - the name of the list

Returns:

if the results should be translated

getDefault

public String getDefault()

Description copied from interface: ResourceListProvider

Returns the key of the default value in the list if customized, else null.

Specified by:

getDefault in interface ResourceListProvider

Returns:

key of default value or null