de.tif.jacob.entrypoint
Class ICmdEntryPoint.PropertyDefinition

java.lang.Object
  de.tif.jacob.entrypoint.ICmdEntryPoint.PropertyDefinition

Enclosing interface:

ICmdEntryPoint

public static class ICmdEntryPoint.PropertyDefinition
extends java.lang.Object

Constructor Summary

ICmdEntryPoint.PropertyDefinition(java.lang.String name, boolean required, java.lang.String description)

Method Summary

java.lang.String	getDescription() Returns the description or meaning of the parameter for the entrypoint.
java.lang.String	getName() Returns the name (key) of this entry point parameter.
boolean	isRequired() Return true if the parameter required for this entry point.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ICmdEntryPoint.PropertyDefinition

public ICmdEntryPoint.PropertyDefinition(java.lang.String name,
                                         boolean required,
                                         java.lang.String description)

Method Detail

getDescription

public final java.lang.String getDescription()

Returns the description or meaning of the parameter for the entrypoint. This will be used in the administration UI to present a information dialog about all available entry points to the system.

Returns:

Returns the description / meaning of the property.

getName

public final java.lang.String getName()

Returns the name (key) of this entry point parameter.

Returns:

Returns the name of the entry point parameter.

isRequired

public final boolean isRequired()

Return true if the parameter required for this entry point.

Returns:

Returns true if the parameter required for this entry point.