Package org.opencastproject.lifecyclemanagement.api

Interface LifeCycleDatabaseService

public interface LifeCycleDatabaseService

API that defines persistent storage of lifecycle elements

Method Summary

Modifier and Type	Method	Description
LifeCyclePolicy	createLifeCyclePolicy(LifeCyclePolicy policy, String orgId)	Creates a single life cycle policy in the database.
LifeCycleTask	createLifeCycleTask(LifeCycleTask task, String orgId)	Creates a single life cycle task.
void	deleteAllLifeCyclePoliciesCreatedByConfig(String orgId)	Remove all life cycle policies that were created through configuration files from the database
boolean	deleteLifeCyclePolicy(LifeCyclePolicy policy, String orgId)	Removes a single life cycle policy in the database.
boolean	deleteLifeCycleTask(LifeCycleTask task, String orgId)	Removes a single life cycle task.
List<LifeCyclePolicy>	getActiveLifeCyclePolicies(String orgId)	Get currently active life cycle policies
List<LifeCyclePolicy>	getLifeCyclePolicies(int limit, int offset, org.opencastproject.util.requests.SortCriterion sortCriterion)	Get several life cycle policies based on their order in the database
long	getLifeCyclePoliciesTotal(String orgId)	Get the total number of policies
LifeCyclePolicy	getLifeCyclePolicy(String id)	Gets a single life cycle policy in the current organization context by its identifier.
LifeCyclePolicy	getLifeCyclePolicy(String id, String orgId)	Gets a single life cycle policy by its identifier.
LifeCycleTask	getLifeCycleTask(String id)	Gets a single life cycle task in the current organization context by its identifier.
LifeCycleTask	getLifeCycleTaskByTargetId(String targetId)	Gets a single life cycle task in the current organization context by its target identifier.
List<LifeCycleTask>	getLifeCycleTasksWithStatus(Status status, String orgId)	Get several life cycle policies based on their status
boolean	updateLifeCyclePolicy(LifeCyclePolicy policy, String orgId)	Updates a single life cycle policy in the database.
boolean	updateLifeCycleTask(LifeCycleTask task, String orgId)	Updates a single life cycle task.

Method Details

getLifeCyclePolicy

LifeCyclePolicy getLifeCyclePolicy(String id)
                            throws org.opencastproject.util.NotFoundException,
LifeCycleDatabaseException

Gets a single life cycle policy in the current organization context by its identifier.

Parameters:

id - the life cycle policy identifier

Returns:

the LifeCyclePolicy with the given identifier

Throws:

org.opencastproject.util.NotFoundException - if there is no life cycle policy with this identifier

LifeCycleDatabaseException - if there is a problem communicating with the underlying data store

getLifeCyclePolicy

LifeCyclePolicy getLifeCyclePolicy(String id,
 String orgId)
                            throws org.opencastproject.util.NotFoundException,
LifeCycleDatabaseException

Gets a single life cycle policy by its identifier.

Parameters:

id - the life cycle policy identifier

orgId - the organisation identifier

Returns:

the LifeCyclePolicy with the given identifier

Throws:

org.opencastproject.util.NotFoundException - if there is no life cycle policy with this identifier

LifeCycleDatabaseException - if there is a problem communicating with the underlying data store

getLifeCyclePoliciesTotal

long getLifeCyclePoliciesTotal(String orgId)
                        throws LifeCycleDatabaseException

Get the total number of policies

Parameters:

orgId - the organisation identifier

Returns:

the total number of policies

Throws:

LifeCycleDatabaseException

getLifeCyclePolicies

List<LifeCyclePolicy> getLifeCyclePolicies(int limit,
 int offset,
 org.opencastproject.util.requests.SortCriterion sortCriterion)
                                    throws LifeCycleDatabaseException

Get several life cycle policies based on their order in the database

Parameters:

limit - Maximum amount of life cycle policys to return

offset - The index of the first result to return

Returns:

a list of LifeCyclePolicys

Throws:

LifeCycleDatabaseException - if there is a problem communicating with the underlying data store

getActiveLifeCyclePolicies

List<LifeCyclePolicy> getActiveLifeCyclePolicies(String orgId)
                                          throws LifeCycleDatabaseException

Get currently active life cycle policies

Parameters:

orgId - the organisation identifier

Returns:

a list of LifeCyclePolicys

Throws:

