wt.queue
Class WtQueue

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          wt.queue.WtQueue

All Implemented Interfaces:

AccessControlled, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

Direct Known Subclasses:

ProcessingQueue, ScheduleQueue

public abstract class WtQueue

extends Item

implements Externalizable

Supported API: true

Extendable: false

See Also:

Serialized Form

Nested Class Summary

(package private) static class

WtQueue.QueueCacheUpdater Top level inner class which updates the queue cache

Field Summary

private static String	CLASSNAME
static String	DELETE_WHEN_EMPTY Label for the attribute.
private boolean	deleteWhenEmpty
static String	DELETING Supported API: false
private boolean	enabled
static String	ENABLED Label for the attribute.
static String	EXCEPTION_RETRIES Label for the attribute.
private Long	exceptionRetries
static String	EXECUTION_HOST Label for the attribute.
private static int	EXECUTION_HOST_UPPER_LIMIT
private String	executionHost
static long	EXTERNALIZATION_VERSION_UID
static String	FAILURE_NOTIFICATION_EMAIL Label for the attribute.
private static int	FAILURE_NOTIFICATION_EMAIL_UPPER_LIMIT
private String	failureNotificationEmail
static String	INIT
static String	LAST_NOTIFICATION_TIME Label for the attribute.
static String	LAST_STATE_SET Label for the attribute.
private static int	LAST_STATE_SET_UPPER_LIMIT
private Long	lastNotificationTime
private String	lastStateSet
private static long	LSUSPEND_DURATION
private String	name
static String	NAME Label for the attribute.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
protected static WTProperties	properties
static String	QUEUE_STATE Label for the attribute.
private static int	QUEUE_STATE_UPPER_LIMIT
private String	queueState
static String	REMOVE_FAILED_ENTIRES Label for the attribute.
private boolean	removeFailedEntires
private static String	RESOURCE
private static long	RETRIES
private boolean	running
static String	RUNNING Label for the attribute.
private static String	SENDER_EMAIL
(package private) static long	serialVersionUID
static String	STARTED Supported API: false
static String	STARTING Supported API: false
static String	STOPPED Supported API: false
static String	STOPPING Supported API: false
static String	SUSPEND_DURATION Label for the attribute.
static String	SUSPEND_UNTIL Label for the attribute.
private Long	suspendDuration
static String	SUSPENDED Supported API: false
private Long	suspendUntil
static String	TOTAL_ENTRIES Label for the attribute.
private Integer	totalEntries
protected static boolean	VERBOSE_INDUSTRIALIZATION
static String	WAITING_ENTRIES Label for the attribute.
private Integer	waitingEntries

Fields inherited from class wt.fc.Item

VERSION_40_UID, VERSION_51_UID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

WtQueue()

Method Summary

boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
void	execEntries() Execute queue entries Supported API: true
String	getCacheName()
Long	getExceptionRetries() Gets the value of the attribute: EXCEPTION_RETRIES.
String	getExecutionHost() Gets the value of the attribute: EXECUTION_HOST.
String	getFailureNotificationEmail() Gets the value of the attribute: FAILURE_NOTIFICATION_EMAIL.
Long	getLastNotificationTime() Gets the value of the attribute: LAST_NOTIFICATION_TIME.
String	getLastStateSet() Gets the value of the attribute: LAST_STATE_SET.
String	getName() Gets the value of the attribute: NAME.
abstract Class	getQType()
String	getQueueState() Gets the value of the attribute: QUEUE_STATE.
Long	getSuspendDuration() Gets the value of the attribute: SUSPEND_DURATION.
Long	getSuspendUntil() Gets the value of the attribute: SUSPEND_UNTIL.
Integer	getTotalEntries() Gets the value of the attribute: TOTAL_ENTRIES.
Integer	getWaitingEntries() Gets the value of the attribute: WAITING_ENTRIES.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
void	insert() Supported API: false
boolean	isDeleteWhenEmpty() Gets the value of the attribute: DELETE_WHEN_EMPTY.
boolean	isEnabled() Gets the value of the attribute: ENABLED.
boolean	isRemoveFailedEntires() Gets the value of the attribute: REMOVE_FAILED_ENTIRES.
boolean	isRunning() Gets the value of the attribute: RUNNING.
protected void	logQueueProblem()
void	notifyQueueAdmin()
boolean	queueSuspended()
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(WtQueue thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
WtQueue	refresh() Supported API: false
protected void	rollbackDanglingTransaction()
void	setDeleteWhenEmpty(boolean a_DeleteWhenEmpty) Sets the value of the attribute: DELETE_WHEN_EMPTY.
void	setEnabled(boolean a_Enabled) Sets the value of the attribute: ENABLED.
void	setExceptionRetries(Long a_ExceptionRetries) Sets the value of the attribute: EXCEPTION_RETRIES.
void	setExecutionHost(String a_ExecutionHost) Sets the value of the attribute: EXECUTION_HOST.
void	setFailureNotificationEmail(String a_FailureNotificationEmail) Sets the value of the attribute: FAILURE_NOTIFICATION_EMAIL.
void	setLastNotificationTime(Long a_LastNotificationTime) Sets the value of the attribute: LAST_NOTIFICATION_TIME.
void	setLastStateSet(String a_LastStateSet) Sets the value of the attribute: LAST_STATE_SET.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setQueueState(String a_QueueState) Sets the value of the attribute: QUEUE_STATE.
void	setRemoveFailedEntires(boolean a_RemoveFailedEntires) Sets the value of the attribute: REMOVE_FAILED_ENTIRES.
void	setRunning(boolean a_Running) Sets the value of the attribute: RUNNING.
void	setSuspendDuration(Long a_SuspendDuration) Sets the value of the attribute: SUSPEND_DURATION.
void	setSuspendTime()
void	setSuspendUntil(Long a_SuspendUntil) Sets the value of the attribute: SUSPEND_UNTIL.
void	setTotalEntries(Integer a_TotalEntries) Sets the value of the attribute: TOTAL_ENTRIES.
void	setWaitingEntries(Integer a_WaitingEntries) Sets the value of the attribute: WAITING_ENTRIES.
String	toString() Returns a string representaion of the queue.
void	update() Supported API: false
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class wt.fc.Item

getDomainRef, initialize, isInheritedDomain, readVersion, setDomainRef, setInheritedDomain

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

NAME

public static final String NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

EXECUTION_HOST

public static final String EXECUTION_HOST

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

EXECUTION_HOST_UPPER_LIMIT

private static int EXECUTION_HOST_UPPER_LIMIT

executionHost

private String executionHost

ENABLED

public static final String ENABLED

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

enabled

private boolean enabled

RUNNING

public static final String RUNNING

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

running

private boolean running

REMOVE_FAILED_ENTIRES

public static final String REMOVE_FAILED_ENTIRES

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

removeFailedEntires

private boolean removeFailedEntires

EXCEPTION_RETRIES

public static final String EXCEPTION_RETRIES

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

exceptionRetries

private Long exceptionRetries

DELETE_WHEN_EMPTY

public static final String DELETE_WHEN_EMPTY

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

deleteWhenEmpty

private boolean deleteWhenEmpty

QUEUE_STATE

public static final String QUEUE_STATE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

QUEUE_STATE_UPPER_LIMIT

private static int QUEUE_STATE_UPPER_LIMIT

queueState

private String queueState

LAST_STATE_SET

public static final String LAST_STATE_SET

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

LAST_STATE_SET_UPPER_LIMIT

private static int LAST_STATE_SET_UPPER_LIMIT

lastStateSet

private String lastStateSet

STARTING

public static final String STARTING

Supported API: false

See Also:

Constant Field Values

STARTED

public static final String STARTED

Supported API: false

See Also:

Constant Field Values

STOPPING

public static final String STOPPING

Supported API: false

See Also:

Constant Field Values

STOPPED

public static final String STOPPED

Supported API: false

See Also:

Constant Field Values

DELETING

public static final String DELETING

Supported API: false

See Also:

Constant Field Values

SUSPENDED

public static final String SUSPENDED

Supported API: false

See Also:

Constant Field Values

SUSPEND_UNTIL

public static final String SUSPEND_UNTIL

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

suspendUntil

private Long suspendUntil

SUSPEND_DURATION

public static final String SUSPEND_DURATION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

suspendDuration

private Long suspendDuration

FAILURE_NOTIFICATION_EMAIL

public static final String FAILURE_NOTIFICATION_EMAIL

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

FAILURE_NOTIFICATION_EMAIL_UPPER_LIMIT

private static int FAILURE_NOTIFICATION_EMAIL_UPPER_LIMIT

failureNotificationEmail

private String failureNotificationEmail

LAST_NOTIFICATION_TIME

public static final String LAST_NOTIFICATION_TIME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

lastNotificationTime

private Long lastNotificationTime

TOTAL_ENTRIES

public static final String TOTAL_ENTRIES

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

totalEntries

private Integer totalEntries

WAITING_ENTRIES

public static final String WAITING_ENTRIES

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

waitingEntries

private Integer waitingEntries

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

INIT

public static final String INIT

See Also:

Constant Field Values

VERBOSE_INDUSTRIALIZATION

protected static final boolean VERBOSE_INDUSTRIALIZATION

LSUSPEND_DURATION

private static final long LSUSPEND_DURATION

RETRIES

private static final long RETRIES

properties

protected static WTProperties properties

SENDER_EMAIL

private static String SENDER_EMAIL

Constructor Detail

WtQueue

public WtQueue()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class Item

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class Item

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WtQueue thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class Item

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class Item

Parameters:

input -

Throws:

SQLException

DatastoreException

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)

