Package edu.internet2.middleware.grouper.cfg.dbConfig

Class ConfigItemMetadata

java.lang.Object
edu.internet2.middleware.grouper.cfg.dbConfig.ConfigItemMetadata
public class ConfigItemMetadata extends Object

  • Constructor Details

    • ConfigItemMetadata

      public ConfigItemMetadata()

  • Method Details

    • getKeyOrSampleKey

      public String getKeyOrSampleKey()
      Returns:
      key or sample key

    • isSampleProperty

      public boolean isSampleProperty()
      if sample property
      Returns:
      key or sample key

    • getSampleKey

      public String getSampleKey()
      if commented out property, this is the sample key
      Returns:
      the sample key

    • setSampleKey

      public void setSampleKey(String sampleKey)
      if commented out property, this is the sample key
      Parameters:
      sampleKey -

    • getSampleValue

      public String getSampleValue()
      an example value for the property
      Returns:
      the sampleValue

    • setSampleValue

      public void setSampleValue(String sampleValue1)
      an example value for the property
      Parameters:
      sampleValue1 - the sampleValue to set

    • isRequiresRestart

      public boolean isRequiresRestart()
      if changing this property requires restart of grouper
      Returns:
      the requiresRestart

    • setRequiresRestart

      public void setRequiresRestart(boolean requiresRestart1)
      if changing this property requires restart of grouper
      Parameters:
      requiresRestart1 - the requiresRestart to set

    • getMetadataProcessedSuccessfully

      public Boolean getMetadataProcessedSuccessfully()
      if the metadata json was processed successfully
      Returns:
      the metadataProcessedSuccessfully

    • setMetadataProcessedSuccessfully

      public void setMetadataProcessedSuccessfully(Boolean metadataProcessedSuccessfully1)
      if the metadata json was processed successfully
      Parameters:
      metadataProcessedSuccessfully1 - the metadataProcessedSuccessfully to set

    • getMetadataError

      public String getMetadataError()
      if metadata json was converted to json successfully and valid
      Returns:
      the metadataError

    • setMetadataError

      public void setMetadataError(String metadataError1)
      if metadata json was converted to json successfully and valid
      Parameters:
      metadataError1 - the metadataError to set

    • getRepeatGroup

      public String getRepeatGroup()
      common label of repeated configs that should be in a repeated block
      Returns:

    • setRepeatGroup

      public void setRepeatGroup(String repeatGroup)
      common label of repeated configs that should be in a repeated block
      Parameters:
      repeatGroup -

    • getRepeatCount

      public int getRepeatCount()
      how many times a property should be repeated
      Returns:

    • setRepeatCount

      public void setRepeatCount(int repeatCount)
      how many times a property should be repeated
      Parameters:
      repeatCount -

    • getRepeatGroupIndex

      public int getRepeatGroupIndex()

    • setRepeatGroupIndex

      public void setRepeatGroupIndex(int repeatGroupIndex)

    • getOrder

      public int getOrder()
      Returns:
      used for ordering elements

    • setOrder

      public void setOrder(int order)
      used for ordering elements
      Parameters:
      order -

    • getSubSection

      public String getSubSection()
      put a label to group items together. if blank then all in default subsection
      Returns:

    • setSubSection

      public void setSubSection(String section)
      put a label to group items together. if blank then all in default subsection
      Parameters:
      section -

    • getRawMetadataJson

      public String getRawMetadataJson()
      raw json string in the properties file
      Returns:
      the rawMetadataJson

    • setRawMetadataJson

      public void setRawMetadataJson(String rawMetadataJson1)
      raw json string in the properties file
      Parameters:
      rawMetadataJson1 - the rawMetadataJson to set

    • getShowEl

      public String getShowEl()
      if this is set, put in an expression language that can depend on other attribute suffixes to see if an item is shown or not
      Returns:

    • setShowEl

      public void setShowEl(String showEl)
      if this is set, put in an expression language that can depend on other attribute suffixes to see if an item is shown or not
      Parameters:
      showEl -

    • getRequiredEl

      public String getRequiredEl()
      if this is set, put in an expression language that can depend on other attribute suffixes to see if an item is required or not
      Returns:

    • setRequiredEl

      public void setRequiredEl(String requiredEl)
      if this is set, put in an expression language that can depend on other attribute suffixes to see if an item is required or not
      Parameters:
      requiredEl -

    • getIndent

      public int getIndent()
      number of levels to indent in hide/show
      Returns:

    • setIndent

      public void setIndent(int indent)
      number of levels to indent in hide/show
      Parameters:
      indent -

    • clone

      public ConfigItemMetadata clone(int repeatIndex)
      replace $i$ with repeat index
      Parameters:
      repeatIndex -
      Returns:

    • processMetadata

      public void processMetadata()

    • getValue

      public String getValue()
      value in config file
      Returns:
      the value

    • setValue

      public void setValue(String value1)
      value in config file
      Parameters:
      value1 - the value to set

    • isRequired

      public boolean isRequired()
      if this is a required field
      Returns:
      the required

    • setRequired

      public void setRequired(boolean required1)
      if this is a required field
      Parameters:
      required1 - the required to set

    • getOptionValues

      public String[] getOptionValues()
      if this is a drop down, these are the acceptable values
      Returns:
      option values

    • setOptionValues

      public void setOptionValues(String[] optionValues)
      if this is a drop down, these are the acceptable values
      Parameters:
      optionValues -

    • getFormElement

      public ConfigItemFormElement getFormElement()
      must be in ConfigItemFormElement enum
      Returns:
      config item form element

    • setFormElement

      public void setFormElement(ConfigItemFormElement formElement1)
      must be in ConfigItemFormElement enum
      Parameters:
      formElement1 -

    • getValueType

      public ConfigItemMetadataType getValueType()
      value type, e.g. boolean, string, group, subject, integer, floating, etc
      Returns:
      the valueType

    • setValueType

      public void setValueType(ConfigItemMetadataType valueType1)
      value type, e.g. boolean, string, group, subject, integer, floating, etc
      Parameters:
      valueType1 - the valueType to set

    • getRegex

      public String getRegex()
      if this can be a list of values, this is the regex
      Returns:
      the regex

    • setRegex

      public void setRegex(String regex1)
      if this can be a list of values, this is the regex
      Parameters:
      regex1 - the regex to set

    • isMultiple

      public boolean isMultiple()
      if multiple values are allowed (e.g. comma separated)
      Returns:
      the multiple

    • setMultiple

      public void setMultiple(boolean multiple1)
      if multiple values are allowed (e.g. comma separated)
      Parameters:
      multiple1 - the multiple to set

    • isSensitive

      public boolean isSensitive()
      if this is a password or other private field that probably shouldnt be displayed especially if the password or encrypted password is listed in the value
      Returns:
      the sensitive

    • setSensitive

      public void setSensitive(boolean sensitive1)
      if this is a password or other private field that probably shouldnt be displayed especially if the password or encrypted password is listed in the value
      Parameters:
      sensitive1 - the sensitive to set

    • getKey

      public String getKey()
      key to this value (optional)
      Returns:
      the key

    • setKey

      public void setKey(String key1)
      key to this value (optional)
      Parameters:
      key1 - the key to set

    • getDefaultValue

      public String getDefaultValue()
      default value
      Returns:
      the defaultValue

    • setDefaultValue

      public void setDefaultValue(String defaultValue)
      default value
      Parameters:
      defaultValue - the defaultValue to set

    • getComment

      public String getComment()
      comments in the file about this item
      Returns:
      the comment

    • setComment

      public void setComment(String comment1)
      comments in the file about this item
      Parameters:
      comment1 - the comment to set

    • getDefaultValueEl

      public String getDefaultValueEl()
      default value EL expression
      Returns:

    • setDefaultValueEl

      public void setDefaultValueEl(String defaultValueEl)
      default value EL expression
      Parameters:
      defaultValueEl -

    • getMustExtendClass

      public String getMustExtendClass()
      fully qualified classname that this value which is a class must extend
      Returns:
      the mustExtendClass

    • setMustExtendClass

      public void setMustExtendClass(String mustExtendClass1)
      fully qualified classname that this value which is a class must extend
      Parameters:
      mustExtendClass1 - the mustExtendClass to set

    • getMustImplementInterface

      public String getMustImplementInterface()
      fully qualified interface that this value which is a class must implement
      Returns:
      the mustImplementInterface

    • setMustImplementInterface

      public void setMustImplementInterface(String mustImplementInterface1)
      fully qualified interface that this value which is a class must implement
      Parameters:
      mustImplementInterface1 - the mustImplementInterface to set

    • isReadOnly

      public boolean isReadOnly()
      is this property read only?
      Returns:

    • setReadOnly

      public void setReadOnly(boolean readOnly)
      is this property read only
      Parameters:
      readOnly -

    • isSaveToDb

      public boolean isSaveToDb()
      should this propery be saved to database?
      Returns:

    • setSaveToDb

      public void setSaveToDb(boolean saveToDb)
      should this propery be saved to database?
      Parameters:
      readOnly -

    • getOptionValuesFromClass

      public String getOptionValuesFromClass()
      Returns:
      option values from class for dropdowns

    • setOptionValuesFromClass

      public void setOptionValuesFromClass(String optionValuesFromClass)
      option values from class for dropdowns
      Parameters:
      optionValuesFromClass -

    • getCheckboxValuesFromClass

      public String getCheckboxValuesFromClass()
      checkbox values, labels, and checked for checkboxes
      Returns:

    • setCheckboxValuesFromClass

      public void setCheckboxValuesFromClass(String checkboxValuesFromClass)
      checkbox values, labels, and checked for checkboxes
      Parameters:
      checkboxValuesFromClass -