/*
 * Copyright 2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.bremersee.exception;

import org.springframework.lang.Nullable;

/**
 * Marker interface to get an error code.
 *
 * @author Christian Bremer
 */
public interface ErrorCodeAware {

  /**
   * The default value of the 'code' attribute.
   */
  String NO_ERROR_CODE_VALUE = "UNSPECIFIED";

  /**
   * Gets the error code.
   *
   * @return the error code
   */
  @Nullable
  String getErrorCode();

}