Sets the value of the attribute: NAME.

Supported API: false

Parameters:

a_Name -

getExecutionHost

public String getExecutionHost()

Gets the value of the attribute: EXECUTION_HOST.

Supported API: false

Returns:

String

setExecutionHost

public void setExecutionHost(String a_ExecutionHost)

Sets the value of the attribute: EXECUTION_HOST.

Supported API: false

Parameters:

a_ExecutionHost -

isEnabled

public boolean isEnabled()

Gets the value of the attribute: ENABLED.

Supported API: false

Returns:

boolean

setEnabled

public void setEnabled(boolean a_Enabled)

Sets the value of the attribute: ENABLED.

Supported API: false

Parameters:

a_Enabled -

isRunning

public boolean isRunning()

Gets the value of the attribute: RUNNING.

Supported API: false

Returns:

boolean

setRunning

public void setRunning(boolean a_Running)

Sets the value of the attribute: RUNNING.

Supported API: false

Parameters:

a_Running -

isRemoveFailedEntires

public boolean isRemoveFailedEntires()

Gets the value of the attribute: REMOVE_FAILED_ENTIRES.

Supported API: false

Returns:

boolean

setRemoveFailedEntires

public void setRemoveFailedEntires(boolean a_RemoveFailedEntires)

Sets the value of the attribute: REMOVE_FAILED_ENTIRES.

Supported API: false

Parameters:

a_RemoveFailedEntires -

getExceptionRetries

public Long getExceptionRetries()

Gets the value of the attribute: EXCEPTION_RETRIES.

Supported API: false

Returns:

Long

setExceptionRetries

public void setExceptionRetries(Long a_ExceptionRetries)

Sets the value of the attribute: EXCEPTION_RETRIES.

Supported API: false

Parameters:

a_ExceptionRetries -

isDeleteWhenEmpty

public boolean isDeleteWhenEmpty()

Gets the value of the attribute: DELETE_WHEN_EMPTY.

Supported API: false

Returns:

boolean

setDeleteWhenEmpty

public void setDeleteWhenEmpty(boolean a_DeleteWhenEmpty)

Sets the value of the attribute: DELETE_WHEN_EMPTY.

Supported API: false

Parameters:

a_DeleteWhenEmpty -

getQueueState

