io.pelle.mango.client.base.db.vos.IHierarchicalVO Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mango-client-base Show documentation

mango web framework

The newest version!

/**
 * Copyright (c) 2013 Christian Pelster.
 * 
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     Christian Pelster - initial API and implementation
 */
package io.pelle.mango.client.base.db.vos;

import io.pelle.mango.client.base.vo.AttributeDescriptor;
import io.pelle.mango.client.base.vo.IAttributeDescriptor;
import io.pelle.mango.client.base.vo.IBaseVO;

/**
 * Interface for nodes in trees
 * 
 * @author pelle
 * 
 */
public interface IHierarchicalVO extends IBaseHierarchical, IBaseVO {

	public static final IAttributeDescriptor FIELD_PARENT = new AttributeDescriptor(ENTITY_DESCRIPTOR, "parent", IHierarchicalVO.class);

	public static final String PARENT_CLASS_FIELD_NAME = "parentClassName";

	public static final String PARENT_ID_FIELD_NAME = "parentId";

	/**
	 * Returns whether this node has children
	 * 
	 * @return
	 */
	Boolean getHasChildren();

	/**
	 * Sets the children for this node
	 * 
	 * @param hasChildren
	 */
	void setHasChildren(Boolean hasChildren);

	/**
	 * Sets the parent
	 * 
	 * @param parent
	 */
	void setParent(IHierarchicalVO parent);

	/**
	 * Returns the parent specified by
	 * {@link IBaseHierarchical#getParentClassName()} and
	 * {@link IBaseHierarchical#getParentId()}
	 * 
	 * @return
	 */
	IHierarchicalVO getParent();

}