com.sap.portal.pcm.system

Interface ISystems

public interface ISystems

Represents the system landscape service that provides helper methods for working with systems.

Since:

EP6 SP2

Field Summary

static String

KEY The service identifier

Method Summary

String[]	getAliases() Retrieves all aliases from the PCD.
String[]	getAliases(IPrincipal principal, boolean usePersonalized) Retrieves all aliases from the PCD that are assigned to systems the IPrincipal passed to this method has permission to.
String[]	getDefaultAliases() Retrieves all default aliases from the PCD.
String	getSystemId(String alias) Retrieves the system ID for a specific alias.
boolean	isDefaultAlias(String alias) Indicates whether a specific alias is a default alias.

Field Detail

KEY

public static final String KEY

The service identifier

See Also:

Constant Field Values

Method Detail

getDefaultAliases

public String[] getDefaultAliases()

Retrieves all default aliases from the PCD.

Returns:

String[] - Array of alias names

getAliases

public String[] getAliases()

Retrieves all aliases from the PCD.

Returns:

String[] - Array of alias names

getAliases

public String[] getAliases(IPrincipal principal,
                           boolean usePersonalized)

Retrieves all aliases from the PCD that are assigned to systems the IPrincipal passed to this method has permission to.

Parameters:

principal - user representation.

usePersonalized - whether to retrieve aliases associated with systems the user has also "end user" permission on.
true - Aliases pointing to systems that the given user has "end user" permission will be returned.
false - Aliases pointing to systems that the given user does not have "admin" permission will be returned.

Returns:

Array of alias names

getSystemId

public String getSystemId(String alias)

Retrieves the system ID for a specific alias. Dynamic system resolution is supported, so this method first tries to retrieve the system ID from a registered resolving service if one is registered for this alias in the portal registry. Otherwise, it searches for the alias in the PCD and returns the system to which the alias is bound.

Parameters:

alias - by which to extract the system Id.

Returns:

String identifier of the semantic system object.

Throws:

com.sap.portal.pcm.alias.AmbiguousAliasException - If alias is defined both in the prt registry and in the PCD.

isDefaultAlias

public boolean isDefaultAlias(String alias)

Indicates whether a specific alias is a default alias.

Parameters:

alias - the alias to check.

Returns:

true if given alias is default, false otherwise