DisplayableValue.java

/**
 * Copyright (c) 2010-2014 Evolveum
 *
 * 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.evolveum.midpoint.util;

/**
 * @author Radovan Semancik
 *
 */
public interface DisplayableValue<T> {

	/**
	 * Retuns actual value. This may not be user-friendly.
	 */
	T getValue();
	
	/**
	 * Returns short user-friendly label.
	 * Catalog key may be returned instead of actual text.
	 */
	String getLabel();
	
	/**
	 * Returns longer description that can be used as a help text, 
	 * tooltip or for similar purpose. 
	 * Catalog key may be returned instead of actual text.
	 */
	String getDescription();
	
}