com.sapportals.wcm.rfadapter

Class Result

java.lang.Object
  com.sapportals.wcm.rfadapter.Result

public class Result
extends Object

encapsulates all information available when the system tried tocreate an IResource object. The message-attribut is either defined by the class calling the framework or can also contain the message of the WcmException thrown by the framework.

Constructor Summary

Result(Status status, String message, WcmException e, IResource res)

Result(Status status, String message, WcmException e, IResource res, AdapterCode ac)

Method Summary

AdapterCode	code()
WcmException	exception()
String	message()
IResource	resource()
Status	status()
String	toString() returns a concatination of all attribute values.

Methods inherited from class java.lang.Object

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

Constructor Detail

Result

public Result(Status status,
              String message,
              WcmException e,
              IResource res)

Parameters:

status - stating if the creation worked without problems, minor problems or not at all. Must not be null

message - this message is used to inform the user about the result of the operation. It must be translated and must not be null

e - the exception that might be thrown by the framework when trying to create an IResource. If everything went ok, this parameter should be set to null

res - the new object created, if everything worked ok. Might be null

Result

public Result(Status status,
              String message,
              WcmException e,
              IResource res,
              AdapterCode ac)

Parameters:

status - stating if the creation worked without problems, minor problems or not at all. Must not be null

message - this message is used to inform the user about the result of the operation. It must be translated and must not be null

e - the exception that might be thrown by the framework when trying to create an IResource. If everything went ok, this parameter should be set to null

res - the new object created, if everything worked ok. Might be null

Method Detail

status

public final Status status()

Returns:

the status attribute of the class, must not be null

message

public final String message()

Returns:

the message attribute of the class, must not be null. The message should be translated. Note that it is not this class' responsibility to translate this message - the message should already be translated by the class that constructed this instance.

exception

public final WcmException exception()

Returns:

the exception attribute of this class. Might be null

resource

public final IResource resource()

Returns:

the resource attribute of this class. Might be null;

toString

public String toString()

returns a concatination of all attribute values.

Overrides:

toString in class Object

code

public AdapterCode code()

Returns:

the technical code of the message of this result. If no code has been provided by the instantiating class, this class will set this code to AdapterCode.UNSPECIFIED. This method will never return null

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM