Package com.ptc.windchill.esi.utl

Class ESIResponseMetaInfoMessages

java.lang.Object
com.ptc.windchill.esi.utl.ESIResponseMetaInfoMessages
public final class ESIResponseMetaInfoMessages extends Object
Provides localized messages for ESI response meta information related errors.

Supported API: true

Extendable: false

  • Method Details

    • getMessageForFileDoesNotExistError

      public static final String getMessageForFileDoesNotExistError(String filePath)
      Returns the localized version of the message, "File <path> does not exist.".

      Supported API: true
      Parameters:
      filePath - Path to the given file.
      Returns:
      String - localized verson of the error message.

    • getMessageForInvalidRootElementError

      public static final String getMessageForInvalidRootElementError(String rootElemName, String filePath)
      Returns the localized version of the message, "Invalid root element <name> encountered in file <path>."

      Supported API: true
      Parameters:
      rootElemName - Name of the root element in the given XML file.
      filePath - Path to the given XML file.
      Returns:
      String - localized version of the error message.

    • getMessageForInvalidElemNoAttrError

      public static final String getMessageForInvalidElemNoAttrError(String elemName, String attrName, String filePath)
      Returns the localized version of the message, "Invalid <element name> element encountered in file <path>. Has no attribute named <attribute name>."

      Supported API: true
      Parameters:
      elemName - Name of the element in the given XML file.
      attrName - Name of the attribute missing from the element.
      filePath - Path to the given XML file.
      Returns:
      String - localized version of the error message.

    • getMessageForInvalidElemNoContentError

      public static final String getMessageForInvalidElemNoContentError(String elemName, String filePath)
      Returns the localized version of the message, "Invalid <name> element encountered in file <path>. Has no content."

      Supported API: true
      Parameters:
      elemName - Name of the element in the given XML file.
      filePath - Path to the given XML file.
      Returns:
      String - localized version of the error message.

    • getMessageForInvalidElemBadContentError

      public static final String getMessageForInvalidElemBadContentError(String elemName, String content, String refElemName, String filePath)
      Returns the localized version of the message, "Invalid <name1> element encountered in file <path>. Has content <content> that references a non-existent <name2> element."

      Supported API: true
      Parameters:
      elemName - Name of the element in the given XML file.
      content - Content of the above said element.
      refElemName - Name of the element referenced by the above said content.
      filePath - Path to the given XML file.
      Returns:
      String - localized version of the error message.

    • getMessageForIncompleteGIError

      public static final String getMessageForIncompleteGIError(String filePath)
      Returns the localized version of the message, "File <path> does not appear to contain the required number of GroupInformation elements."

      Supported API: true
      Parameters:
      filePath - Path to the given XML file.
      Returns:
      String - localized version of the error message.

    • getMessageForMissingGIError

      public static final String getMessageForMissingGIError(String groupInfoName, String filePath)
      Returns the localized version of the message, "File <path> does not contain the required GroupInformation element <name>."

      Supported API: true
      Parameters:
      groupInfoName - Logical name of the GroupInformation element in the given XML file.
      filePath - Path to the given XML file.
      Returns:
      String - localized version of the error message.

    • getMsgForReusedLogicalNameError

      public static final String getMsgForReusedLogicalNameError(String logicalName, String filePath)
      Returns the localized version of the message, "File <path> has a group information element, whose logical name <name> is already in use."

      Supported API: true
      Parameters:
      logicalName - Logical name of a GroupInformation element in the given XML file.
      filePath - Path to the given XML file.
      Returns:
      String - localized version of the error message.

    • getMessageForReusedMapIdError

      public static final String getMessageForReusedMapIdError(String reusedId, String filePath)
      Returns the localized version of the message, "File <path> uses the value <value> for a Map element's id attribute, which is already in use."

      Supported API: true
      Parameters:
      reusedId - Value of the id attribute that is already in use.
      filePath - Path to the given XML file.
      Returns:
      String - localized version of the error message.