com.dtolabs.rundeck.core.plugins.configuration
Interface Property

public interface Property

Property describes a configuration property of a provider

Nested Class Summary

static class

Property.Type Available property types

Method Summary

java.lang.String	getDefaultValue() Return the default value of the property, or default select value to select
java.lang.String	getDescription() Return description of the values of the property
java.lang.String	getName() Return property key to use
java.util.Map<java.lang.String,java.lang.Object>	getRenderingOptions() Returns a map of optional rendering options for the UI
PropertyScope	getScope() Return the scope of this property, i.e.
java.util.List<java.lang.String>	getSelectValues() Return a list of values for a select property
java.lang.String	getTitle() Return descriptive name of the property
Property.Type	getType() Return the property type
PropertyValidator	getValidator() Return the validator for this property
boolean	isRequired() Return true if an empty value is not allowed

Method Detail

getTitle

java.lang.String getTitle()

Return descriptive name of the property

getName

java.lang.String getName()

Return property key to use

getDescription

java.lang.String getDescription()

Return description of the values of the property

getType

Property.Type getType()

Return the property type

getValidator

PropertyValidator getValidator()

Return the validator for this property

isRequired

boolean isRequired()

Return true if an empty value is not allowed

getDefaultValue

java.lang.String getDefaultValue()

Return the default value of the property, or default select value to select

getSelectValues

java.util.List<java.lang.String> getSelectValues()

Return a list of values for a select property

getScope

PropertyScope getScope()

Return the scope of this property, i.e. where the value can be retrieved and overridden, or null to indicate the default scope.

getRenderingOptions

java.util.Map<java.lang.String,java.lang.Object> getRenderingOptions()

Returns a map of optional rendering options for the UI