com.sap.netweaver.bc.uwl

Class ProviderStatus

java.lang.Object
  com.sap.netweaver.bc.uwl.ProviderStatus

All Implemented Interfaces:

Serializable

public class ProviderStatus
extends Object
implements Serializable

The ProviderStatus class captures the data related to the status of the provider. This has roughly six properties. The getters and setters are provided for these properties.

See Also:

Serialized Form

Constructor Summary

ProviderStatus(boolean success, String errorCode, Exception ex, String systemName, String connectorName)

ProviderStatus(boolean success, String systemName, String connectorName)

ProviderStatus(boolean success, String errorCode, String message, String systemName, String connectorName)
This constructor allows the user toinitialize all the properties of this object except for the date of creation The createDate is initialized to the current time.

Method Summary

String	getCode()
String	getConnectorName()
Date	getCreatedDate() Deprecated. use getCreatedTime instead
long	getCreatedTime()
String	getMessage()
String	getSystemName()
int	getTimeSpentByConnector() Used for monitoring purposes.
boolean	isSuccess()
void	setCode(String errorCode)
void	setConnectorName(String connectorName)
void	setMessage(String message)
void	setSuccess(boolean b)
void	setSystemName(String systemName)
void	setTimeSpentByConnector(int i) Used for monitoring purposes.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProviderStatus

public ProviderStatus(boolean success,
                      String errorCode,
                      String message,
                      String systemName,
                      String connectorName)

This constructor allows the user toinitialize all the properties of this object except for the date of creation The createDate is initialized to the current time.

Parameters:

success -

errorCode - One of the codes like INVALID_LENGTH_SPECIFIED.

message - the text of the message.

systemName - the name of the system.

connectorName - the connector name.

ProviderStatus

public ProviderStatus(boolean success,
                      String errorCode,
                      Exception ex,
                      String systemName,
                      String connectorName)

ProviderStatus

public ProviderStatus(boolean success,
                      String systemName,
                      String connectorName)

Method Detail

getCode

public String getCode()

Returns:

String the error code like INVALID_LENGTH_SPECIFIED.

getConnectorName

public String getConnectorName()

Returns:

String the connector name.

getMessage

public String getMessage()

Returns:

String the message text.

isSuccess

public boolean isSuccess()

Returns:

boolean true if successful and false otherwise.

getSystemName

public String getSystemName()

Returns:

String the name of the system.

setCode

public void setCode(String errorCode)

Parameters:

errorCode - the error code like INVALID_LENGTH_SPECIFIED.

setConnectorName

public void setConnectorName(String connectorName)

Parameters:

connectorName - the connector name.

setMessage

public void setMessage(String message)

Parameters:

message - the message text.

setSuccess

public void setSuccess(boolean b)

Parameters:

b - indicates whether or not successful.

setSystemName

public void setSystemName(String systemName)

Parameters:

systemName - the system name.

getCreatedTime

public long getCreatedTime()

Returns:

System time when this Status object is created

getCreatedDate

public Date getCreatedDate()

Deprecated. use getCreatedTime instead

Returns:

Date the date of creation.

getTimeSpentByConnector

public int getTimeSpentByConnector()

Used for monitoring purposes. UWL internally will take care of this.

Returns:

in milliseconds

setTimeSpentByConnector

public void setTimeSpentByConnector(int i)

Used for monitoring purposes. UWL internally will take care of this.

Parameters:

i - in milliseconds

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