com.hcl.domino.keep.messages

Class StatusMessage

java.lang.Object

com.hcl.domino.keep.messages.StatusMessage

public class StatusMessage
extends java.lang.Object

Status Message for completed operations Mostly for successful operations

Constructor Summary

Constructors

Constructor and Description
StatusMessage(java.lang.String message) Constructor with message
StatusMessage(java.lang.String message, java.lang.Object... args) Constructor with message

Method Summary

Modifier and Type	Method and Description
StatusMessage	addDetail(io.vertx.core.json.JsonObject jDetails)
StatusMessage	addDetail(java.lang.String detail) When status needs to be more detailed, add here
StatusMessage	setMessage(java.lang.String message)
StatusMessage	setStatus(java.lang.String status)
StatusMessage	setStatusCode(int statusCode)
StatusMessage	setUnid(java.lang.String unid)
int	statusCode()
io.vertx.core.buffer.Buffer	toBuffer() Convenience function to return a status message as buffer mostly used in Buffer responses
io.vertx.core.json.JsonObject	toJson()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusMessage

public StatusMessage(java.lang.String message)

Constructor with message

Parameters:

message -

• Text to return

StatusMessage

public StatusMessage(java.lang.String message,
                     java.lang.Object... args)

Constructor with message

Parameters:

message -

• Text template to return

args -

• content

Method Detail

addDetail

public StatusMessage addDetail(io.vertx.core.json.JsonObject jDetails)

Parameters:

jDetails -

• JsonObject with details

Returns:

fluent

addDetail

public StatusMessage addDetail(java.lang.String detail)

When status needs to be more detailed, add here

Parameters:

detail -

• message details

Returns:

fluent

setMessage

public StatusMessage setMessage(java.lang.String message)

Parameters:

message - the message to set

Returns:

fluent

setStatus

public StatusMessage setStatus(java.lang.String status)

Parameters:

status - the status to set

Returns:

fluent

setStatusCode

public StatusMessage setStatusCode(int statusCode)

Parameters:

statusCode - the statusCode to set

Returns:

fluent

setUnid

public StatusMessage setUnid(java.lang.String unid)

Parameters:

unid - the unid to set

Returns:

fluent

statusCode

public int statusCode()

Returns:

the StatusCode

toBuffer

public io.vertx.core.buffer.Buffer toBuffer()

Convenience function to return a status message as buffer mostly used in Buffer responses

Returns:

Buffer with JSON

toJson

public io.vertx.core.json.JsonObject toJson()

Returns:

JSON Representation to be sent back

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object