com.sap.netweaver.bc.uwl.substitution

Interface IBaseSubstitution

All Known Implementing Classes:

AssignedSubstitution, Substitution

public interface IBaseSubstitution

Hold basic data for a substitution definition.

See Also:

AssignedSubstitution, Substitution

Method Summary

String	getMessage() Get a message for this substitution.
String	getProviderId()
int	getSubstitutionMode()
String	getSubstitutionProfileId()
String	getSystemId()
boolean	isValid()
void	setSubstitutionProfileId(String subProfileId) Set the Id of the substitution profile

Method Detail

getProviderId

String getProviderId()

Returns:

Id of the provider substitution manager

getSystemId

String getSystemId()

Returns:

Id of the system (if any) of the provider. Can be null

getSubstitutionProfileId

String getSubstitutionProfileId()

Returns:

Substitution profile defined for this substitution.

setSubstitutionProfileId

void setSubstitutionProfileId(String subProfileId)

Set the Id of the substitution profile

getSubstitutionMode

int getSubstitutionMode()

Returns:

Substitution mode. Refer to IProviderSubstitutionManager.MODE_RECEIVETASKS or IProviderSubstitutionManager.MODE_TAKEOVER

isValid

boolean isValid()

Returns:

True if definition is valid, otherwise, false.

getMessage

String getMessage()

Get a message for this substitution. Return null if there is no message

Access Rights

This class can be accessed from:

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