com.sap.netweaver.bc.uwl.substitution

Class SubstitutionStatus

java.lang.Object
  com.sap.netweaver.bc.uwl.substitution.SubstitutionStatus

public class SubstitutionStatus
extends Object

This class provides the detailed status of the substitution definition for each substitution manager's system

Constructor Summary

SubstitutionStatus(int errorCode, Exception ex, String providerId, String systemName)
Create the status with the basic status data: error code(if any), message and system name.

SubstitutionStatus(int errorCode, Exception ex, String providerId, String systemName, boolean ignoreUnknownProblem)

SubstitutionStatus(int errorCode, String message, String providerId, String systemName)
Create the status with the basic status data: error code(if any), message and system name.

SubstitutionStatus(int errorCode, String message, String providerId, String systemName, boolean ignoreUnknownProblem)
Create the status with the basic status data: error code(if any), message and system name.

SubstitutionStatus(String providerId, String systemName, Locale lc)
Create the good status with the basic status data: system name.

Method Summary

void	appendMessage(String message)
int	getErrorCode()
String	getErrorMessage()
String	getProviderId()
String	getSystemName()
boolean	isFailed() if the substitution action is considered to be a real error.
boolean	isReConnectable()
boolean	isSuccess() If the substitution action is successful.
void	setErrorCode(int errCode)
void	setMessage(String message)
void	setSystemName(String sysName)
void	supressMinorProblem()

Methods inherited from class java.lang.Object

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

Constructor Detail

SubstitutionStatus

public SubstitutionStatus(String providerId,
                          String systemName,
                          Locale lc)

Create the good status with the basic status data: system name.

Parameters:

providerId - name of the substitution manager provider

systemName - Name of the system, required.

lc - The user locale for the successful message.

SubstitutionStatus

public SubstitutionStatus(int errorCode,
                          String message,
                          String providerId,
                          String systemName)

Create the status with the basic status data: error code(if any), message and system name.

Parameters:

errorCode - Codes found in class com.sap.netweaver.bc.uwl.ErrorMessages. If no error, use 0. Any error code other than 0 will have failed status.

message - Error message. Leave it empty if there is none.

providerId - name of the substitution manager provider

systemName - Name of the system, required.

SubstitutionStatus

public SubstitutionStatus(int errorCode,
                          Exception ex,
                          String providerId,
                          String systemName)

Create the status with the basic status data: error code(if any), message and system name.

Parameters:

errorCode - Codes found in class com.sap.netweaver.bc.uwl.ErrorMessages. If no error, use 0. Any error code other than 0 will have failed status.

ex - Exception. Name and error message will be extracted for the status.

providerId - name of the substitution manager provider

systemName - Name of the system, required.

SubstitutionStatus

public SubstitutionStatus(int errorCode,
                          String message,
                          String providerId,
                          String systemName,
                          boolean ignoreUnknownProblem)

Create the status with the basic status data: error code(if any), message and system name.

Parameters:

errorCode - Codes found in class com.sap.netweaver.bc.uwl.ErrorMessages. If no error, use 0. Only major known error code will have failed status.

message - Error message. Leave it empty if there is none.

providerId - name of the substitution manager provider

systemName - Name of the system, required.

ignoreUnknownProblem - true if only major known error is considered to be failed (eg. provider internal error)

SubstitutionStatus

public SubstitutionStatus(int errorCode,
                          Exception ex,
                          String providerId,
                          String systemName,
                          boolean ignoreUnknownProblem)

Method Detail

getErrorCode

public int getErrorCode()

Returns:

String The error code.

getErrorMessage

public String getErrorMessage()

Returns:

String the message text. Empty if there is none.

isSuccess

public boolean isSuccess()

If the substitution action is successful.
For Create/switchON: return TRUE if rule can be created/switched ON.
For Delete/switchOFF: return FALSE for all known/unknown problem (eg. connection problem or provider error or system not supporting substitution, ....)

isFailed

public boolean isFailed()

if the substitution action is considered to be a real error.
For Create/switchON: return TRUE if rule canNOT be created/switched ON.
For Delete/switchOFF: Depends. Return TRUE if it is certain that the rule canNOT be deleted/switched OFF. (eg. provider internal error). Return FALSE for situation like system does not support substitution at all or connection problem, ....

supressMinorProblem

public void supressMinorProblem()

getSystemName

public String getSystemName()

Returns:

String the name of the system.

setSystemName

public void setSystemName(String sysName)

getProviderId

public String getProviderId()

Returns:

String the name of the substitution manager provider.

setMessage

public void setMessage(String message)

appendMessage

public void appendMessage(String message)

setErrorCode

public void setErrorCode(int errCode)

isReConnectable

public boolean isReConnectable()

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] UWLJWF	[sap.com] tc/kmc/bc.uwl/api	-	EP-BC-UWL
[sap.com] UWLJWF	[sap.com] tc/kmc/bc.uwl/api	default	EP-BC-UWL