Package com.day.cq.replication
Interface ReplicationStatus
-
public interface ReplicationStatusReplicationStatus
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringNODE_PROPERTY_LAST_PUBLISHEDDeprecated.static java.lang.StringNODE_PROPERTY_LAST_PUBLISHED_BYDeprecated.static java.lang.StringNODE_PROPERTY_LAST_REPLICATEDThe name of the property that records the date of the last replication.static java.lang.StringNODE_PROPERTY_LAST_REPLICATED_BYThe name of the property that records the userid of the last replicationstatic java.lang.StringNODE_PROPERTY_LAST_REPLICATION_ACTIONThe name of the property that records the last replication actionstatic java.lang.StringNODE_TYPEName of the node type
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description java.util.CalendargetLastPublished()Returns the time when the content was last published (i.e.java.lang.StringgetLastPublishedBy()Returns the user id who issues the last publish action.ReplicationActionTypegetLastReplicationAction()Return the last replication action.java.util.List<ReplicationQueue.Entry>getPending()Checks if the last publish action is still pending, i.e.java.util.List<ReplicationQueue.Entry>getQueueStatus()Returns the queue status of this content.booleanisActivated()Convenience method that checks if the last publish action was 'activate'.booleanisDeactivated()Convenience method that checks if the last publish action was 'deactivate'.booleanisDelivered()Checks if the content is delivered.booleanisPending()Checks if the last publish action is pending, i.e.booleanisPublished()Deprecated.useisDelivered()
-
-
-
Field Detail
-
NODE_PROPERTY_LAST_REPLICATED
static final java.lang.String NODE_PROPERTY_LAST_REPLICATED
The name of the property that records the date of the last replication.- See Also:
- Constant Field Values
-
NODE_PROPERTY_LAST_REPLICATED_BY
static final java.lang.String NODE_PROPERTY_LAST_REPLICATED_BY
The name of the property that records the userid of the last replication- See Also:
- Constant Field Values
-
NODE_PROPERTY_LAST_REPLICATION_ACTION
static final java.lang.String NODE_PROPERTY_LAST_REPLICATION_ACTION
The name of the property that records the last replication action- See Also:
- Constant Field Values
-
NODE_TYPE
static final java.lang.String NODE_TYPE
Name of the node type- See Also:
- Constant Field Values
-
NODE_PROPERTY_LAST_PUBLISHED
static final java.lang.String NODE_PROPERTY_LAST_PUBLISHED
Deprecated.- See Also:
- Constant Field Values
-
NODE_PROPERTY_LAST_PUBLISHED_BY
static final java.lang.String NODE_PROPERTY_LAST_PUBLISHED_BY
Deprecated.- See Also:
- Constant Field Values
-
-
Method Detail
-
getLastPublished
java.util.Calendar getLastPublished()
Returns the time when the content was last published (i.e. activated or deactivated).- Returns:
- last publish date or
null
-
getLastPublishedBy
java.lang.String getLastPublishedBy()
Returns the user id who issues the last publish action.- Returns:
- The publish user id or
null
-
getLastReplicationAction
ReplicationActionType getLastReplicationAction()
Return the last replication action.- Returns:
- The action type or null
-
isDelivered
boolean isDelivered()
Checks if the content is delivered. Note that this is calculated only by the logs of replication actions. It does not check if the content is physically on the server. a content is delivered if the last action was 'Activate' and the action is processed. of if the action was 'deactivate' and the action is still pending.- Returns:
trueif the content is delivered.
-
isPublished
@Deprecated boolean isPublished()
Deprecated.useisDelivered()- Returns:
- same as
isDelivered()
-
isActivated
boolean isActivated()
Convenience method that checks if the last publish action was 'activate'. Note that !isActivated() does not automatically meen that the content is deactivated.- Returns:
trueif the last publish action was 'activate'
-
isDeactivated
boolean isDeactivated()
Convenience method that checks if the last publish action was 'deactivate'. Note that !isDeactivated() does not automatically mean that the content is activated.- Returns:
trueif the last publish action was 'activate'
-
isPending
boolean isPending()
Checks if the last publish action is pending, i.e. if it's still present in any of the queues.- Returns:
trueif the action is pending
-
getPending
java.util.List<ReplicationQueue.Entry> getPending()
Checks if the last publish action is still pending, i.e. if it's still present in any of the queues.- Returns:
- the list of pending queue entries
-
getQueueStatus
java.util.List<ReplicationQueue.Entry> getQueueStatus()
Returns the queue status of this content. if this content is not queued at all, an empty array is returned.- Returns:
- a queue status for each queue.
-
-