com.mindoo.remote.api.symphony
Interface IRemoteUserDefinedAttributes

public interface IRemoteUserDefinedAttributes

This class represents all the user-defined attributes.

Access

• To get the attributes of a page, use the Attributes property in the Page class.
• To get the attributes of a shape, use the Attributes property in the Shape class.

Usage

This class is used to add or remove user-defined attributes.

Method Summary

IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
java.lang.String	getAttribute(java.lang.String name) This method returns an attribute value according to the attribute name.
java.lang.String[]	getAttributeNames() This property returns all the names of the user-defined attributes on a page or shape.
int	getCount() This property represents the number of the attributes on a page or shape.
boolean	hasAttribute(java.lang.String name) This method returns whether a shape or a page contains an attribute.
void	removeAttribute(java.lang.String name) This method removes an attribute by its name.
void	setAttribute(java.lang.String name, java.lang.String value) This method sets a new attribute.

Method Detail

getAttribute

java.lang.String getAttribute(java.lang.String name)
                              throws RemoteEclipseAPIException

This method returns an attribute value according to the attribute name.

Parameters:

name - Specifies the name of the attribute to return.

Returns:

A String that represents an attribute value.

Throws:

RemoteEclipseAPIException

setAttribute

void setAttribute(java.lang.String name,
                  java.lang.String value)
                  throws RemoteEclipseAPIException

This method sets a new attribute.

Parameters:

name - Specifies the name of the attribute.

value - Specifies the value of the attribute.

Throws:

RemoteEclipseAPIException

removeAttribute

void removeAttribute(java.lang.String name)
                     throws RemoteEclipseAPIException

This method removes an attribute by its name.

Parameters:

name - Specifies the name of the attribute to get.

Throws:

RemoteEclipseAPIException

getAttributeNames

java.lang.String[] getAttributeNames()
                                     throws RemoteEclipseAPIException

This property returns all the names of the user-defined attributes on a page or shape. If there are no user-defined attributes, this property throws an exception.

Returns:

names

Throws:

RemoteEclipseAPIException

hasAttribute

boolean hasAttribute(java.lang.String name)
                     throws RemoteEclipseAPIException

This method returns whether a shape or a page contains an attribute.

Parameters:

name - Specifies the name of the attribute to get.

Returns:

boolean

Throws:

RemoteEclipseAPIException

getCount

int getCount()
             throws RemoteEclipseAPIException

This property represents the number of the attributes on a page or shape.

Returns:

count

Throws:

RemoteEclipseAPIException

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException