Customizable.java

/**
 * The contents of this file are subject to the OpenMRS Public License
 * Version 1.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://license.openmrs.org
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific language governing rights and limitations
 * under the License.
 *
 * Copyright (C) OpenMRS, LLC.  All Rights Reserved.
 */
package org.openmrs.attribute;

import java.util.Collection;
import java.util.List;
import java.util.Set;

/**
 * Marker interface for classes that may be customized by the user by adding custom attributes, e.g. Visit
 * has VisitAttributes, so it implements {@link Customizable}<VisitAttribute>
 * @param <AttrClass> the type of attribute held
 * @since 1.9
 */
public interface Customizable<AttrClass extends Attribute> {
	
	/**
	 * @return all attributes (including voided ones)
	 */
	Collection<AttrClass> getAttributes();
	
	/**
	 * @return non-voided attributes
	 */
	Collection<AttrClass> getActiveAttributes();
	
	/**
	 * @param ofType
	 * @return non-voided attributes of the given type
	 */
	List<AttrClass> getActiveAttributes(AttributeType<?> ofType);
	
	/**
	 * Adds an attribute. Will fail if this would cause the holder to have an invalid number of attributes
	 * of the given type.
	 * 
	 * @param attribute
	 */
	void addAttribute(AttrClass attribute);
	
	/**
	 * Sets an attribute, voiding any existing attributes on the holder of the same attribute type. Will
	 * fail if the relevant attribute type requires more than one value.
	 * 
	 * @param attribute
	 */
	void setAttribute(AttrClass attribute);
	
}