Package de.bsvrz.pua.prot.util
Class JobInProgress
- java.lang.Object
-
- de.bsvrz.pua.prot.util.JobInProgress
-
- All Implemented Interfaces:
java.io.Serializable
public class JobInProgress extends java.lang.Object implements java.io.Serializable
Diese Klasse bildet einen in Bearbeitung befindlichen Auftrag ab
-
-
Constructor Summary
Constructors Constructor Description JobInProgress(long jobId, int operationCode, JobState jobState, byte status, long startTime, long clientId, java.lang.Object parameters)
Erstellt einen neuen JobInProgress
-
Method Summary
Modifier and Type Method Description de.bsvrz.dav.daf.main.config.ClientApplication
getClient()
Gibt das Applikationsobjekt zurück, das den Auftrag veranlasst hatlong
getClientId()
Gibt die Applikations-ID des beauftragenden Clients zurücklong
getJobId()
Gibt die Anfrage-ID des Auftrags zurück.JobState
getJobState()
Gibt den Berabeitungszustands des Auftrag zurück (z.B: in Warteschlange, in Bearbeitung, beendet)int
getOperationCode()
Anfragekennung/Operationscode des protokollbezogenen Auftrags.java.lang.String
getOperationName()
Gibt den Namen der Operation zurück, die sich hinter dem Operationscode verbirgt.java.lang.Object
getParameters()
Gibt die Parameter des Auftrags zurück.long
getStartTime()
Gibt die Startzeit des Auftrags zurück (wann der Auftrag von PuA entgegengenommen wurde)byte
getStatus()
Gibt den Fortschritt des Auftrags zurück.void
initialize(de.bsvrz.dav.daf.main.config.DataModel dataModel)
Interne Operation zum setzen des Datenmodellsjava.lang.String
toString()
-
-
-
Constructor Detail
-
JobInProgress
public JobInProgress(long jobId, int operationCode, JobState jobState, byte status, long startTime, long clientId, java.lang.Object parameters) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Erstellt einen neuen JobInProgress- Parameters:
jobId
- Auftrags-IDoperationCode
- OperationscodejobState
- Flag "in Bearbeitung"status
- BearbeitungsfortschrittstartTime
- StartzeitclientId
- Client-IDparameters
- Parameter des Auftrags (Operationsabhängig)- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Exception
-
-
Method Detail
-
initialize
public void initialize(de.bsvrz.dav.daf.main.config.DataModel dataModel)
Interne Operation zum setzen des Datenmodells- Parameters:
dataModel
- Datenmodell
-
getJobId
public long getJobId()
Gibt die Anfrage-ID des Auftrags zurück. Mit dieser Id kann der Auftrag z.B. angehalten oder abgebrochen werden.- Returns:
- Auftrags-ID.
-
getOperationCode
public int getOperationCode()
Anfragekennung/Operationscode des protokollbezogenen Auftrags. Dies entspricht den Statuswerten in att.puaProtokollOperationsCode. Mögliche Werte sind:ProtocolRelatedOperation.CREATE
(Protokoll erstellen)ProtocolRelatedOperation.SEND_SAVED_PROTOCOL
(Gespeichertes Protokoll abrufen)ProtocolRelatedOperation.SEND_UNREAD_PROTOCOL
(Ungelesenes Protokoll abrufen)
getOperationName()
benutzen um bei unbekannten Codes zumindest den Typ des Auftrags anzeigen zu können.)- Returns:
- Operationscode
- See Also:
ProtocolRelatedOperation
-
getOperationName
public java.lang.String getOperationName()
Gibt den Namen der Operation zurück, die sich hinter dem Operationscode verbirgt. Dieser Name kann z. B. für die Darstellung in einer GUI benutzt werden.- Returns:
- Name der Operation oder "" (Leerstring) falls der Name nicht ermittelbar ist.
-
getJobState
public JobState getJobState()
Gibt den Berabeitungszustands des Auftrag zurück (z.B: in Warteschlange, in Bearbeitung, beendet)- Returns:
- Bearbeitungszustand
-
getStatus
public byte getStatus()
Gibt den Fortschritt des Auftrags zurück.- Returns:
- Prozent-Wert von 0-100. Bei Aufträgen in Warteschlange 0.
-
getStartTime
public long getStartTime()
Gibt die Startzeit des Auftrags zurück (wann der Auftrag von PuA entgegengenommen wurde)- Returns:
- Startzeit in Millisekunden (analog zu
System.currentTimeMillis()
, oder -1 falls unbekannt (z. B. aufgrund einer veralteten PuA-Server-Implementierung)
-
getClientId
public long getClientId()
Gibt die Applikations-ID des beauftragenden Clients zurück- Returns:
- die Applikations-ID des beauftragenden Clients, oder -1 falls unbekannt (z. B. aufgrund einer veralteten PuA-Server-Implementierung)
-
getClient
public de.bsvrz.dav.daf.main.config.ClientApplication getClient()
Gibt das Applikationsobjekt zurück, das den Auftrag veranlasst hat- Returns:
- Applikationsobjekt oder null falls nicht ermittelbar (z. B. aufgrund einer veralteten PuA-Server-Implementierung)
-
getParameters
public java.lang.Object getParameters()
Gibt die Parameter des Auftrags zurück.- Bei Protokoll-Erstellen-Aufträgen ein Objekt vom Typ
ProcessingParameter
. - Beim Abrufen gespeicherter oder ungelesener Protokolle ein Long mit der Protokoll-Id.
- Returns:
- Operationsspezifische Parameter des Auftrags oder null falls mit der aktuellen Softwareversion nicht interpretierbar/nicht vorhanden
- Bei Protokoll-Erstellen-Aufträgen ein Objekt vom Typ
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-