fr.gouv.vitam.processing.common.model

Interface EngineResponse

All Known Implementing Classes:

ExtractUriResponse, ProcessResponse

public interface EngineResponse

Model of Response from worker

Method Summary

Modifier and Type	Method and Description
int	getErrorNumber()
String	getMessageIdentifier()
Map<String,OutcomeMessage>	getOutcomeMessages()
StatusCode	getStatus()
String	getValue()
EngineResponse	setErrorNumber(int number)
EngineResponse	setMessageIdentifier(String message)
EngineResponse	setOutcomeMessages(String handlerId, OutcomeMessage messages)
EngineResponse	setStatus(StatusCode status)

Method Detail

getStatus

StatusCode getStatus()

Returns:

Enum StatusCode {OK,KO,FATAL}

getValue

String getValue()

Returns:

StatusCode value {OK,KO,FATAL}

setStatus

EngineResponse setStatus(StatusCode status)

Parameters:

status - ENUM statusCode

Returns:

EngineResponse

getOutcomeMessages

Map<String,OutcomeMessage> getOutcomeMessages()

Returns:

list of functional error message

setOutcomeMessages

EngineResponse setOutcomeMessages(String handlerId,
                                  OutcomeMessage messages)

Parameters:

messages - Outcome Messages of response

handlerId - handler name or id

Returns:

EngineResponse

getErrorNumber

int getErrorNumber()

Returns:

list of functional error message

setErrorNumber

EngineResponse setErrorNumber(int number)

Parameters:

number - the number of errors during the workflow

Returns:

EngineResponse

getMessageIdentifier

String getMessageIdentifier()

Returns:

message identifier of seda

setMessageIdentifier

EngineResponse setMessageIdentifier(String message)

Parameters:

message - identifier of seda

Returns:

EngineResponse