IParameter.java

/*
 This file belongs to the Servoy development and deployment environment, Copyright (C) 1997-2010 Servoy BV

 This program is free software; you can redistribute it and/or modify it under
 the terms of the GNU Affero General Public License as published by the Free
 Software Foundation; either version 3 of the License, or (at your option) any
 later version.

 This program is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License along
 with this program; if not, see http://www.gnu.org/licenses or write to the Free
 Software Foundation,Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
 */
package com.servoy.j2db.documentation;

public interface IParameter
{
	String getName();

	/**
	 * Get the java-script type name. It is constructed based on a tranlation to documented java class combined with on ServoyDocumented
	 * annotation public name or simple class name.<br>
	 * For example int => type = Number, IRuntimeComponent.class realType => RuntimeComponent, Foundset.class => JSFoundset, JSDataSet.class => JSDataSet,
	 * boolean[] => Boolean[] and so on.
	 */
	String getType();

	Class< ? > getRealType();

	String getDescription();

	boolean isOptional();

	boolean isVarArgs();
}