senselogic.sitevision.api.versioning

Enum PublishStatus

Object

Enum<PublishStatus>

senselogic.sitevision.api.versioning.PublishStatus

All Implemented Interfaces:

Serializable, Comparable<PublishStatus>

@Requireable(value="PublishStatus")
public enum PublishStatus
extends Enum<PublishStatus>

Different statuses for nodes that can be published.

Since:

Sitevision 2024.01.2

Author:

Gustav Holmberg

See Also:

PublishingUtil.getPublishStatus(javax.jcr.Node)

Enum Constant Summary

Enum Constants

Enum Constant and Description
BELONGS_TO_PUBLISHING_PROJECT The node has been added to a publishing project.
LOCKED The node has been locked, meaning that there may be someone else currently working with the node in question.
NOT_PUBLISHED The node has not been published.
PUBLISHED Denotes that the node has been successfully published.
SCHEDULED_PUBLISH The node is scheduled for future publication at a specific date and time.
SCHEDULED_PUBLISH_BY_PUBLISHING_PROJECT The node is scheduled for publication by a publishing project.
SCHEDULED_UNPUBLISH The node is scheduled to be unpublished at a specific date and time.
WORKFLOW_STARTED The node's publishing process is in progress as part of a workflow.

Method Summary

Modifier and Type	Method and Description
static PublishStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static PublishStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT_PUBLISHED

@Requireable(value="PublishStatus.NOT_PUBLISHED")
public static final PublishStatus NOT_PUBLISHED

The node has not been published. Nodes with this status can be published.

PUBLISHED

@Requireable(value="PublishStatus.PUBLISHED")
public static final PublishStatus PUBLISHED

Denotes that the node has been successfully published. Nodes with this status can be published and unpublished.

WORKFLOW_STARTED

@Requireable(value="PublishStatus.WORKFLOW_STARTED")
public static final PublishStatus WORKFLOW_STARTED

The node's publishing process is in progress as part of a workflow. Nodes with this status can not be published and unpublished.

SCHEDULED_PUBLISH

@Requireable(value="PublishStatus.SCHEDULED_PUBLISH")
public static final PublishStatus SCHEDULED_PUBLISH

The node is scheduled for future publication at a specific date and time. Nodes with this status can not be published or unpublished.

SCHEDULED_UNPUBLISH

@Requireable(value="PublishStatus.SCHEDULED_UNPUBLISH")
public static final PublishStatus SCHEDULED_UNPUBLISH

The node is scheduled to be unpublished at a specific date and time. Nodes with this status can not be published or unpublished.

SCHEDULED_PUBLISH_BY_PUBLISHING_PROJECT

@Requireable(value="PublishStatus.SCHEDULED_PUBLISH_BY_PUBLISHING_PROJECT")
public static final PublishStatus SCHEDULED_PUBLISH_BY_PUBLISHING_PROJECT

The node is scheduled for publication by a publishing project. Nodes with this status can not be published or unpublished.

BELONGS_TO_PUBLISHING_PROJECT

@Requireable(value="PublishStatus.BELONGS_TO_PUBLISHING_PROJECT")
public static final PublishStatus BELONGS_TO_PUBLISHING_PROJECT

The node has been added to a publishing project. Nodes with this status can not be published or unpublished.

LOCKED

@Requireable(value="PublishStatus.LOCKED")
public static final PublishStatus LOCKED

The node has been locked, meaning that there may be someone else currently working with the node in question. Nodes with this status can not be published or unpublished.

Method Detail

values

public static PublishStatus[] 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 (PublishStatus c : PublishStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PublishStatus 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 name

NullPointerException - if the argument is null