public String getQueueState()

Gets the value of the attribute: QUEUE_STATE.

Supported API: false

Returns:

String

setQueueState

public void setQueueState(String a_QueueState)

Sets the value of the attribute: QUEUE_STATE.

Supported API: false

Parameters:

a_QueueState -

getLastStateSet

public String getLastStateSet()

Gets the value of the attribute: LAST_STATE_SET.

Supported API: false

Returns:

String

setLastStateSet

public void setLastStateSet(String a_LastStateSet)

Sets the value of the attribute: LAST_STATE_SET.

Supported API: false

Parameters:

a_LastStateSet -

getSuspendUntil

public Long getSuspendUntil()

Gets the value of the attribute: SUSPEND_UNTIL.

Supported API: false

Returns:

Long

setSuspendUntil

public void setSuspendUntil(Long a_SuspendUntil)

Sets the value of the attribute: SUSPEND_UNTIL.

Supported API: false

Parameters:

a_SuspendUntil -

getSuspendDuration

public Long getSuspendDuration()

Gets the value of the attribute: SUSPEND_DURATION.

Supported API: false

Returns:

Long

setSuspendDuration

public void setSuspendDuration(Long a_SuspendDuration)

Sets the value of the attribute: SUSPEND_DURATION.

Supported API: false

Parameters:

a_SuspendDuration -

getFailureNotificationEmail

public String getFailureNotificationEmail()

Gets the value of the attribute: FAILURE_NOTIFICATION_EMAIL.

Supported API: false

Returns:

String

setFailureNotificationEmail

public void setFailureNotificationEmail(String a_FailureNotificationEmail)

Sets the value of the attribute: FAILURE_NOTIFICATION_EMAIL.

Supported API: false

Parameters:

a_FailureNotificationEmail -

getLastNotificationTime

public Long getLastNotificationTime()

Gets the value of the attribute: LAST_NOTIFICATION_TIME.

Supported API: false

Returns:

Long

setLastNotificationTime

public void setLastNotificationTime(Long a_LastNotificationTime)

Sets the value of the attribute: LAST_NOTIFICATION_TIME.

Supported API: false

Parameters:

a_LastNotificationTime -

getTotalEntries

public Integer getTotalEntries()

Gets the value of the attribute: TOTAL_ENTRIES.

Supported API: false

Returns:

Integer

setTotalEntries

public void setTotalEntries(Integer a_TotalEntries)
                     throws WTPropertyVetoException

Sets the value of the attribute: TOTAL_ENTRIES.

Supported API: false

Parameters:

a_TotalEntries -

Throws:

WTPropertyVetoException

getWaitingEntries

public Integer getWaitingEntries()

Gets the value of the attribute: WAITING_ENTRIES.

Supported API: false

Returns:

Integer

setWaitingEntries

public void setWaitingEntries(Integer a_WaitingEntries)
                       throws WTPropertyVetoException

Sets the value of the attribute: WAITING_ENTRIES.

Supported API: false

Parameters:

a_WaitingEntries -

Throws:

WTPropertyVetoException

execEntries

public void execEntries()
                 throws WTException

Execute queue entries

Supported API: true

Throws:

WTException

toString

public String toString()

Returns a string representaion of the queue.

Supported API: true

Overrides:

toString in class WTObject

Returns:

String

insert

public void insert()
            throws WTException

Supported API: false

Throws:

WTException

update

public void update()
            throws WTException

Supported API: false

Throws:

WTException

refresh

public WtQueue refresh()
                throws WTException

Supported API: false

Returns:

WtQueue

Throws:

WTException

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class Item

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class Item

Returns:

int

queueSuspended

public boolean queueSuspended()
                       throws WTException

Throws:

WTException

setSuspendTime

public void setSuspendTime()

notifyQueueAdmin

public void notifyQueueAdmin()

rollbackDanglingTransaction

protected void rollbackDanglingTransaction()

logQueueProblem

protected void logQueueProblem()

getCacheName

public String getCacheName()

getQType

public abstract Class getQType()