Class JobInProgress

    • 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 hat
      long getClientId()
      Gibt die Applikations-ID des beauftragenden Clients zurück
      long 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 Datenmodells
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • 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-ID
        operationCode - Operationscode
        jobState - Flag "in Bearbeitung"
        status - Bearbeitungsfortschritt
        startTime - Startzeit
        clientId - Client-ID
        parameters - 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.
      • 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
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object