Package com.yahoo.documentapi.messagebus.protocol

Class RemoveLocationMessage

java.lang.Object

com.yahoo.messagebus.Routable

com.yahoo.messagebus.Message

com.yahoo.documentapi.messagebus.protocol.DocumentMessage

com.yahoo.documentapi.messagebus.protocol.RemoveLocationMessage

public class RemoveLocationMessage
extends DocumentMessage

Message to remove an entire location for users using n= or g= schemes. We use a document selection so the user can specify a subset of those documents to be deleted if they wish.

Constructor Summary

Constructors

Constructor	Description
RemoveLocationMessage(String documentSelection)
RemoveLocationMessage(String documentSelection, String bucketSpace)

Method Summary

Modifier and Type	Method	Description
DocumentReply	createReply()	Creates and returns a reply to this message.
com.yahoo.document.BucketId	getBucketId()
String	getBucketSpace()
String	getDocumentSelection()
int	getType()

Methods inherited from class com.yahoo.documentapi.messagebus.protocol.DocumentMessage

getApproxSize, getPriority, getProtocol, setPriority, swapState

Methods inherited from class com.yahoo.messagebus.Message

getBucketSequence, getRetry, getRetryEnabled, getRoute, getSequenceId, getTimeReceived, getTimeRemaining, getTimeRemainingNow, hasBucketSequence, hasSequenceId, isExpired, setRetry, setRetryEnabled, setRoute, setTimeReceived, setTimeReceivedNow, setTimeRemaining

Methods inherited from class com.yahoo.messagebus.Routable

discard, getCallStack, getContext, getTrace, popHandler, pushHandler, setContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RemoveLocationMessage

public RemoveLocationMessage(String documentSelection,
 String bucketSpace)

RemoveLocationMessage

public RemoveLocationMessage(String documentSelection)

Method Details

getDocumentSelection

public String getDocumentSelection()

createReply

public DocumentReply createReply()

Description copied from class: DocumentMessage

Creates and returns a reply to this message.

Specified by:

createReply in class DocumentMessage

Returns:

The created reply.

getType

public int getType()

Specified by:

getType in class com.yahoo.messagebus.Routable

getBucketId

public com.yahoo.document.BucketId getBucketId()

getBucketSpace

public String getBucketSpace()