Package nl.vpro.domain.media.support
Enum Workflow
- java.lang.Object
-
- java.lang.Enum<Workflow>
-
- nl.vpro.domain.media.support.Workflow
-
- All Implemented Interfaces:
Serializable
,Comparable<Workflow>
,XmlValued
,Displayable
public enum Workflow extends Enum<Workflow> implements Displayable, XmlValued
The workflow status for publishable items.
- Author:
- arne, roekoe
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Workflow.Deserializer
-
Enum Constant Summary
Enum Constants Enum Constant Description DELETED
If someone explicitly deleted an entity then it becomes 'deleted'.FOR_DELETION
The entity is scheduled for deletion.FOR_PUBLICATION
The object is not yet published, but should be considered for publication.FOR_REPUBLICATION
The object is already published, but something has been changed, and it needs to be published again.IGNORE
Will be completely ignored by publishers.MERGED
The object is merged with another object.PARENT_REVOKED
Set when a publishStop date has expired on a parent.PUBLISHED
REVOKED
Set when a publishStop date has expired and an entity is revoked.
-
Field Summary
Fields Modifier and Type Field Description static Set<Workflow>
API
static List<Workflow>
AS_DELETED_IN_API
static List<Workflow>
DELETES
static List<Workflow>
NEEDWORK
static List<Workflow>
PUBLICATIONS
static List<Workflow>
PUBLISHED_AS_DELETED
static List<Workflow>
REVOKES
static List<Workflow>
REVOKES_OR_IGNORE
static List<Workflow>
WITH_MEDIA_ACTIVATION
-
Fields inherited from interface nl.vpro.i18n.Displayable
NULL
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDescription()
String
getDisplayName()
@NonNull Workflow
getPublishedAs()
Some workflows are 'temporary' (seeisPublishable()
and only used for administration purposes.boolean
isPublishable()
Whether this workflow can appear in the frontend api.static Workflow
valueOf(String name)
Returns the enum constant of this type with the specified name.static Workflow[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.-
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Methods inherited from interface nl.vpro.i18n.Displayable
display, getDisplayName, getIcon, getIconClass, getPluralDisplayName, getPluralDisplayName
-
Methods inherited from interface nl.vpro.domain.XmlValued
getXmlValue
-
-
-
-
Enum Constant Detail
-
IGNORE
public static final Workflow IGNORE
Will be completely ignored by publishers. Will not be published, will not be revoked. Handy for debugging, to mute all objects besides the one you're interested in.
-
PUBLISHED
public static final Workflow PUBLISHED
-
FOR_PUBLICATION
public static final Workflow FOR_PUBLICATION
The object is not yet published, but should be considered for publication. This probably is a new object.
-
FOR_REPUBLICATION
public static final Workflow FOR_REPUBLICATION
The object is already published, but something has been changed, and it needs to be published again.
-
MERGED
public static final Workflow MERGED
The object is merged with another object. An object will get this status when it is published for the last time.Used only on
MediaObject
s.Normal users should not see these objects, but should be directed to the object
MediaObject.getMergedTo()
Objects are published though to ES, so the redirect list can be dynamically built.
-
PARENT_REVOKED
public static final Workflow PARENT_REVOKED
Set when a publishStop date has expired on a parent. For example: a Segment obtains this workflow when its parent Program is revoked.
-
REVOKED
public static final Workflow REVOKED
Set when a publishStop date has expired and an entity is revoked. This state is not set by the end-user. Setting this state directly without an expired publishStop is useless, because an entity will be republished anyhow.
-
DELETED
public static final Workflow DELETED
If someone explicitly deleted an entity then it becomes 'deleted'. This implies revocation from publication. Normal users should not see these entities.
-
FOR_DELETION
public static final Workflow FOR_DELETION
The entity is scheduled for deletion.
-
-
Method Detail
-
values
public static Workflow[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (Workflow c : Workflow.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Workflow valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getPublishedAs
public @NonNull Workflow getPublishedAs()
Some workflows are 'temporary' (seeisPublishable()
and only used for administration purposes. This returns the workflow as it would appear when all administrative work is done.
-
getDescription
public String getDescription()
-
getDisplayName
public String getDisplayName()
- Specified by:
getDisplayName
in interfaceDisplayable
-
isPublishable
public boolean isPublishable()
Whether this workflow can appear in the frontend api.- See Also:
getPublishedAs()
-
-