Package org.opencastproject.lifecyclemanagement.impl

Class LifeCyclePolicyImpl

java.lang.Object

org.opencastproject.lifecyclemanagement.impl.LifeCyclePolicyImpl

All Implemented Interfaces:

LifeCyclePolicy

@Entity(name="LifeCyclePolicy")
public class LifeCyclePolicyImpl
extends Object
implements LifeCyclePolicy

Entity object for storing life cycle policies in persistence storage. Policies define actions that should be applied to entities. They offer various methods of defining when an action should be applied, effectively allowing for scheduling of actions. The policy ACL only pertains to itself. The entities they may affect (e.g. events, series) are still only governed by their own ACLs.

Constructor Summary

Constructors

Constructor	Description
LifeCyclePolicyImpl()
LifeCyclePolicyImpl(String title, TargetType targetType, Action action, String actionParameters, Date actionDate, String cronTrigger, Timing timing, Map<String,Map<String,EventSearchQueryField<String>>> targetFilters, List<LifeCyclePolicyAccessControlEntryImpl> accessControlEntries)

Method Summary

Modifier and Type	Method	Description
List<LifeCyclePolicyAccessControlEntry>	getAccessControlEntries()	Gets the access control entries restricting who may manage this policy
Action	getAction()	Gets the action to be performed when the policy is applied
Date	getActionDate()	Gets the date at which the policy's action should be performed
String	getActionParameters()	Gets the parameters for the policy's Action
String	getCronTrigger()	Gets the cron expression that triggers the policy for a Timing.REPEATING policy
String	getId()	Gets the policy's identifier
String	getOrganization()	Gets the policy's organization identifier
Map<String,Map<String,EventSearchQueryField<String>>>	getTargetFilters()	Gets the filters used to determine which entities this policy targets.
TargetType	getTargetType()	Gets the type of entity this policy targets
Timing	getTiming()	Gets the policy's Timing
String	getTitle()	Gets the policy's title
boolean	isActive()	Returns whether the policy is currently active
boolean	isCreatedFromConfig()	Returns whether the policy was created from a configuration file
void	setAccessControlEntries(List<LifeCyclePolicyAccessControlEntry> accessControlEntries)	Sets the access control entries restricting who may manage this policy
void	setAction(Action action)	Sets the action to be performed when the policy is applied
void	setActionDate(Date actionDate)	Sets the date at which the policy's action should be performed
void	setActionParameters(String actionParameters)	Sets the parameters for the policy's Action
void	setActive(boolean active)	Sets whether the policy is currently active
void	setCreatedFromConfig(boolean createdFromConfig)	Sets whether the policy was created from a configuration file
void	setCronTrigger(String cronTrigger)	Sets the cron expression that triggers the policy for a Timing.REPEATING policy
void	setId(String id)	Sets the policy's identifier
void	setOrganization(String organization)	Sets the policy's organization identifier
void	setTargetFilters(Map<String,Map<String,EventSearchQueryField<String>>> targetFilters)	Sets the filters used to determine which entities this policy targets.
void	setTargetType(TargetType targetType)	Sets the type of entity this policy targets
void	setTiming(Timing timing)	Sets the policy's Timing
void	setTitle(String title)	Sets the policy's title

Methods inherited from class java.lang.Object

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

Constructor Details

LifeCyclePolicyImpl

public LifeCyclePolicyImpl()

LifeCyclePolicyImpl

public LifeCyclePolicyImpl(String title,
 TargetType targetType,
 Action action,
 String actionParameters,
 Date actionDate,
 String cronTrigger,
 Timing timing,
 Map<String,Map<String,EventSearchQueryField<String>>> targetFilters,
 List<LifeCyclePolicyAccessControlEntryImpl> accessControlEntries)

Method Details

getId

public String getId()

Description copied from interface: LifeCyclePolicy

Gets the policy's identifier

Specified by:

getId in interface LifeCyclePolicy

Returns:

the policy identifier

setId

public void setId(String id)

Description copied from interface: LifeCyclePolicy

Sets the policy's identifier

Specified by:

setId in interface LifeCyclePolicy

Parameters:

id - the policy identifier

getOrganization

public String getOrganization()

Description copied from interface: LifeCyclePolicy

Gets the policy's organization identifier

Specified by:

getOrganization in interface LifeCyclePolicy

Returns:

the organization identifier

setOrganization

public void setOrganization(String organization)

Description copied from interface: LifeCyclePolicy

Sets the policy's organization identifier

Specified by:

setOrganization in interface LifeCyclePolicy

Parameters:

organization - the organization identifier

getTitle

public String getTitle()

Description copied from interface: LifeCyclePolicy

Gets the policy's title

Specified by:

getTitle in interface LifeCyclePolicy

Returns:

the title

setTitle

public void setTitle(String title)

Description copied from interface: LifeCyclePolicy

Sets the policy's title

Specified by:

setTitle in interface LifeCyclePolicy

Parameters:

title - the title

getTargetType

public TargetType getTargetType()

Description copied from interface: LifeCyclePolicy

Gets the type of entity this policy targets

Specified by:

getTargetType in interface LifeCyclePolicy

Returns:

the TargetType

setTargetType

