IndexReadyMessage (NetarchiveSuite 7.0 API)

java.lang.Object
- dk.netarkivet.common.distribute.NetarkivetMessage
- - dk.netarkivet.harvester.distribute.HarvesterMessage
  - - dk.netarkivet.harvester.distribute.IndexReadyMessage

All Implemented Interfaces:

java.io.Serializable
```
public class IndexReadyMessage
extends HarvesterMessage
```
A message to send from the IndexServer to HarvestJobManager, that the index required by harvest with a given ID is ready.

See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor	Description
`IndexReadyMessage(java.lang.Long harvestId, boolean indexIsOK, ChannelID to, ChannelID replyTo)`	Constructor for the IndexReadyMessage.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`accept(HarvesterMessageVisitor v)`	Should be implemented as a part of the visitor pattern.
`java.lang.Long`	`getHarvestId()`
`boolean`	`getIndexOK()`	Is the index OK.

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

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

- Constructor Detail
  - IndexReadyMessage
```
public IndexReadyMessage(java.lang.Long harvestId,
                         boolean indexIsOK,
                         ChannelID to,
                         ChannelID replyTo)
```
    Constructor for the IndexReadyMessage.
    
    Parameters:
    
    harvestId - The harvestId that requires the index.
    
    indexIsOK - is the index now OK or not
    
    to - The destination channel
    
    replyTo - The channel to reply to (not really used).
- Method Detail
  - getHarvestId
```
public java.lang.Long getHarvestId()
```
    Returns:
    
    the Id of the harvest that requires this index.
  - accept
```
public void accept(HarvesterMessageVisitor v)
```
    Description copied from class: HarvesterMessage
    
    Should be implemented as a part of the visitor pattern. fx.: public void accept(HarvesterMessageVisitor v) { v.visit(this); }
    
    Specified by:
    
    accept in class HarvesterMessage
    
    Parameters:
    
    v - A message visitor
  - getIndexOK
```
public boolean getIndexOK()
```
    Is the index OK.
    
    Returns:
    
    true, if the index is OK, else false.