de.bsvrz.dav.daf.communication.lowLevel.telegrams
Class ReceiveSubscriptionInfo

java.lang.Object
  extended by de.bsvrz.dav.daf.communication.lowLevel.telegrams.ReceiveSubscriptionInfo

public class ReceiveSubscriptionInfo
extends Object

Author:
Kappich Systemberatung

Constructor Summary
ReceiveSubscriptionInfo()
          Creates new ReceiveSubscriptionInfo
ReceiveSubscriptionInfo(BaseSubscriptionInfo baseSubscriptionInfo, ReceiveOptions receiveOptions, ReceiverRole receiverRole)
          Erzeugt ein neues Objekt mit den gegebenen Parametern.
 
Method Summary
 ReceiveSubscriptionInfo cloneObject()
          Gibt eine Kopie des Objektes zurück.
 BaseSubscriptionInfo getBaseSubscriptionInfo()
          Gibt die Basisanmeldeinformationen zurück.
 boolean getDelayedDataFlag()
          Gibt an, ob Interesse an nachgelieferten oder an aktuellen Datensätzen besteht.
 boolean getDeltaDataFlag()
          Gibt an, ob Interesse an nur den geänderten Datensätzen oder an allen Datensätzen besteht.
 long getLastDataIndex()
          Gibt den letzten Index des Datensatzes, den die Applikation empfangen hat, zurück.
 byte getLastErrorState()
          Gibt den letzten Fehlerstatus zurück.
 int getLength()
          Gibt die Länge dieses Telegrams zurück
 ReceiveOptions getReceiveOptions()
          Gibt die Informationen über die Empfangsoptionen zurück.
 ReceiverRole getReceiverRole()
          Gibt die Informationen über die Empfangsapplikationsrole zurück.
 boolean isDrain()
          Gibt an, ob die Applikation als Senke für dieses Datum angemeldet ist oder nicht.
 boolean isReceiver()
          Gibt an, ob die Applikation als ein normaler Empfänger für diese Datums angemeldet ist oder nicht.
 String parseToString()
          Gibt einen String zurrück, der diesen Datensatz beschreibt.
 void read(DataInputStream in)
          Lesen eines Datensatzes vom übergegebenen DataInputStream
 void setLastDataIndex(long newDataIndex)
          Setzt den letzten Index des Datensatzes, den die Applikation empfangen hat.
 void setLastErrorState(byte error)
          Setzt den letzten Fehlerstatus.
 boolean updateSubscriptionInfo(ReceiveSubscriptionInfo receiveSubscriptionInfo)
          Aktualisiert diese Empfangsanmeldeinformationen durch Vereinigung mit einer weiteren Empfangsanmeldeinformation
 void write(DataOutputStream out)
          Schreiben eines Datensatzes in den übergegebenen DataOutputStream
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReceiveSubscriptionInfo

public ReceiveSubscriptionInfo()
Creates new ReceiveSubscriptionInfo


ReceiveSubscriptionInfo

public ReceiveSubscriptionInfo(BaseSubscriptionInfo baseSubscriptionInfo,
                               ReceiveOptions receiveOptions,
                               ReceiverRole receiverRole)
Erzeugt ein neues Objekt mit den gegebenen Parametern.

Parameters:
baseSubscriptionInfo - Basisanmeldeinformationen
receiveOptions - Anmeldeoptionen der Empfangsanmeldungen
receiverRole - ApplikationsRole
Method Detail

getBaseSubscriptionInfo

public final BaseSubscriptionInfo getBaseSubscriptionInfo()
Gibt die Basisanmeldeinformationen zurück.

Returns:
Basisanmeldeinformationen

getDelayedDataFlag

public final boolean getDelayedDataFlag()
Gibt an, ob Interesse an nachgelieferten oder an aktuellen Datensätzen besteht.

Returns:
true: nachgelieferte Datensätze erwünscht, false: nachgelieferte Datensätze nicht erwünscht

getDeltaDataFlag

public final boolean getDeltaDataFlag()
Gibt an, ob Interesse an nur den geänderten Datensätzen oder an allen Datensätzen besteht.

Returns:
true: nur geänderte Datensätze erwünscht, false: alle Datensätze erwünscht

isReceiver

public final boolean isReceiver()
Gibt an, ob die Applikation als ein normaler Empfänger für diese Datums angemeldet ist oder nicht.

Returns:
true: Applikation ist normaler Emfänger, false: Applikation ist kein normaler Empfänger

isDrain

public final boolean isDrain()
Gibt an, ob die Applikation als Senke für dieses Datum angemeldet ist oder nicht.

Returns:
true:Applikation ist als Senke angemeldet, false:Applikation ist nicht als Senke angemeldet.

getReceiveOptions

public final ReceiveOptions getReceiveOptions()
Gibt die Informationen über die Empfangsoptionen zurück.

Returns:
Informationen über die Empfangsoptionen

getReceiverRole

public final ReceiverRole getReceiverRole()
Gibt die Informationen über die Empfangsapplikationsrole zurück.

Returns:
Informationen über die Empfangsapplikationsrole

getLastDataIndex

public final long getLastDataIndex()
Gibt den letzten Index des Datensatzes, den die Applikation empfangen hat, zurück.

Returns:
Index des Datensatzes

setLastDataIndex

public final void setLastDataIndex(long newDataIndex)
Setzt den letzten Index des Datensatzes, den die Applikation empfangen hat.

Parameters:
newDataIndex - Datenindex

getLastErrorState

public final byte getLastErrorState()
Gibt den letzten Fehlerstatus zurück.

Returns:
letzter Fehlerstatus

setLastErrorState

public final void setLastErrorState(byte error)
Setzt den letzten Fehlerstatus.

Parameters:
error - Fehlerstatus

cloneObject

public final ReceiveSubscriptionInfo cloneObject()
Gibt eine Kopie des Objektes zurück.

Returns:
Kopie des Objektes

updateSubscriptionInfo

public final boolean updateSubscriptionInfo(ReceiveSubscriptionInfo receiveSubscriptionInfo)
Aktualisiert diese Empfangsanmeldeinformationen durch Vereinigung mit einer weiteren Empfangsanmeldeinformation

Parameters:
receiveSubscriptionInfo - Weitere Empfangsanmeldeinformation
Returns:
true bei Änderung dieser Empfangsanmeldeinformation, false sonst

parseToString

public final String parseToString()
Gibt einen String zurrück, der diesen Datensatz beschreibt.

Returns:
String, der diesen Datensatz beschreibt

write

public final void write(DataOutputStream out)
                 throws IOException
Schreiben eines Datensatzes in den übergegebenen DataOutputStream

Parameters:
out - DataOutputStream
Throws:
IOException, - wenn ein Fehler beim Schreiben in den Ausgabestream auftritt.
IOException

read

public final void read(DataInputStream in)
                throws IOException
Lesen eines Datensatzes vom übergegebenen DataInputStream

Parameters:
in - DataInputStream
Throws:
IOException, - wenn ein Fehler beim Lesen des Streams auftritt.
IOException

getLength

public int getLength()
Gibt die Länge dieses Telegrams zurück

Returns:
die Länge dieses Telegrams