Package com.microstrategy.web.objects

Interface WebDirectedAttributes

public interface WebDirectedAttributes

The WebDirectedAttributes interface simply represents a collection of WebDirectedAttribute objects. This object can be obtained from a WebRelationship object.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

Modifier and Type	Method	Description
WebDirectedAttribute	add(WebAttribute attribute, int direction)	Adds a WebDirectedAttribute object containing the given attribute and direction to the collection.
void	clear()	Removes all items from the collection.
java.util.Enumeration	elements()	Returns a java.util.Enumeration containing the items in the collection.
WebDirectedAttribute	get(int index)	Returns the WebDirectedAttribute object with the given index.
boolean	isEmpty()	Returns whether the collection is empty.
void	remove(int index)	Removes the object with the given index from the collection.
int	size()	Returns the number of items in the collection.

Method Detail

add

WebDirectedAttribute add(WebAttribute attribute,
                         int direction)

Adds a WebDirectedAttribute object containing the given attribute and direction to the collection.

Parameters:

attribute - The WebAttribute which is the target of the directed attribute object.

direction - The direction of the directed attribute, from EnumDSSXMLAttributeDirection.

Returns:

The newly created WebDirectedAttribute object.

get

WebDirectedAttribute get(int index)
                  throws java.lang.IndexOutOfBoundsException

Returns the WebDirectedAttribute object with the given index.

Parameters:

index - The index of the object to return from the collection.

Returns:

The WebDirectedAttribute object with the given index.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if the index does not exist in the collection.

remove

void remove(int index)
     throws java.lang.IndexOutOfBoundsException

Removes the object with the given index from the collection.

Parameters:

index - The index of the object to remove.

Throws:

java.lang.IndexOutOfBoundsException - Thrown if the index does not exist in the collection.

size

int size()

Returns the number of items in the collection.

Returns:

The size of the collection.

isEmpty

boolean isEmpty()

Returns whether the collection is empty.

Returns:

True if the collection is empty, false if not.

clear

void clear()

Removes all items from the collection.

elements

java.util.Enumeration elements()

Returns a java.util.Enumeration containing the items in the collection.

Returns:

An Enumeration object containing the objects in the collection.