|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.arsdigita.domain.DomainObject
com.arsdigita.cms.publishToFile.QueueEntry
One entry in the PFS queue. The methods isPublishTask()
, isUnpublishTask()
, isRepublishTask()
, and isMoveTask()
can
be used to further determine what exact task should be performed for
this entry. Exactly one of these methods will return true
.
Field Summary | |
static String |
BASE_DATA_OBJECT_TYPE
The name of the PDL object type for queue entries. |
static String |
DESTINATION
|
static String |
FAIL_COUNT
|
static String |
HOST
|
static String |
ID
|
static String |
IN_PROCESS
|
static String |
IN_PROCESS_NO
|
static String |
IN_PROCESS_YES
|
static String |
ITEM_ID
|
static String |
ITEM_TYPE
|
static String |
PARENT_ID
|
static String |
SORT_ORDER
|
static String |
TASK
|
static String |
TASK_MOVE
|
static String |
TASK_PUBLISH
|
static String |
TASK_REPUBLISH
|
static String |
TASK_UNPUBLISH
|
static String |
TIME_LAST_FAILED
|
static String |
TIME_QUEUED
|
Fields inherited from class com.arsdigita.domain.DomainObject |
versionId |
Constructor Summary | |
protected |
QueueEntry()
|
|
QueueEntry(com.arsdigita.persistence.DataObject dataObject)
Constructor. |
protected |
QueueEntry(String objectType)
|
Method Summary | |
static QueueEntry |
create(ContentItem item,
BigDecimal parentId,
String task,
com.arsdigita.web.Host host,
String destination)
Creates object and initializes with data. |
protected String |
getBaseDataObjectType()
Return the PDL object type for queue entries. |
String |
getDestination()
Get the destination of the task. |
Long |
getFailCount()
Return the number oftimes this entry has been processed unsuccessfully. |
com.arsdigita.web.Host |
getHost()
|
BigDecimal |
getID()
|
ContentItem |
getItem()
Return a readonly copy the item affected by this queue entry or null if the item does no longer exist. |
BigDecimal |
getItemId()
Return the ID of the item that is affected by this task. |
String |
getItemType()
|
ContentItem |
getParent()
Return a readonly copy of the parent of the item affected by this queue entry or null if the item does no longer exist. |
BigDecimal |
getParentId()
Return the ID of the parent of this item. |
String |
getTask()
|
Date |
getTimeLastFailed()
Return the time this entry was last processed unsuccessfully. |
Date |
getTimeQueued()
Return when this entry was added to the queue. |
void |
initialize()
|
boolean |
isMoveTask()
Return true if this entry represents a move task. |
boolean |
isPublishTask()
Return true if this entry represents a publish task. |
boolean |
isRepublishTask()
Return true if this entry represents a republish task. |
boolean |
isUnpublishTask()
Return true if this entry represents an unpublish task. |
String |
toString()
|
Methods inherited from class com.arsdigita.domain.DomainObject |
add, add, addToAssociation, afterDelete, afterSave, beforeDelete, beforeSave, clear, delete, disconnect, equals, get, getObjectType, getOID, getSession, hashCode, isDeleted, isDisconnected, isModified, isNew, isPropertyModified, isValid, remove, remove, remove, removeFromAssociation, save, set, setAssociation, setAssociation, specializeDataObject, specializeDataObject |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String BASE_DATA_OBJECT_TYPE
public static final String ID
public static final String ITEM_ID
public static final String PARENT_ID
public static final String ITEM_TYPE
public static final String TASK
public static final String HOST
public static final String DESTINATION
public static final String TIME_QUEUED
public static final String TIME_LAST_FAILED
public static final String FAIL_COUNT
public static final String SORT_ORDER
public static final String IN_PROCESS
public static final String TASK_PUBLISH
public static final String TASK_UNPUBLISH
public static final String TASK_MOVE
public static final String TASK_REPUBLISH
public static final String IN_PROCESS_YES
public static final String IN_PROCESS_NO
Constructor Detail |
public QueueEntry(com.arsdigita.persistence.DataObject dataObject)
dataObject
- The data object to encapsulate in the new domain
object.protected QueueEntry()
protected QueueEntry(String objectType)
Method Detail |
protected String getBaseDataObjectType()
public void initialize()
public static QueueEntry create(ContentItem item, BigDecimal parentId, String task, com.arsdigita.web.Host host, String destination)
parentId
- a BigDecimal
valuetask
- task Should be QueueEntry.TASK_PUBLISH or
QueueEntry.TASK_UNPUBLISH.destination
- location in file system (within document root).
Used only if task is publish).public BigDecimal getID()
public BigDecimal getItemId()
getItem()
public String getItemType()
public ContentItem getItem()
null
if the item does no longer exist.
null
public BigDecimal getParentId()
getParent()
public ContentItem getParent()
null
if the item does no longer exist.
null
public String getDestination()
String
valuepublic String getTask()
public com.arsdigita.web.Host getHost()
public boolean isPublishTask()
true
if this entry represents a publish task.
true
if this entry represents a publish task.public boolean isUnpublishTask()
true
if this entry represents an unpublish task.
true
if this entry represents an unpublish task.public boolean isRepublishTask()
true
if this entry represents a republish task.
true
if this entry represents a republish task.public boolean isMoveTask()
true
if this entry represents a move task.
true
if this entry represents a move task.public Date getTimeQueued()
public Date getTimeLastFailed()
public Long getFailCount()
public String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |