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

Field Summary

static String	ALL
private static String	CLASSNAME
private static String	ESI_RESOURCE
static String	NONE
private static String	RESOURCE
static String	SOME

Constructor Summary

ESIMessages()

Method Summary

static String	getAssignmentScopeMessage(String msg) Returns the assignment scope message.
static String	getBOMUnchangedError() Returns localized version of "The selected BOM has not changed since the last successful release by ESI".
static String	getChangeActivityDescription() Returns localized version of "ESI generated change activity".
static String	getChangeActivityName() Returns localized version of "ESI generated change activity".
static String	getChangeOrderDescription() Returns localized version of "ESI generated change order".
static String	getChangeOrderName() Returns localized version of "ESI generated change order".
static String	getChangeRequestDescription() Returns localized version of "ESI generated change request".
static String	getChangeRequestName() Returns localized version of "ESI generated change request".
static String	getDeleteActiveTransactionError() Returns localized version of "The transaction cannot be deleted because it still active".
static String	getDeletePartWithHistoryError() Returns localized version of "The ESI target cannot be deleted because it has associated ESI release activity entries".
static String	getDeletePartWithTransactionError() Returns localized version of "The part cannot be deleted because it has associated ESI transaction entries".
static String	getDeleteTargetWithAssignmentsError() Returns localized version of "The ESI target cannot be deleted because it has been assigned as a destination".
static String	getDeleteTargetWithHistoryError() Returns localized version of "The ESI target cannot be deleted because it has associated release activity entries".
static String	getDeleteTargetWithOrganizationsError() Returns localized version of "The ESI target cannot be deleted because it has associated WTOrganization entries".
static String	getInconsistentClasses() Returns localized version of "The argument collection contained multiple classes".
static String	getInconsistentTransactionError() Returns localized version of "An ESI Virtual Database Builder has been given inconsistent transaction numbers".
static String	getInvalidActionError() Returns localized version of "Action must be ADD, CHANGE, or DELETE".
static String	getInvalidBooleanArgumentError() Returns localized version of "The argument was neither 'true' nor 'false' ".
static String	getInvalidChangeableError() Returns localized version of "The Change Object has an invalid changeable".
static String	getInvalidUfidError(String ufid) Returns localized version of "The argument '' is not a valid Unique Federation Identifier".
static String	getInvalidUserError(String user) Returns localized version of "The argument '' is not a properly formatted user".
private static Locale	getLocale()
static String	getMissingArgumentError() Returns localized version of "Missing argument".
static String	getMissingArgumentError(String paramName)
static String	getMissingComponentQuantityError() Returns localized version of "You may not publish components when the quantity is 0" Supported API: true
static String	getMissingFileError() Returns localized version of "Could not find file".
static String	getMissingOrgAssignmentError() Returns localized version of "No target assignment for object".
static String	getMissingOrgError() Returns localized version of "Could not find ESI target".
static String	getMissingParameter(String paramName) Returns localized version of "The following required parameter is missing: " with the argument appended.
static String	getMissingTransactionError(String txnID) Returns localized version of "The ESI transaction '' did not exist in the database".
static String	getMultipleOccurancesError(String assemblyPartNumber) Get localized version of "This part appears in multiple locations on the product structure that has part number: ".
static String	getNoESIMessageLog() Returns localized version of "There is no log message".
static String	getNoLineNumberError(WTPart part) Return localized version of "At least one component of '' does not have a line number." Supported API: true
static String	getNoRpcResponseError() Returns localized version of "An ESI Remote Procedure Call request returned no result".
static String	getNotFoundSourceLocaleError(Locale locale)
static String	getPartUnchangedError() Returns localized version of "The selected Part has not changed since the last successful publishing by ESI".
static String	getPendingMessage() Returns localized version of "pending".
static String	getPendingTransactionError() Returns localized version of "The object cannot be published because another publishing request is already active".
static String	getPropertiesError() Returns the result of getMissingFileError().
static String	getSuccessFailureMsg(String success) If the argument is "true" (case-insensitive) return localized version of "success"; otherwise return localized value of "failure".
static String	getTargetAlreadyExistsError() Returns localized version of "No database action was required".
static String	getTargetAlreadyExistsError(String targetNames) Returns localized version of "Target: targetNames already assigned".
static 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
static String	getTransactionNumberFormatError() Return localized version of "Transaction number is in number format only." Supported API: true
static String	getUnsupportedLocaleError(Locale locale) Return localized version of "Locale: '' is not a supported locale" Supported API: true
static String	getWarningMessagesError() Get localized version of "The transaction had one or more warning messages".
static void	main(String[] args)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

ALL

public static final String ALL

See Also:

Constant Field Values

SOME

public static final String SOME

See Also:

Constant Field Values

NONE

public static final String NONE

See Also:

Constant Field Values

ESI_RESOURCE

private static final String ESI_RESOURCE

See Also:

Constant Field Values

Constructor Detail

ESIMessages

public ESIMessages()

Method Detail

getAssignmentScopeMessage

public static final String getAssignmentScopeMessage(String msg)

Returns the assignment scope message. Localized form of "FULL", "SOME", or "NONE".

Supported API: false

Parameters:

msg - Should be "FULL", "SOME", or "NONE".

Returns:

String

getBOMUnchangedError

public static final String getBOMUnchangedError()

Returns localized version of "The selected BOM has not changed since the last successful release by ESI".

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 '' 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 '' 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 '' 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 '' 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 localized version of "The selected Part has not changed since the last successful publishing by ESI".

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 "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: '' 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

getMultipleOccurancesError

public static final String getMultipleOccurancesError(String assemblyPartNumber)

Get localized version of "This part appears in multiple locations on the product structure that has part number: ".

Supported API: false

Parameters:

assemblyPartNumber -

Returns:

String

getMissingArgumentError

public static final String getMissingArgumentError(String paramName)

main

public static void main(String[] args)

getLocale

private static Locale getLocale()

getNotFoundSourceLocaleError

public static final String getNotFoundSourceLocaleError(Locale locale)