wt.queue
Class WtQueueEntry

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

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, NetFactor, ObjectMappable, Persistable, DisplayIdentification

Direct Known Subclasses:

QueueEntry, ScheduleQueueEntry

public abstract class WtQueueEntry
extends Item
implements Externalizable

Supported API: true

Extendable: false

See Also:

Serialized Form

Method Summary

wt.queue.StatusInfo	execute() Executes the entry's processing request.
String	getDisplayString() Supported API: true
WTPrincipal	getPrincipal() Returns the principal that owns the entry's execution.
void	setStatus(String status_code) Sets the status code of the entry to passed as argument.
String	toString() Returns a string representation of the entry.

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

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

Method Detail

execute

public wt.queue.StatusInfo execute()
                            throws WTException

Executes the entry's processing request. Assumes the identity of the entry's principal for the execution.

Supported API: true

Returns:

StatusInfo

Throws:

WTException

toString

public String toString()

Returns a string representation of the entry.

Supported API: true

Returns:

String

getPrincipal

public WTPrincipal getPrincipal()
                         throws WTException

Returns the principal that owns the entry's execution. The access control for execution will be enforced relative to this principal.

Supported API: true

Returns:

WTPrincipal

Throws:

WTException

setStatus

public void setStatus(String status_code)
               throws WTException

Sets the status code of the entry to passed as argument. The only statuses allowed are READY and SUSPENDED. The message is set to "Status set by operator." (it is defined in the resource bundle of the package.

Supported API: true

Parameters:

status_code -

Throws:

WTException

getDisplayString

public String getDisplayString()

Supported API: true

Returns:

String