Package nl.vpro.domain.media.support
Enum Class Workflow
- All Implemented Interfaces:
Serializable
,Comparable<Workflow>
,Constable
,XmlValued
,Displayable
,XmlValued
The workflow status for publishable items.
- Author:
- arne, roekoe
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionIf someone explicitly deleted an entity then it becomes 'deleted'.The entity is scheduled for deletion.The object is not yet published, but should be considered for publication.The object is already published, but something has been changed, and it needs to be published again.Will be completely ignored by publishers.The object is merged with another object.Set when a publishStop date has expired on a parent.Set when a publishStop date has expired and an entity is revoked.The complete object is temporary. -
Field Summary
Modifier and TypeFieldDescriptionThe workflows that are allowable in ES.The workflows that are considered 'deleted'.The workflows that are considered 'deleted' in the frontend.Fields inherited from interface nl.vpro.i18n.Displayable
NULL
-
Method Summary
Modifier and TypeMethodDescription@NonNull Workflow
Some workflows are 'temporary' (seeisPublishable()
and only used for administration purposes.boolean
Whether this workflow can appear in the frontend api.boolean
predicate
(TrackableObject publishableObject) E.g.static Workflow
Returns the enum constant of this class with the specified name.static Workflow[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class java.lang.Enum
clone, compareTo, describeConstable, 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.util.XmlValued
getXmlValue
-
Enum Constant Details
-
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
-
FOR_PUBLICATION
The object is not yet published, but should be considered for publication. This probably is a new object. -
FOR_REPUBLICATION
The object is already published, but something has been changed, and it needs to be published again. -
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
Set when a publishStop date has expired on a parent. For example: a Segment obtains this workflow when its parent Program is revoked. -
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
If someone explicitly deleted an entity then it becomes 'deleted'. This implies revocation from publication. Normal users should not see these entities.This is also used if an authoritative system sends or refers to an object that is not in our system. It is then 'temporarily' created in this state. If at a later time metadata comes in, it will be implicitly undeleted, and the until then invisible data of it will become available (e.g. just the streaming status, a schedule event or member). See als
OwnerType.TEMPORARY
. -
FOR_DELETION
The entity is scheduled for deletion. -
TEMPORARY
The complete object is temporary. It is not published, and probably does not yet contain useful metadata. It is expected that that will follow in which case the workflow probably will change toFOR_PUBLICATION
. This may e.g. be a group with members, but which does not itself already have metadata (like a title). It may e.g. also be a program for which a NEP notify was received but no futer meta data yet.- Since:
- 7.11
-
-
Field Details
-
WITH_MEDIA_ACTIVATION
-
PUBLICATIONS
-
PUBLICATIONS_OR_NULL
-
DELETES
The workflows that are considered 'deleted'. I.eDELETED
andFOR_DELETION
-
PUBLISHED_AS_DELETED
The workflows that are considered 'deleted' in the frontend. I.e.DELETED
andFOR_DELETION
, but alsoREVOKED
,PARENT_REVOKED
andMERGED
. -
API
The workflows that are allowable in ES. So not the 'FOR_' workflows. -
AS_DELETED_IN_API
-
REVOKES
-
REVOKES_OR_IGNORE
-
NEEDWORK
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
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
-
getDisplayName
- Specified by:
getDisplayName
in interfaceDisplayable
-
predicate
E.g.#PUBLISHED::predicate
is a predicate on aTrackableObject
. -
isPublishable
public boolean isPublishable()Whether this workflow can appear in the frontend api.- See Also:
-