/*
 * Copyright 2016-2016 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 com.bitofcode.auth4j.api.model;

import java.io.Serializable;

/**
 * Interface to indicate a confirmable Class / Instance.
 * 
 * @since 0.0.1
 * 
 * @author Wassim Akachi
 * 
 */

public interface Confirmable extends Serializable {

	/**
	 * Tell the caller if a confirmation is required.
	 * 
	 * @return returns <strong>true</strong>, if a confirmation is required.
	 *         returns <strong>false</strong>, if a confirmation isn't required.
	 */
	public boolean isConfirmationRequired();

	/**
	 * Tell the caller if the confirmation is already happened.
	 * 
	 * @return returns <strong>true</strong> if a confirmation is already
	 *         successfully happened. returns <strong>false</stronG> if a
	 *         confirmation is pending.
	 */
	public boolean isConfirmed();

}
