org.alfresco.service.cmr.publishing
Interface PublishingPackageEntry

public interface PublishingPackageEntry

Since:

4.0

Method Summary

org.alfresco.service.cmr.repository.NodeRef	getNodeRef() Retrieve the identifier of the node that this publishing package entry relates to
NodeSnapshot	getSnapshot() Retrieve the snapshot of the node that is held as the payload of this publishing package entry.
boolean	isPublish() Determine if this entry relates to a publish request or an unpublish request

Method Detail

getNodeRef

org.alfresco.service.cmr.repository.NodeRef getNodeRef()

Retrieve the identifier of the node that this publishing package entry relates to

Returns:

A NodeRef object that identifies the node that this publishing package entry relates to

getSnapshot

NodeSnapshot getSnapshot()

Retrieve the snapshot of the node that is held as the payload of this publishing package entry. The snapshot is taken when the containing publishing package is placed on the publishing queue IF this is a "publish" entry as opposed to an "unpublish" entry. No snapshot is taken for an unpublish entry.

Returns:

The snapshot of the node that this publishing package entry relates to if this is a "publish" entry ( null if this is an "unpublish" entry). The snapshot is taken when the containing publishing package is placed on the publishing queue, so if this operation is called before that point then it will return null.

isPublish

boolean isPublish()

Determine if this entry relates to a publish request or an unpublish request

Returns:

true if this entry relates to a publish request and false if it relates to an unpublish request