com.sap.netweaver.bc.uwl.substitution

Class SubstitutionProfile

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

public class SubstitutionProfile
extends Object

Substitution Profile. A substitution profile categorizes relevant tasks in the provider system. Profiles can be predefined or customized in the provider system (varies from providers). A profile should at least contain an id for internal reference (provider is responsible for a unique profile id) and a title name for display.

Constructor Summary

SubstitutionProfile(String id, String title, String description, String providerId, List systIds)
Create a substitution profile.

Method Summary

void	addSystem(String systId) Append the input system value to any already existing system associated with this profile
String	getDescription()
String	getId()
String	getProviderId()
String[]	getSystemIds()
List	getSystemIdsList()
String	getTitle()
void	setId(String pId)
void	setProviderId(String pId)

Methods inherited from class java.lang.Object

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

Constructor Detail

SubstitutionProfile

public SubstitutionProfile(String id,
                           String title,
                           String description,
                           String providerId,
                           List systIds)

Create a substitution profile. Id, title and providerId should not be null or empty.

Parameters:

id - Profile id, unique within the provider system

title - Name of the substitution profile

description - Description of the profile

providerId - Identifier of the provider

systIds - System names of the provider where this profile exists. Can be null if provider does not has multiple systems.

Method Detail

addSystem

public void addSystem(String systId)

Append the input system value to any already existing system associated with this profile

Parameters:

systId - system id to be added

getId

public String getId()

Returns:

Unique id of the substitution profile defined in the provider system.

getTitle

public String getTitle()

Returns:

the title of the substitution profile defined in the provider system. This will be displayed as the profile name in maintaining a substitution.

getDescription

public String getDescription()

Returns:

Detailed description of the substitution profile. Return null if there is no description

getProviderId

public String getProviderId()

Returns:

Provider of the substitution profile. Can be null if it's not set yet.

setProviderId

public void setProviderId(String pId)

setId

public void setId(String pId)

getSystemIds

public String[] getSystemIds()

Returns:

System ids (if any) belongs to the provider of the substitution profile. Return non-null.

getSystemIdsList

public List getSystemIdsList()

Returns:

System ids (if any) belongs to the provider of the substitution profile. Return non-null.

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