LifeCycleDatabaseException - if there is a problem communicating with the underlying data store

createLifeCyclePolicy

LifeCyclePolicy createLifeCyclePolicy(LifeCyclePolicy policy,
 String orgId)
                               throws LifeCycleDatabaseException

Creates a single life cycle policy in the database.

Parameters:

policy - The LifeCyclePolicy

orgId - the organisation identifier

Returns:

The created LifeCyclePolicy

Throws:

LifeCycleDatabaseException - if there is a problem communicating with the underlying data store

updateLifeCyclePolicy

boolean updateLifeCyclePolicy(LifeCyclePolicy policy,
 String orgId)
                       throws LifeCycleDatabaseException

Updates a single life cycle policy in the database.

Parameters:

policy - The LifeCyclePolicy

orgId - the organisation identifier

Returns:

If the life cycle policy was successfully updated

Throws:

LifeCycleDatabaseException - if there is a problem communicating with the underlying data store

deleteLifeCyclePolicy

boolean deleteLifeCyclePolicy(LifeCyclePolicy policy,
 String orgId)
                       throws LifeCycleDatabaseException

Removes a single life cycle policy in the database.

Parameters:

policy - The LifeCyclePolicy

orgId - the organisation identifier

Returns:

If the life cycle policy was successfully updated

Throws:

LifeCycleDatabaseException - if there is a problem communicating with the underlying data store

deleteAllLifeCyclePoliciesCreatedByConfig

void deleteAllLifeCyclePoliciesCreatedByConfig(String orgId)
                                        throws LifeCycleDatabaseException

Remove all life cycle policies that were created through configuration files from the database

Parameters:

orgId -

Throws:

LifeCycleDatabaseException

getLifeCycleTask

LifeCycleTask getLifeCycleTask(String id)
                        throws org.opencastproject.util.NotFoundException,
LifeCycleDatabaseException

Gets a single life cycle task in the current organization context by its identifier.

Parameters:

id - the life cycle task identifier

Returns:

the LifeCycleTask with the given identifier

Throws:

org.opencastproject.util.NotFoundException - if there is no life cycle task with this identifier

LifeCycleDatabaseException - if there is a problem communicating with the underlying data store

getLifeCycleTaskByTargetId

LifeCycleTask getLifeCycleTaskByTargetId(String targetId)
                                  throws org.opencastproject.util.NotFoundException,
LifeCycleDatabaseException

Gets a single life cycle task in the current organization context by its target identifier.

Parameters:

targetId - the id of the entity the task will act on

Returns:

the LifeCycleTask with the given identifier

Throws:

org.opencastproject.util.NotFoundException - if there is no life cycle task with this identifier

LifeCycleDatabaseException - if there is a problem communicating with the underlying data store

getLifeCycleTasksWithStatus

List<LifeCycleTask> getLifeCycleTasksWithStatus(Status status,
 String orgId)
                                         throws LifeCycleDatabaseException

Get several life cycle policies based on their status

Parameters:

status - The state the tasks should be in

orgId - the organisation identifier

Returns:

a list of LifeCycleTasks

Throws:

LifeCycleDatabaseException - if there is a problem communicating with the underlying data store

createLifeCycleTask

LifeCycleTask createLifeCycleTask(LifeCycleTask task,
 String orgId)
                           throws LifeCycleDatabaseException

Creates a single life cycle task.

Parameters:

task - The LifeCycleTask

orgId - the organisation identifier

Returns:

The created LifeCycleTask

Throws:

LifeCycleDatabaseException - if there is a problem communicating with the underlying data store

updateLifeCycleTask

boolean updateLifeCycleTask(LifeCycleTask task,
 String orgId)
                     throws LifeCycleDatabaseException

Updates a single life cycle task.

Parameters:

task - The LifeCycleTask

orgId - the organisation identifier

Returns:

If the life cycle task was successfully updated

Throws:

LifeCycleDatabaseException - if there is a problem communicating with the underlying data store

deleteLifeCycleTask

boolean deleteLifeCycleTask(LifeCycleTask task,
 String orgId)
                     throws LifeCycleDatabaseException

Removes a single life cycle task.

Parameters:

task - The LifeCycleTask

orgId - the organisation identifier

Returns:

If the life cycle task was successfully updated

Throws:

LifeCycleDatabaseException - if there is a problem communicating with the underlying data store