com.tenduke.events.api.model.data.ErrorInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of events-api Show documentation

Objects and interfaces describing data communicated in the 10Duke Event Data system API

There is a newer version: 1.9.0

package com.tenduke.events.api.model.data;

import com.fasterxml.jackson.annotation.JsonInclude;

/**
 * Interface for error information object.
 * @author jarkko
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
public interface ErrorInfo {

    /**
     * Gets the error code.
     * @return The error code.
     */
    String getError();

    /**
     * Gets the error description, may be given optionally.
     * @return The error description, may be {@code null}.
     */
    String getErrorDescription();

    /**
     * Gets URI for error details, may be given optionally.
     * @return The URI for error details, may be {@code null}.
     */
    String getErrorUri();
}