sos.spooler.Order Maven / Gradle / Ivy
// $Id: Order.java 6009 2009-06-12 12:08:23Z jz $
package sos.spooler;
/*+ Ein Auftrag zur Verarbeitung durch einen Job.
*
*
* Ein Auftrag, der in der Auftragswarteschlange eines Jobs steht, veranlasst diesen, einen Jobschritt
* (also {@link Job_impl#spooler_process()}) durchzuführen.
*
*
Beispiel
*
* Order order = spooler.create_order();
* order.set_id ( "10001" );
* order.set_title( "Auftrag für Datensatz 10001" );
* order.set_state( "100" );
* spooler.job_chain( "jobkette1" ).add_order( order );
*
*
*
Beispiel (Javascript)
*
* var order = spooler.create_order();
* order.id = "10001";
* order.title = "Auftrag für Datensatz 10001";
* order.state = 100;
* spooler.job_chain( "jobkette1" ).add_order( order );
*
*
* @see Spooler#create_order()
* @see Spooler#job_chain(String)
* @see Task#order()
*/
import java.util.Date;
/**
* @author Joacim Zschimmer
* @version $Revision: 6009 $
*/
public class Order extends Idispatch implements HasBean
{
public Order(Invoker invoker) {
super(invoker);
}
private Order ( long idispatch ) { super(idispatch); }
/*+ Stellt die Kennung des Auftrags ein.
*
*
* Jeder Auftrag hat eine (innerhalb der Jobkette oder der Auftragswarteschlange des Jobs eindeutige) Kennung.
* Diese Kennung sollten den zu verarbeitenden Daten entsprechen.
* Übrlicherweise wird der Schlüssel eines Datenbanksatzes verwendet.
*
* Ohne diesen Aufruf vergibt der Aufruf {@link Job_chain#add_order(Order)} bzw. {@link Order_queue#add_order(Order)} eine Kennung.
*
* @param value Die Kennung
*/
public void set_id ( String value ) { com_call( ">id", value ); }
/*+ Liefert die Kennung des Auftrags. */
@SchedulerGetter
public String id () { return com_call( "title", value ); }
/*+ Der Titel ist ein Klartext, der den Auftrag bezeichnet. */
@SchedulerGetter
public String title () { return (String) com_call( "priority", value ); }
/*+ Aufträge mit höherer Priorität werden zuerst abgearbeitet. */
@SchedulerGetter
public int priority () { return int_com_call( "
* Besser ist der Aufruf von {@link #set_state(String)}.
*/
//public void set_job ( Job job ) { com_call( ">job", job ); }
/*+ Stellt den Zustand des Auftrags auf den Zustand ein, der dem Job in Jobkette entspricht.
*
*
* Besser ist der Aufruf von {@link #set_state(String)}.
*/
//public void set_job ( String job_name ) { com_call( ">job", job_name ); }
/*+
* Liefert den Job, in dessen Auftragswarteschlange sich der Auftrag befindet, oder null.
*/
//public Job job () { return (Job) com_call( "
* Wenn der Auftrag in einer Jobkette ist, wird der Auftrag an die entsprechende Stelle der Jobkette verschoben.
* @param value
*/
public void set_state ( String value ) { com_call( ">state", value ); }
/*+
* Liefert den Zustand des Auftrags.
*/
@SchedulerGetter
public String state () { return (String) com_call( "state_text", value ); }
/*+ Liefert den mit set_state_text() eingestellten Text. */
@SchedulerGetter
public String state_text () { return (String) com_call( "payload", payload ); }
/*+ Liefert den mit set_payload() eingestellten Wert.
* Das kann ein {@link Variable_set} sein:
*
* Variable_set variable_set = (Variable_set)spooler_task.payload();
* String value = variable_set.var( "einparameter" );
*
*/
@SchedulerGetter
public Object payload () { return com_call( " (zur periodischen Wiederholung des Auftrags).
*
*/
@SchedulerGetter
public Run_time run_time () { return (Run_time) com_call( "
* Wenn der Auftrag gerade von einer Task ausgeführt wird,
* liefert die Eigenschaft {@link #job_chain}
* weiterhin die Jobkette, aus der der Auftrag gerade entfernt wird.
* Erst wenn die Ausführung beendet ist, liefert die Eigenschaft null
* (außer der Auftrag ist wieder in eine Jobkette eingetragen worden).
* Damit bleibt die Eigenschaft job_chain während der Ausführung durch die Task stabil.
*/
public void remove_from_job_chain() { com_call( "remove_from_job_chain" ); }
//(Konvertierung nach Date macht Probleme wegen Sommerzeit)
//public Date at () { return (Date) com_call( "xml_payload", xml ); }
@SchedulerGetter
public String xml_payload () { return (String) com_call( "params", v ); }
@SchedulerGetter
public Variable_set params () { return (Variable_set)com_call( "at", date_time ); }
//public void set_at ( java.util.Date date ) { com_call( ">at", date ); }
public void set_at ( Date date ) { set_at( new java.text.SimpleDateFormat( "yyyy-MM-dd HH:mm:ss.SSS" ).format( date ) ); }
public void set_suspended ( boolean b ) { com_call( ">suspended", b ); }
@SchedulerGetter
public boolean suspended () { return boolean_com_call( "end_state", value ); }
@SchedulerGetter
public String end_state () { return (String) com_call( "ignore_max_orders", b ); }
@SchedulerGetter
public boolean ignore_max_orders () { return boolean_com_call( "