com.businessobjects.sdk.plugin.desktop.custommappedattribute
Interface IAttributeSources

All Superinterfaces:

java.util.Collection, ISDKSet, java.lang.Iterable, java.util.Set

public interface IAttributeSources
extends ISDKSet

Interface to manage attribute sources

Since:

4.1

Method Summary

IAttributeSource	addSource(java.lang.String pluginKind, java.lang.String externalName) Adds a new object to the collection.
IAttributeSource	getSource(java.lang.String pluginKind) Get IAttribute object based on an security plugin kind
boolean	removeSource(java.lang.String pluginKind) Remove specified attribute source object based on the plugin kind from the collection

Methods inherited from interface com.crystaldecisions.sdk.properties.ISDKSet

get

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

getSource

IAttributeSource getSource(java.lang.String pluginKind)

Get IAttribute object based on an security plugin kind

Parameters:

pluginKind -

Returns:

A IAttributeSource object representing a source from that plugin

addSource

IAttributeSource addSource(java.lang.String pluginKind,
                           java.lang.String externalName)
                           throws SDKException

Adds a new object to the collection. This method should always be used to add new source to the end of the sources collection, it will throw exception if the pluginKind already exist

Parameters:

pluginKind - The kind of the security plugin

externalName - The name of the attribute on the 3rd party identity system

Returns:

An IAttributeSource object containing the newly created attribute source object

Throws:

if - any input strings is null or empty

SDKException.InvalidArg - if the pluginKind already exist

SDKException

removeSource

boolean removeSource(java.lang.String pluginKind)

Remove specified attribute source object based on the plugin kind from the collection

Parameters:

pluginKind - The kind of security plugin

Returns:

boolean indicate if object has been removed