BatchTerminationMessage (NetarchiveSuite 7.1 API)

java.lang.Object
- dk.netarkivet.common.distribute.NetarkivetMessage
- - dk.netarkivet.archive.bitarchive.distribute.BatchTerminationMessage

All Implemented Interfaces:

Serializable
```
public class BatchTerminationMessage
extends NetarkivetMessage
```
Message for telling the bitarchives to terminate a specific batchjob.

See Also:

Serialized Form

Field Summary
- Fields inherited from class dk.netarkivet.common.distribute.NetarkivetMessage
  replyOfId

Constructor Summary

Constructors
Constructor	Description
`BatchTerminationMessage(ChannelID to, ChannelID replyTo, String batchID)`	Constructor.
`BatchTerminationMessage(ChannelID to, String batchID)`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getTerminateID()`	Method for retrieving the ID of the batchjob to terminate.
`String`	`toString()`	Extends the default toString of NetarkiveMessage with the terminateID.

Methods inherited from class dk.netarkivet.common.distribute.NetarkivetMessage
getErrMsg, getID, getReplyOfId, getReplyTo, getTo, hasBeenSent, isOk, setNotOk, setNotOk

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BatchTerminationMessage
```
public BatchTerminationMessage(ChannelID to,
                               String batchID)
                        throws ArgumentNotValid
```
    Constructor.
    
    Parameters:
    
    to - Where the message should be sent.
    
    batchID - The ID of the batchjob to terminate.
    
    Throws:
    
    ArgumentNotValid - If the batchID is either null or the empty string.
  - BatchTerminationMessage
```
public BatchTerminationMessage(ChannelID to,
                               ChannelID replyTo,
                               String batchID)
                        throws ArgumentNotValid
```
    Constructor.
    
    Parameters:
    
    to - Where the message should be sent.
    
    replyTo - Where the message is sent from.
    
    batchID - The ID of the batchjob to terminate.
    
    Throws:
    
    ArgumentNotValid - If the batchID is either null or the empty string.
- Method Detail
  - getTerminateID
```
public String getTerminateID()
```
    Method for retrieving the ID of the batchjob to terminate.
    
    Returns:
    
    The ID of the batchjob to terminate.
  - toString
```
public String toString()
```
    Extends the default toString of NetarkiveMessage with the terminateID.
    
    Overrides:
    
    toString in class NetarkivetMessage
    
    Returns:
    
    The string representation of this message.