*** This interface provides Binary Compatibility only, not Source Compatibility ***

Package com.sas.services.information.metadata

Interface ConfigurationXMLTextStoreInterface

All Superinterfaces:
MetadataInterface, PublicObjectInterface, Remote, TextStoreInterface
@SASScope("ALL") @BinaryCompatibilityOnly public interface ConfigurationXMLTextStoreInterface extends TextStoreInterface
Since:
1.1

  • Field Details

    • ROLESTRING

      static final String ROLESTRING
      String to use as TextRole attribute for TextStore objects that contain configuration XML.
      See Also:

    • TYPESTRING

      static final String TYPESTRING
      String to use as TextType for TextStore objects that contain XML
      See Also:

  • Method Details

    • getEnumerationItems

      List getEnumerationItems() throws ServiceException, RemoteException
      Returns a list of EnumerationItem objects or null if the ParsedConfigurationXMLObject does not contain an Enumeration data type.
      Returns:
      A List of EnumerationItems or null.
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • getEnumerationTextLabels

      List getEnumerationTextLabels() throws ServiceException, RemoteException
      Returns a list of enumeration text labels or null if the ParsedConfigurationXMLObject does not contain an Enumeration data type.
      Returns:
      list consisting of enumeration text labels
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • getEnumerationTextLabels

      List getEnumerationTextLabels(Locale locale) throws ServiceException, RemoteException
      Returns a list of enumeration text labels or null if the ParsedConfigurationXMLObject does not contain an Enumeration data type.
      Parameters:
      locale - the locale with which the text label is associated. This parameter may be null.
      Returns:
      list consisting of enumeration text labels
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • getEnumerationValues

      List getEnumerationValues() throws ServiceException, RemoteException
      Returns a list of enumeration values or null if the ParsedConfigurationXMLObject does not contain an Enumeration data type.
      Returns:
      list consisting of enumeration values
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • setEnumerationData

      void setEnumerationData(List list) throws ServiceException, RemoteException
      Creates a list of enumeration values and adds an entry to the internal map for the Enumeration data type. This method is not intended for general use; it is called by the ConfigurationXMLPersistenceUtility.
      Parameters:
      list - list of values
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • addEnumerationItem

      void addEnumerationItem(EnumerationItem item) throws ServiceException, RemoteException
      Add an item to the enumeration data.
      Parameters:
      item - The new EnumerationItem to add to the configuration object.
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • removeEnumerationItem

      void removeEnumerationItem(EnumerationItem item) throws ServiceException, RemoteException
      Remove an item from the enumeration data.
      Parameters:
      item - The EnumerationItem to remove from the configuration.
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • getEnumerationValuesLabelsMap

      Map getEnumerationValuesLabelsMap(Locale locale) throws ServiceException, RemoteException
      Returns a map consisting of values and their corresponding labels
      Parameters:
      locale - the locale with which the text label is associated. This parameter may be null.
      Returns:
      named value pairs (value, label)
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • hasUniqueTextLabels

      boolean hasUniqueTextLabels(Locale locale) throws ServiceException, RemoteException
      Returns a boolean indicating whether the values are identical to their corresponding text labels Returns false only if each value in the enumeration is identical to its corresponding text label
      Parameters:
      locale - the locale with which the text label is associated. This parameter may be null.
      Returns:
      boolean indicating whether values and labels are identical
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • isEnumerationOthersAllowed

      boolean isEnumerationOthersAllowed() throws ServiceException, RemoteException
      Returns the value of the isOthersAllowed attribute of an Enumeration. Before invoking this method, be sure to check that the Enumeration contains an entry for isOthersAllowed by calling isEnumerationOthersAllowedSet() Otherwise, an exception could occur if:
      • the ParsedConfigurationXMLObject does not contain an Enumeration data type
      • the Enumeration data type does not contain an isOthersAllowed attribute 
         ParsedConfigurationXMLObject parsedObject = ConfigurationXMLPersistenceUtility.createParsedConfigurationXMLObject();
   boolean isAttributeSet = isEnumerationOthersAllowedSet;
   if (attributeSet){
     boolean attributeValue = isEnumerationOthersAllowed();
    }
      Returns:
      true if the Enumeration allows other values than those listed; false otherwise
      Throws:
      IllegalArgumentException - if isOthersAllowed attribute does not exist
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • isEnumerationOthersAllowedSet

      boolean isEnumerationOthersAllowedSet() throws ServiceException, RemoteException
      Returns a boolean indicating whether the ParsedConfigurationXMLObject contains an entry for the isOthersAllowed attribute of Enumeration. This method will return true if an isOthersAllowed entry exists for the Enumeration and will return false if:
      • the ParsedConfigurationXMLObject contains an Enumeration data type but the Enumeration does not have an isOthersAllowed attribute
      • the ParsedConfigurationXMLObject does not contain an Enumeration data type
      Returns:
      true if isOthersAllowed has been defined; false otherwise
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • setEnumerationOthersAllowed

      void setEnumerationOthersAllowed(boolean allowed) throws ServiceException, RemoteException
      Sets the option to allow other choices besides those specifically enumerated.
      Parameters:
      allowed - True if other options are allowed.
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • getIntegerRange

      Map getIntegerRange() throws ServiceException, RemoteException
      Returns a map containing limits for integer data or null if the ParsedConfigurationXMLObject does not contain an IntegerRange data type. The IntegerRange data type may contain either or both a minimum and maximum value. The map returned can be iterated to obtain the values or other methods can be called to obtain minimum/maximum values 
         ParsedConfigurationXMLObject parsedObject = ConfigurationXMLPersistenceUtility.createParsedConfigurationXMLObject();
   Map intValuesMap = parsedObject.getIntegerRange();
   if (intValuesMap != null){
     if (parsedObject.isIntegerRangeMinimumSet())
          int minimum = parsedObject.getIntegerRangeMinimum();
     if (parsedObject.isIntegerRangeMaximumSet())
          int maximum = parsedObject.getIntegerRangeMaximum();
     if (parsedObject.isIntegerRangeIncrementSet())
          int increment = parsedObject.getIntegerRangeIncrement();
 
    }
      Returns:
      map of integer values or null
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • getIntegerRangeIncrement

      int getIntegerRangeIncrement() throws ServiceException, RemoteException
      Returns the minimum value of the IntegerRange. Before invoking this method, be sure to check that the IntegerRange contains an entry for the minimum value by calling isIntegerRangeMinimumSet() Otherwise, an exception could occur if:
      • the ParsedConfigurationXMLObject does not contain an IntegerRange data type
      • the IntegerRange data type does not contain a minimum value 
         ParsedConfigurationXMLObject parsedObject = ConfigurationXMLPersistenceUtility.createParsedConfigurationXMLObject();
   Map intValuesMap = parsedObject.getIntegerRange();
   if (intValuesMap != null){
     if (parsedObject.isIntegerRangeMinimumSet())
          int minimum = parsedObject.getIntegerRangeMinimum();
    }
      Returns:
      minimum value
      Throws:
      IllegalArgumentException - if minimum value does not exist
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • getIntegerRangeMaximum

      int getIntegerRangeMaximum() throws ServiceException, RemoteException
      Returns the maximum value of the IntegerRange. Before invoking this method, be sure to check that the IntegerRange contains an entry for the maximum value by calling isIntegerRangeMaximumSet Otherwise, an exception could occur if:
      • the ParsedConfigurationXMLObject does not contain an IntegerRange data type
      • the IntegerRange data type does not contain a maximum value 
         ParsedConfigurationXMLObject parsedObject = ConfigurationXMLPersistenceUtility.createParsedConfigurationXMLObject();
   Map intValuesMap = parsedObject.getIntegerRange();
   if (intValuesMap != null){
     if (parsedObject.isIntegerRangeMaximumSet())
          int maximum = parsedObject.getIntegerRangeMaximum();
    }
      Returns:
      maximum value
      Throws:
      IllegalArgumentException - if maximum value does not exist
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • getIntegerRangeMinimum

      int getIntegerRangeMinimum() throws ServiceException, RemoteException
      Returns the minimum value of the IntegerRange. Before invoking this method, be sure to check that the IntegerRange contains an entry for the minimum value by calling isIntegerRangeMinimumSet() Otherwise, an exception could occur if:
      • the ParsedConfigurationXMLObject does not contain an IntegerRange data type
      • the IntegerRange data type does not contain a minimum value 
         ParsedConfigurationXMLObject parsedObject = ConfigurationXMLPersistenceUtility.createParsedConfigurationXMLObject();
   Map intValuesMap = parsedObject.getIntegerRange();
   if (intValuesMap != null){
     if (parsedObject.isIntegerRangeMinimumSet())
          int minimum = parsedObject.getIntegerRangeMinimum();
    }
      Returns:
      minimum value
      Throws:
      IllegalArgumentException - if minimum value does not exist
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • isIntegerRangeIncrementSet

      boolean isIntegerRangeIncrementSet() throws ServiceException, RemoteException
      Returns a boolean indicating whether the ParsedConfigurationXMLObject contains an entry for an increment of the IntegerRange. This method will return true if an increment entry exists for the IntegerRange and will return false if:
      • the ParsedConfigurationXMLObject contains an IntegerRange data type but the IntegerRange does not have an increment value
      • the ParsedConfigurationXMLObject does not contain an IntegerRange data type
      Returns:
      true if an increment has been defined; false otherwise
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • isIntegerRangeMaximumSet

      boolean isIntegerRangeMaximumSet() throws ServiceException, RemoteException
      Returns a boolean indicating whether the ParsedConfigurationXMLObject contains an entry for an increment of the IntegerRange. This method will return true if an increment entry exists for the IntegerRange and will return false if:
      • the ParsedConfigurationXMLObject contains an IntegerRange data type but the IntegerRange does not have an increment value
      • the ParsedConfigurationXMLObject does not contain an IntegerRange data type
      Returns:
      true if an increment has been defined; false otherwise
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • isIntegerRangeMinimumSet

      boolean isIntegerRangeMinimumSet() throws ServiceException, RemoteException
      Returns a boolean indicating whether the ParsedConfigurationXMLObject contains an entry for a minimum value of the IntegerRange. This method will return true if a minimum value entry exists for the IntegerRange and will return false if:
      • the ParsedConfigurationXMLObject contains an IntegerRange data type but the IntegerRange does not have a minimum value
      • the ParsedConfigurationXMLObject does not contain an IntegerRange data type
      Returns:
      true if minimum value has been defined; false otherwise
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • removeIntegerRange

      void removeIntegerRange() throws ServiceException, RemoteException
      Remove the Integer range setting from the configuration.
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • setIntegerRange

      void setIntegerRange(int minimum, int maximum) throws ServiceException, RemoteException
      Set the integer range setting for the configuration.
      Parameters:
      minimum - The minimum setting for the integer range.
      maximum - The maximum setting for the integer range.
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • setIntegerRangeMinimum

      void setIntegerRangeMinimum(int minimum) throws ServiceException, RemoteException
      Set the integer range minimum for this configuration.
      Parameters:
      minimum - The new minimum for the configuration.
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • setIntegerRangeMaximum

      void setIntegerRangeMaximum(int maximum) throws ServiceException, RemoteException
      Set the integer range maximum for this configuration.
      Parameters:
      maximum - The new maximum for this configuration.
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • setIntegerRangeIncrement

      void setIntegerRangeIncrement(int increment) throws ServiceException, RemoteException
      Set the integer range increment.
      Parameters:
      increment - The increment for the integer range for this configuration.
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • setIntegerRange

      void setIntegerRange(Map map) throws ServiceException, RemoteException
      Creates a map of integer values and adds an entry to the internal map for the IntegerRange data type. This method is not intended for general use; it is called by the ConfigurationXMLPersistenceUtility.
      Parameters:
      map - key-value pairs (minimum/maximum/increment, integer value).
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • getNumericRange

      Map getNumericRange() throws ServiceException, RemoteException
      Returns a map containg limits for numeric data or null if the ParsedConfigurationXMLObject does not contain a NumericRange data type. The NumericRange data type may contain either or both a minimum and maximum value. The map returned can be iterated to obtain the values or other methods can be called to obtain minimum/ maximum values 
         ParsedConfigurationXMLObject parsedObject = ConfigurationXMLPersistenceUtility.createParsedConfigurationXMLObject();
   Map numericValuesMap = parsedObject.getNumericRange();
   if (numericValuesMap != null){
     if (parsedObject.isNumericRangeMinimumSet())
          int minimum = parsedObject.getNumericRangeMinimum();
     if (parsedObject.isNumericRangeMaximumSet())
          int maximum = parsedObject.getNumericRangeMaximum();
    }
      Returns:
      map of numeric values or null.
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • getNumericRangeIncrement

      Number getNumericRangeIncrement() throws ServiceException, RemoteException
      Returns the increment of the NumericRange. Before invoking this method, be sure to check that the NumericRange contains an entry for the increment by calling isNumericRangeIncrementSet() Otherwise, an exception could occur if:
      • the ParsedConfigurationXMLObject does not contain a NumericRange data type
      • the NumericRange data type does not contain an increment value 
         ParsedConfigurationXMLObject parsedObject = ConfigurationXMLPersistenceUtility.createParsedConfigurationXMLObject();
   Map numericValuesMap = parsedObject.getNumericRange();
   if (numericValuesMap != null){
     if (parsedObject.isNumericRangeIncrementSet())
          double maximum = parsedObject.getNumericRangeIncrement();
    }
      Returns:
      numeric range increment value.
      Throws:
      IllegalArgumentException - if maximum value does not exist
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • getNumericRangeMaximum

      Number getNumericRangeMaximum() throws ServiceException, RemoteException
      Returns the maximum value of the NumericRange. Before invoking this method, be sure to check that the NumericRange contains an entry for the maximum value by calling isNumericRangeMaximumSet() Otherwise, an exception could occur if:
      • the ParsedConfigurationXMLObject does not contain a NumericRange data type
      • the NumericRange data type does not contain a maximum value 
         ParsedConfigurationXMLObject parsedObject = ConfigurationXMLPersistenceUtility.createParsedConfigurationXMLObject();
   Map intValuesMap = parsedObject.getNumericRange();
   if (intValuesMap != null){
     if (parsedObject.isNumericRangeMaximumSet())
          int maximum = parsedObject.getNumericRangeMaximum();
    }
      Returns:
      The maximum value in the allowable numeric range.
      Throws:
      IllegalArgumentException - if maximum value does not exist.
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • getNumericRangeMinimum

      Number getNumericRangeMinimum() throws ServiceException, RemoteException
      Returns the minimum value of the NumericRange. Before invoking this method, be sure to check that the NumericRange contains an entry for the minimum value by calling isNumericRangeMinimumSet() Otherwise, an exception could occur if:
      • the ParsedConfigurationXMLObject does not contain a NumericRange data type
      • the NumericRange data type does not contain a minimum value 
         ParsedConfigurationXMLObject parsedObject = ConfigurationXMLPersistenceUtility.createParsedConfigurationXMLObject();
   Map intValuesMap = parsedObject.getNumericRange();
   if (intValuesMap != null){
     if (isNumericRangeMinimumSet())
          int minimum = parsedObject.getNumericRangeMinimum();
    }
      Returns:
      minimum value.
      Throws:
      IllegalArgumentException - if minimum value does not exist
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • isNumericRangeIncrementSet

      boolean isNumericRangeIncrementSet() throws ServiceException, RemoteException
      Returns a boolean indicating whether the ParsedConfigurationXMLObject contains an entry for an increment of the NumericRange. This method will return true if an increment entry exists for the NumericRange and will return false if:
      • the ParsedConfigurationXMLObject contains a NumericRange data type but the NumericRange does not have an increment value
      • the ParsedConfigurationXMLObject does not contain a NumericRange data type
      Returns:
      true if increment value has been defined; false otherwise.
      Throws:
      ServiceException - If a repository or service level error occurs.
      RemoteException - In the event of remote object failure.

    • isNumericRangeMaximumExclusive

      boolean isNumericRangeMaximumExclusive() throws ServiceException, RemoteException
      Returns a boolean indicating whether the maximum value of the NumericRange is exclusive (the value should not be contained within the range of acceptable values). This method will return true if the maximum value is exclusive and false otherwise. Before invoking this method, be sure to check that the NumericRange contains an entry for the maximum value by calling isNumericRangeMaximumSet() Otherwise, an exception could occur if:
    • the ParsedConfigurationXMLObject contains a NumericRange data type but the NumericRange does not have a maximum value
    • the ParsedConfigurationXMLObject does not contain a NumericRange data type
    ParsedConfigurationXMLObject parsedObject = ConfigurationXMLPersistenceUtility.createParsedConfigurationXMLObject(); Map numericValuesMap = parsedObject.getNumericRange(); if (numericValuesMap != null){ if (parsedObject.isNumericRangeMaximumSet()) double maximum = parsedObject.getNumericRangeMaximum(); if (parsedObject.isNumericRangeMaximumExclusive()) ... exclude the value }