Package org.opencastproject.lifecyclemanagement.api

Interface LifeCyclePolicy

All Known Implementing Classes:
LifeCyclePolicyImpl
public interface LifeCyclePolicy
Represents a life cycle policy in Opencast

  • Method Details

    • getId

      String getId()
      Gets the policy's identifier
      Returns:
      the policy identifier

    • setId

      void setId(String id)
      Sets the policy's identifier
      Parameters:
      id - the policy identifier

    • getOrganization

      String getOrganization()
      Gets the policy's organization identifier
      Returns:
      the organization identifier

    • setOrganization

      void setOrganization(String organization)
      Sets the policy's organization identifier
      Parameters:
      organization - the organization identifier

    • getTitle

      String getTitle()
      Gets the policy's title
      Returns:
      the title

    • setTitle

      void setTitle(String title)
      Sets the policy's title
      Parameters:
      title - the title

    • getTargetType

      TargetType getTargetType()
      Gets the type of entity this policy targets
      Returns:
      the TargetType

    • setTargetType

      void setTargetType(TargetType targetType)
      Sets the type of entity this policy targets
      Parameters:
      targetType - the TargetType

    • getAction

      Action getAction()
      Gets the action to be performed when the policy is applied
      Returns:
      the Action

    • setAction

      void setAction(Action action)
      Sets the action to be performed when the policy is applied
      Parameters:
      action - the Action

    • getActionParameters

      String getActionParameters()
      Gets the parameters for the policy's Action
      Returns:
      the action parameters

    • setActionParameters

      void setActionParameters(String actionParameters)
      Sets the parameters for the policy's Action
      Parameters:
      actionParameters - the action parameters

    • getActionDate

      Date getActionDate()
      Gets the date at which the policy's action should be performed
      Returns:
      the action date

    • setActionDate

      void setActionDate(Date actionDate)
      Sets the date at which the policy's action should be performed
      Parameters:
      actionDate - the action date

    • getCronTrigger

      String getCronTrigger()
      Gets the cron expression that triggers the policy for a Timing.REPEATING policy
      Returns:
      the cron trigger expression

    • setCronTrigger

      void setCronTrigger(String cronTrigger)
      Sets the cron expression that triggers the policy for a Timing.REPEATING policy
      Parameters:
      cronTrigger - the cron trigger expression

    • getTiming

      Timing getTiming()
      Gets the policy's Timing
      Returns:
      the timing

    • setTiming

      void setTiming(Timing timing)
      Sets the policy's Timing
      Parameters:
      timing - the timing

    • isActive

      boolean isActive()
      Returns whether the policy is currently active
      Returns:
      true if the policy is active

    • setActive

      void setActive(boolean active)
      Sets whether the policy is currently active
      Parameters:
      active - true if the policy is active

    • isCreatedFromConfig

      boolean isCreatedFromConfig()
      Returns whether the policy was created from a configuration file
      Returns:
      true if the policy was created from configuration

    • setCreatedFromConfig

      void setCreatedFromConfig(boolean createdFromConfig)
      Sets whether the policy was created from a configuration file
      Parameters:
      createdFromConfig - true if the policy was created from configuration

    • getTargetFilters

      Map<String,Map<String,EventSearchQueryField<String>>> getTargetFilters()
      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.
      Returns:
      the target filters

    • setTargetFilters

      void setTargetFilters(Map<String,Map<String,EventSearchQueryField<String>>> targetFilters)
      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.
      Parameters:
      targetFilters - the target filters

    • getAccessControlEntries

      List<LifeCyclePolicyAccessControlEntry> getAccessControlEntries()
      Gets the access control entries restricting who may manage this policy
      Returns:
      the list of LifeCyclePolicyAccessControlEntrys

    • setAccessControlEntries

      void setAccessControlEntries(List<LifeCyclePolicyAccessControlEntry> accessControlEntries)
      Sets the access control entries restricting who may manage this policy
      Parameters:
      accessControlEntries - the list of LifeCyclePolicyAccessControlEntrys