Package wt.queue

Class ScheduleQueueEntry

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.fc._Item
wt.fc.Item
wt.queue._WtQueueEntry
wt.queue.WtQueueEntry
wt.queue._ScheduleQueueEntry
wt.queue.ScheduleQueueEntry
All Implemented Interfaces:
Externalizable, Serializable, wt.access._AccessControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, NetFactor, ObjectMappable, Persistable, DisplayIdentification, wt.locks._Lockable, Lockable
@GenAsPersistable(superClass=WtQueueEntry.class,interfaces=Lockable.class,versions=8582496956781349278L,properties={@GeneratedProperty(name="scheduleTime",type=java.sql.Timestamp.class),@GeneratedProperty(name="args",type=java.io.Serializable.class,accessors=@PropertyAccessors(getAccess=PRIVATE),columnProperties=@ColumnProperties(columnType=BLOB)),@GeneratedProperty(name="principalReference",type=ObjectReference.class,constraints=@PropertyConstraints(required=true))},derivedProperties=@DerivedProperty(name="principal",derivedFrom="principalReference",type=WTPrincipal.class,getBody="if (principalReference == null) return null; else return (wt.org.WTPrincipal)principalReference.getObject();",setBody="setPrincipalReference( principal == null ? null : wt.fc.ObjectReference.newObjectReference(principal) );",accessors=@PropertyAccessors(setExceptions={WTPropertyVetoException.class,WTException.class})),tableProperties=@TableProperties(compositeIndex1="queueRef.key.id+statusInfo.code+entryNumber",oracleTableSize=LARGE)) public class ScheduleQueueEntry extends wt.queue._ScheduleQueueEntry

Use the newScheduleQueueEntry static factory method(s), not the ScheduleQueueEntry constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: false

See Also:

  • Method Details

    • newScheduleQueueEntry

      public static ScheduleQueueEntry newScheduleQueueEntry(ScheduleQueue queue) throws WTException
      Constructs a new entry representing a processing queue request.

      Supported API: true
      Parameters:
      queue -
      Returns:
      ScheduleQueueEntry
      Throws:
      WTException

    • initialize

      protected void initialize(ScheduleQueue queue) throws WTException
      Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

      Supported API: true
      Parameters:
      queue -
      Throws:
      WTException

    • toString

      public String toString()
      Returns a string representation of the entry.

      Supported API: true
      Overrides:
      toString in class WtQueueEntry
      Returns:
      String

    • 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
      Overrides:
      setStatus in class WtQueueEntry
      Parameters:
      status_code -
      Throws:
      WTException

    • getQueue

      public ScheduleQueue getQueue() throws WTException
      Returns the queue to which the entry belongs.

      Supported API: true
      Returns:
      ScheduleQueue
      Throws:
      WTException

    • getDisplayString

      public String getDisplayString()


      Supported API: true
      Overrides:
      getDisplayString in class WtQueueEntry
      Returns:
      String