Package com.ptc.windchill.esi.utl

Class ESIMessages

java.lang.Object
com.ptc.windchill.esi.utl.ESIMessages
public final class ESIMessages extends Object
Provides consistent localized messages for all ESI classes.

Supported API: true

Extendable: false

  • Method Details

    • getBOMUnchangedError

      public static final String getBOMUnchangedError()
      Returns the localized version of the message, "The selected Bill of Materials has not changed since it was last successfully published.".

      Supported API: true
      Returns:
      String

    • getChangeActivityDescription

      public static final String getChangeActivityDescription()
      Returns localized version of "ESI generated change activity".

      Supported API: true
      Returns:
      String

    • getChangeActivityName

      public static final String getChangeActivityName()
      Returns localized version of "ESI generated change activity".

      Supported API: true
      Returns:
      String

    • getChangeOrderDescription

      public static final String getChangeOrderDescription()
      Returns localized version of "ESI generated change order".

      Supported API: true
      Returns:
      String

    • getChangeOrderName

      public static final String getChangeOrderName()
      Returns localized version of "ESI generated change order".

      Supported API: true
      Returns:
      String

    • getChangeRequestDescription

      public static final String getChangeRequestDescription()
      Returns localized version of "ESI generated change request".

      Supported API: true
      Returns:
      String

    • getChangeRequestName

      public static final String getChangeRequestName()
      Returns localized version of "ESI generated change request".

      Supported API: true
      Returns:
      String

    • getDeleteActiveTransactionError

      public static final String getDeleteActiveTransactionError()
      Returns localized version of "The transaction cannot be deleted because it still active".

      Supported API: true
      Returns:
      String

    • getDeletePartWithHistoryError

      public static final String getDeletePartWithHistoryError()
      Returns localized version of "The ESI target cannot be deleted because it has associated ESI release activity entries".

      Supported API: true
      Returns:
      String

    • getDeletePartWithTransactionError

      public static final String getDeletePartWithTransactionError()
      Returns localized version of "The part cannot be deleted because it has associated ESI transaction entries".

      Supported API: true
      Returns:
      String

    • getDeleteTargetWithAssignmentsError

      public static final String getDeleteTargetWithAssignmentsError()
      Returns localized version of "The ESI target cannot be deleted because it has been assigned as a destination".

      Supported API: true
      Returns:
      String

    • getDeleteTargetWithHistoryError

      public static final String getDeleteTargetWithHistoryError()
      Returns localized version of "The ESI target cannot be deleted because it has associated release activity entries".

      Supported API: true
      Returns:
      String

    • getDeleteTargetWithOrganizationsError

      public static final String getDeleteTargetWithOrganizationsError()
      Returns localized version of "The ESI target cannot be deleted because it has associated WTOrganization entries".

      Supported API: true
      Returns:
      String

    • getInconsistentClasses

      public static final String getInconsistentClasses()
      Returns localized version of "The argument collection contained multiple classes".

      Supported API: true
      Returns:
      String

    • getInconsistentTransactionError

      public static final String getInconsistentTransactionError()
      Returns localized version of "An ESI Virtual Database Builder has been given inconsistent transaction numbers".

      Supported API: true
      Returns:
      String

    • getInvalidActionError

      public static final String getInvalidActionError()
      Returns localized version of "Action must be ADD, CHANGE, or DELETE". The action codes in upper case are not localizable.

      Supported API: true
      Returns:
      String

    • getInvalidBooleanArgumentError

      public static final String getInvalidBooleanArgumentError()
      Returns localized version of "The argument was neither 'true' nor 'false' ".

      Supported API: true
      Returns:
      String

    • getInvalidChangeableError

      public static final String getInvalidChangeableError()
      Returns localized version of "The Change Object has an invalid changeable".

      Supported API: true
      Returns:
      String

    • getInvalidUfidError

      public static final String getInvalidUfidError(String ufid)
      Returns localized version of "The argument '<argument>' is not a valid Unique Federation Identifier".

      Supported API: true
      Parameters:
      ufid -
      Returns:
      String

    • getInvalidUserError

      public static final String getInvalidUserError(String user)
      Returns localized version of "The argument '<argument>' is not a properly formatted user".

      Supported API: true
      Parameters:
      user -
      Returns:
      String

    • getMissingArgumentError

      public static final String getMissingArgumentError()
      Returns localized version of "Missing argument".

      Supported API: true
      Returns:
      String

    • getMissingComponentQuantityError

      public static final String getMissingComponentQuantityError()
      Returns localized version of "You may not publish components when the quantity is 0"

      Supported API: true
      Returns:
      String

    • getMissingFileError

      public static final String getMissingFileError()
      Returns localized version of "Could not find file".

      Supported API: true
      Returns:
      String

    • getMissingOrgAssignmentError

      public static final String getMissingOrgAssignmentError()
      Returns localized version of "No target assignment for object".

      Supported API: true
      Returns:
      String

    • getMissingOrgError

      public static final String getMissingOrgError()
      Returns localized version of "Could not find ESI target".

      Supported API: true
      Returns:
      String

    • getMissingParameter

      public static final String getMissingParameter(String paramName)
      Returns localized version of "The following required parameter is missing: " with the argument appended.

      Supported API: true
      Parameters:
      paramName -
      Returns:
      String

    • getMissingTransactionError

      public static final String getMissingTransactionError(String txnID)
      Returns localized version of "The ESI transaction '<argument>' did not exist in the database".

      Supported API: true
      Parameters:
      txnID -
      Returns:
      String

    • getNoESIMessageLog

      public static final String getNoESIMessageLog()
      Returns localized version of "There is no log message".

      Supported API: true
      Returns:
      String

    • getNoLineNumberError

      public static final String getNoLineNumberError(WTPart part)
      Return localized version of "At least one component of '<argument>' does not have a line number."

      Supported API: true
      Parameters:
      part -
      Returns:
      String

    • getNoRpcResponseError

      public static final String getNoRpcResponseError()
      Returns localized version of "An ESI Remote Procedure Call request returned no result".

      Supported API: true
      Returns:
      String

    • getPartUnchangedError

      public static final String getPartUnchangedError()
      Returns the localized version of the message, "The selected part has not changed since it was last successfully published".

      Supported API: true
      Returns:
      String

    • getPendingMessage

      public static final String getPendingMessage()
      Returns localized version of "pending".

      Supported API: true
      Returns:
      String

    • getPendingTransactionError

      public static final String getPendingTransactionError()
      Returns localized version of "The object cannot be published because another publishing request is already active".

      Supported API: true
      Returns:
      String

    • getPropertiesError

      public static final String getPropertiesError()
      Returns the result of getMissingFileError().

      Supported API: true
      Returns:
      String

    • getSuccessFailureMsg

      public static final String getSuccessFailureMsg(String success)
      If the argument is "true" (case-insensitive) return localized version of "success"; otherwise return localized value of "failure".

      Supported API: true
      Parameters:
      success -
      Returns:
      String

    • getTargetAlreadyExistsError

      public static final String getTargetAlreadyExistsError()
      Returns localized version of "No database action was required".

      Supported API: true
      Returns:
      String

    • getTargetAlreadyExistsError

      public static final String getTargetAlreadyExistsError(String targetNames)
      Returns localized version of "Distribution target targetNames already assigned".

      Supported API: true
      Parameters:
      targetNames - The target names to be passed into the localized message.
      Returns:
      String

    • getTransactionNumberFormatError

      public static final String getTransactionNumberFormatError()
      Return localized version of "Transaction number is in number format only."

      Supported API: true
      Returns:
      String

    • getTargetIsPublishedError

      public static final String getTargetIsPublishedError(String targetName)
      Return localized version of "You may not remove a distribution target assignment once an object has been published"

      Supported API: true
      Parameters:
      targetName -
      Returns:
      String

    • getUnsupportedLocaleError

      public static final String getUnsupportedLocaleError(Locale locale)
      Return localized version of "Locale: '<argument>' is not a supported locale"

      Supported API: true
      Parameters:
      locale - The unsupported locale
      Returns:
      String

    • getWarningMessagesError

      public static final String getWarningMessagesError()
      Get localized version of "The transaction had one or more warning messages".

      Supported API: true
      Returns:
      String

    • getMessageForReleaseWarnings

      public static final String getMessageForReleaseWarnings()
      Returns the localized version of the message, "One or more warning messages were received while processing the release".

      Supported API: true
      Returns:
      String

    • getProcessPlanUnchangedError

      public static final String getProcessPlanUnchangedError()
      Returns localized version of "The selected Process Plan has not changed since the last successful release by ESI".

      Supported API: true
      Returns:
      String

    • getNoMatchingVersionFoundError

      public static final String getNoMatchingVersionFoundError(String identity)
      Returns the localized version of "No qualifying version found for the master <identity>, either because the user does not have the necessary privileges to access the version or there is no version defined that matches the configuration specification."

      Supported API: true
      Returns:
      String

    • getMessageForPreprocessingError

      public static final String getMessageForPreprocessingError()
      Returns the localized version of the message, "An error occurred while creating transactions for targets. See the error logs for more information.".

      Supported API: true
      Returns:
      String

    • getMessageForResponseGenError

      public static final String getMessageForResponseGenError()
      Returns the localized version of the message, "An error occurred while generating the ESI response. See the error logs for more information.".

      Supported API: true
      Returns:
      String

    • getMessageForResponseSenderError

      public static final String getMessageForResponseSenderError(String distributionTargetNumber)
      Returns the localized version of the message, "An error occurred while sending the ESI response to the distribution target "<argument>". See the error logs for more information.".

      Supported API: true
      Parameters:
      distributionTargetNumber - - Number of the distribution target to be used in the output error message.
      Returns:
      Localized version of the error message.

    • getMessageForMultipleTgtsInTxnError

      public static final String getMessageForMultipleTgtsInTxnError(String txnId)
      Returns the localized version of the message, "There are multiple distribution targets associated to a transaction with the ID: <ID>".

      Supported API: true
      Parameters:
      txnId - ID of the given transaction.
      Returns:
      String - localized verson of the error message.

    • getESIReleaseFailureMsg

      public static final String getESIReleaseFailureMsg()
      Returns the localized version of the message, "Resubmit the ESI failure after making corrections to your system, as appropriate."

      Supported API: true
      Returns:
      String - localized verson of the message.

    • getHeadingForExceptionMsg

      public static final String getHeadingForExceptionMsg()
      Returns the localized version of the message, "Message associated with the exception caused by the error:"

      Supported API: true
      Returns:
      String - localized verson of the message.

    • getReleaseUpdateMessage

      public static final String getReleaseUpdateMessage()
      Returns the localized version of the message, "The release status has been updated by the administrator."

      Supported API: true
      Returns:
      String - localized verson of the message.

    • getCADStructureUnchangedError

      public static final String getCADStructureUnchangedError(String identity)
      Returns the localized version of the message, "The selected CAD document <identity> has not changed since it was last successfully published.".

      Supported API: true
      Parameters:
      identity - A string that is representative of the CAD document for which to return the message.
      Returns:
      String

    • getObjectUnchangedError

      public static final String getObjectUnchangedError(String identity)
      Returns the localized version of the message, "The selected object <identity> has not changed since it was last successfully published."

      Supported API: true
      Parameters:
      identity - A string that is representative of the object for which to return the message.
      Returns:
      String

    • getMissingTargetAssignmentError

      public static final String getMissingTargetAssignmentError(String identity)
      Returns localized version of "The object being published does not have distribution targets assigned to it.".

      Supported API: true
      Parameters:
      identity - - Display identity of the object for which this message need to be displayed.
      Returns:
      Localized version of the message "The object being published does not have distribution targets assigned to it.". Returned message will have the object identity embedded in it.

    • getCheckLinkHistoryWarning

      public static final String getCheckLinkHistoryWarning(Class linkClass)
      Returns the localized version of the message, "Cannot update the release status for the unchanged link of type <type>, as no release history is available for such links."

      Supported API: true
      Parameters:
      linkClass - - Class instance for the object for which to return the message.
      Returns:
      Localized version of the message, "Cannot update the release status for the unchanged link of type <type>, as no release history is available for such links."

    • getMissingTargetAssignmentsError

      public static final String getMissingTargetAssignmentsError(String identity)
      Returns localized version of "The following objects being published does not have distribution targets assigned to it.".

      Supported API: true
      Parameters:
      identity - - Display identity of the object for which this message need to be displayed.
      Returns:
      Localized version of the message "The following objects being published does not have distribution targets assigned to it.". Returned message will have the object identity embedded in it.

    • getPublishObjectNonReleasableError

      public static final String getPublishObjectNonReleasableError(DisplayIdentity identity)
      Returns localized version of
      Publication of {1} is not supported, since its class does not implement the interface "Releasable".

      Supported API: true
      Parameters:
      identity - - Display identity of the object for which this message need to be displayed.
      Returns:
      Localized version of the message Publication of {1} is not supported, since its class does not implement the interface "Releasable". Returned message will have the localized object identity embedded in it.

    • getPublishObjectUserNotFoundWarning

      public static final String getPublishObjectUserNotFoundWarning(DisplayIdentity identity)
      Returns localized version of
      Unable to find user hence using administrator to initiate publication for \"{0}\" .

      Supported API: true
      Parameters:
      identity - - Display identity of the object for which this message need to be displayed.
      Returns:
      Localized version of the message Unable to find user hence using administrator to initiate publication for \"{0}\". Returned message will have the localized object identity embedded in it.

    • getNoFolderPermissionError

      public static final String getNoFolderPermissionError()
      Returns the localized version of the message, "User does not have necessary permissions to write in the folder specified by 'Folder where baselines will be created' preference."

      Supported API: true
      Returns:
      String

    • getNoDefaultFolderPermissionError

      public static final String getNoDefaultFolderPermissionError()
      Returns the localized version of the message, "User does not have necessary permissions to write in the default folder location in organization context."

      Supported API: true
      Returns:
      String

    • getNoCreateBaselinePermissionError

      public static final String getNoCreateBaselinePermissionError()
      Returns the localized version of the message, "User does not have necessary permissions to create baselines."

      Supported API: true
      Returns:
      String

    • getNoChangeablesIncorrectUserConfigurationError

      public static final String getNoChangeablesIncorrectUserConfigurationError(String objectIdentifier)
      Returns the localized version of the message, "No changeables were found for the Change Notice <identifier>, possibly owing to an inappropriately configured publishing user. See the MethodServer logs for more information."

      Supported API: true
      Parameters:
      objectIdentifier - - Identifier of the Change Notice for which to fetch the output message.
      Returns:
      Localized version of the output message, if it was fetched successfully; otherwise, the English message.

    • getPartResourceValidatonErrorForBOM

      public static final String getPartResourceValidatonErrorForBOM()
      Returns the localized version of the message, "User does not have necessary permissions to write in the default folder location in organization context."

      Supported API: true
      Returns:
      String