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

All Superinterfaces:

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

public interface IAttributes
extends ISDKSet

Method Summary

IAttribute	addAttribute(java.lang.String attributeName, java.lang.String friendlyName) Adds a new object to the collection.
IAttribute	getAttribute(java.lang.String attributeName) Get IAttribute object based on an attribute name
boolean	removeAttribute(java.lang.String attributeName) Remove attribute object based on the attribute name 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

getAttribute

IAttribute getAttribute(java.lang.String attributeName)

Get IAttribute object based on an attribute name

Parameters:

attributeName -

Returns:

A IAttribute object

addAttribute

IAttribute addAttribute(java.lang.String attributeName,
                        java.lang.String friendlyName)
                        throws SDKException

Adds a new object to the collection. This method should always be used to add an attribute to the end of the attributes collection, it will throw exception if the attribute name already exist

Parameters:

attributeName - The name of the new attribute

friendlyName - The friendly name of the new attribute

Returns:

An IAttribute object containing the newly created attribute object

Throws:

if - any input strings is null or empty

SDKException.InvalidArg - if the attributeName contains special characters other than digits, alphabets or underscore.

SDKException.InvalidArg - if the attributeName already exist

SDKException

removeAttribute

boolean removeAttribute(java.lang.String attributeName)

Remove attribute object based on the attribute name from the collection

Parameters:

attributeName -

Returns:

boolean indicate if object has been removed