org.openbp.common.generic.description.Validatable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openbp-common Show documentation

Common base for all OpenBP projects

There is a newer version: 0.9.11

/*
 *   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.openbp.common.generic.description;

import org.openbp.common.generic.msgcontainer.MsgContainer;

/**
 * Indicates that an object supports validating it's values.
 *
 * @author Heiko Erhardt
 */
public interface Validatable
{
	/**
	 * Checks if the object is valid.
	 * @param msgContainer Any errors will be logged to this message container
	 * @return
	 *		true	The object is valid.

	 *		false	Errors were found within the object or its sub objects.
	 */
	public boolean validate(MsgContainer msgContainer);
}