com.ibm.jarm.api.query

Class ReportParameter

  • java.lang.Object
    • com.ibm.jarm.api.query.ReportParameter
    • Constructor Summary

      Constructors 
      Constructor and Description
      ReportParameter(java.lang.String name, boolean isRequired)
      Constructor.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void addValues(java.lang.String id, java.lang.String value, java.lang.String localKey)
      Adds a new parameter value to this instance.
      java.lang.String getAvailValue(java.lang.String valueId)
      Returns the parameter value associated with the given identifier.
      java.util.List<java.lang.String> getAvailValueIds()
      Returns a collection of String identifiers representing key values to this parameter's value map.
      java.lang.String getAvailValueLocalizationKey(java.lang.String valueId)
      Returns a localization key for the specified parameter value.
      java.lang.String getName()
      Returns the name value for this parameter.
      boolean isRequired()
      Indicates whether or not this particular parameter is required.
      void setName(java.lang.String name)
      Sets the name value for this parameter.
      void setRequired(boolean isRequired)
      Sets whether or not this parameter is required.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ReportParameter

        public ReportParameter(java.lang.String name,
                       boolean isRequired)
        Constructor. For internal use only.
        Parameters:
        name - a String value representing the name for this parameter.
        isRequired - true if this parameter is required; false otherwise.
    • Method Detail

      • getName

        public java.lang.String getName()
        Returns the name value for this parameter.
        Returns:
        A String value.
      • setName

        public void setName(java.lang.String name)
        Sets the name value for this parameter.
        Parameters:
        name - a String value. This entry cannot be null.
      • isRequired

        public boolean isRequired()
        Indicates whether or not this particular parameter is required.
        Returns:
        true if this parameter is required; false otherwise.
      • setRequired

        public void setRequired(boolean isRequired)
        Sets whether or not this parameter is required.
        Parameters:
        isRequired - true if this parameter is required; false otherwise.
      • getAvailValueIds

        public java.util.List<java.lang.String> getAvailValueIds()
        Returns a collection of String identifiers representing key values to this parameter's value map.
        Returns:
        a List of String instances. This entry can be empty.
      • getAvailValue

        public java.lang.String getAvailValue(java.lang.String valueId)
        Returns the parameter value associated with the given identifier.
        Parameters:
        valueId - a String value identifier. This entry cannot be null.
        Returns:
        A String value. This entry can be null.
      • getAvailValueLocalizationKey

        public java.lang.String getAvailValueLocalizationKey(java.lang.String valueId)
        Returns a localization key for the specified parameter value.
        Parameters:
        valueId - a String value identifier. This entry cannot be null.
        Returns:
        A String value. This entry can be null.
      • addValues

        public void addValues(java.lang.String id,
                     java.lang.String value,
                     java.lang.String localKey)
        Adds a new parameter value to this instance.
        Parameters:
        id - a String value identifier. This entry cannot be null.
        value - a String value. This entry can be null.
        localKey - a String localization key. This entry can be null.

© Copyright IBM Corp. 2010, 2013. All Rights Reserved.