public void setTargetType(TargetType targetType)

Description copied from interface: LifeCyclePolicy

Sets the type of entity this policy targets

Specified by:

setTargetType in interface LifeCyclePolicy

Parameters:

targetType - the TargetType

getAction

public Action getAction()

Description copied from interface: LifeCyclePolicy

Gets the action to be performed when the policy is applied

Specified by:

getAction in interface LifeCyclePolicy

Returns:

the Action

setAction

public void setAction(Action action)

Description copied from interface: LifeCyclePolicy

Sets the action to be performed when the policy is applied

Specified by:

setAction in interface LifeCyclePolicy

Parameters:

action - the Action

getActionParameters

public String getActionParameters()

Description copied from interface: LifeCyclePolicy

Gets the parameters for the policy's Action

Specified by:

getActionParameters in interface LifeCyclePolicy

Returns:

the action parameters

setActionParameters

public void setActionParameters(String actionParameters)

Description copied from interface: LifeCyclePolicy

Sets the parameters for the policy's Action

Specified by:

setActionParameters in interface LifeCyclePolicy

Parameters:

actionParameters - the action parameters

getActionDate

public Date getActionDate()

Description copied from interface: LifeCyclePolicy

Gets the date at which the policy's action should be performed

Specified by:

getActionDate in interface LifeCyclePolicy

Returns:

the action date

setActionDate

public void setActionDate(Date actionDate)

Description copied from interface: LifeCyclePolicy

Sets the date at which the policy's action should be performed

Specified by:

setActionDate in interface LifeCyclePolicy

Parameters:

actionDate - the action date

getCronTrigger

public String getCronTrigger()

Description copied from interface: LifeCyclePolicy

Gets the cron expression that triggers the policy for a Timing.REPEATING policy

Specified by:

getCronTrigger in interface LifeCyclePolicy

Returns:

the cron trigger expression

setCronTrigger

public void setCronTrigger(String cronTrigger)

Description copied from interface: LifeCyclePolicy

Sets the cron expression that triggers the policy for a Timing.REPEATING policy

Specified by:

setCronTrigger in interface LifeCyclePolicy

Parameters:

cronTrigger - the cron trigger expression

getTiming

public Timing getTiming()

Description copied from interface: LifeCyclePolicy

Gets the policy's Timing

Specified by:

getTiming in interface LifeCyclePolicy

Returns:

the timing

setTiming

public void setTiming(Timing timing)

Description copied from interface: LifeCyclePolicy

Sets the policy's Timing

Specified by:

setTiming in interface LifeCyclePolicy

Parameters:

timing - the timing

isActive

public boolean isActive()

Description copied from interface: LifeCyclePolicy

Returns whether the policy is currently active

Specified by:

isActive in interface LifeCyclePolicy

Returns:

true if the policy is active

setActive

public void setActive(boolean active)

Description copied from interface: LifeCyclePolicy

Sets whether the policy is currently active

Specified by:

setActive in interface LifeCyclePolicy

Parameters:

active - true if the policy is active

isCreatedFromConfig

public boolean isCreatedFromConfig()

Description copied from interface: LifeCyclePolicy

Returns whether the policy was created from a configuration file

Specified by:

isCreatedFromConfig in interface LifeCyclePolicy

Returns:

true if the policy was created from configuration

setCreatedFromConfig

public void setCreatedFromConfig(boolean createdFromConfig)

Description copied from interface: LifeCyclePolicy

Sets whether the policy was created from a configuration file

Specified by:

setCreatedFromConfig in interface LifeCyclePolicy

Parameters:

createdFromConfig - true if the policy was created from configuration

getTargetFilters

public Map<String,Map<String,EventSearchQueryField<String>>> getTargetFilters()

Description copied from interface: LifeCyclePolicy

Gets the filters used to determine which entities this policy targets. The outer map is keyed by metadata catalog flavor (e.g. "dublincore/episode"). The inner map hols the catalogs name/value pairs.

Specified by:

getTargetFilters in interface LifeCyclePolicy

Returns:

the target filters

setTargetFilters

public void setTargetFilters(Map<String,Map<String,EventSearchQueryField<String>>> targetFilters)

Description copied from interface: LifeCyclePolicy

Sets the filters used to determine which entities this policy targets. The outer map is keyed by metadata catalog flavor (e.g. "dublincore/episode"). The inner map hols the catalogs name/value pairs.

Specified by:

setTargetFilters in interface LifeCyclePolicy

Parameters:

targetFilters - the target filters

getAccessControlEntries

public List<LifeCyclePolicyAccessControlEntry> getAccessControlEntries()

Description copied from interface: LifeCyclePolicy

Gets the access control entries restricting who may manage this policy

Specified by:

getAccessControlEntries in interface LifeCyclePolicy

Returns:

the list of LifeCyclePolicyAccessControlEntrys

setAccessControlEntries

public void setAccessControlEntries(List<LifeCyclePolicyAccessControlEntry> accessControlEntries)

Description copied from interface: LifeCyclePolicy

Sets the access control entries restricting who may manage this policy

Specified by:

setAccessControlEntries in interface LifeCyclePolicy

Parameters:

accessControlEntries - the list of LifeCyclePolicyAccessControlEntrys