com.sap.tc.col.client.generic.api
Interface IStructure

All Known Subinterfaces:

IAspectRow

public interface IStructure

realizes structured data for AspectRow or parameters of an Action or Query

Additionally Structure implements ICMIGenericModelClass .

This is necessary to use a Structure from Web Dynpro. Web Dynpro framework only knows this interface

Method Summary

java.lang.String	getAttributeAsString(int attributeIndex) Returns the value of the attribute to given index as String or throws an IndexOutOfBoundsException, if attributeIndex is no valide index.
java.lang.String	getAttributeAsString(java.lang.String attributeName) Returns the value of the attribute with given name as String or throws an IllegalArgumentException, if attributeName is no valid name for an attribute.
java.lang.Object	getAttributeValue(int attributeIndex) Returns the value of the attribute to given index as Object or throws an IndexOutOfBoundsException, if attributeIndex is no valide index.
java.lang.Object	getAttributeValue(java.lang.String attributeName) Returns the value of the attribute with given name as Object or throws an IllegalArgumentException, if attributeName is no valid name for an attribute.
IStructureDescriptor	getDescriptor() Returns the meta data of this Structure.
boolean	isAttributeInitial(int attributeIndex) returns true, if attribute with given attributeIndex is in initial state, or false otherwise.
boolean	isAttributeInitial(java.lang.String attributeName) returns true, if attribute with given attributeName is in initial state, or false otherwise.
void	setAttributeValue(int attributeIndex, java.lang.Object value) Sets the given value to the attribute with given index or throws an IndexOutOfBoundsException.
void	setAttributeValue(java.lang.String attributeName, java.lang.Object value) Sets the given value to the attribute with given name or throws an IllegalArgumentException, if attributeName is no valid name for an attribute.
int	size() returns the number of fields in this Structure, which corresponds to the number of Fields in StructureDescriptor.
java.lang.String	toString() returns a string representation of this object.

Method Detail

getAttributeAsString

public java.lang.String getAttributeAsString(java.lang.String attributeName)

Returns the value of the attribute with given name as String or throws an IllegalArgumentException, if attributeName is no valid name for an attribute.

Parameters:

attributeName - the name of the attribute

Returns:

the value of the attribute with given name as String or throws an IllegalArgumentException, if attributeName is no valid name for an attribute.

getAttributeAsString

public java.lang.String getAttributeAsString(int attributeIndex)

Returns the value of the attribute to given index as String or throws an IndexOutOfBoundsException, if attributeIndex is no valide index.

Parameters:

attributeIndex - the index of the attribute

Returns:

String the value of the attribute to given index as String or throws an IndexOutOfBoundsException, if attributeIndex is no valide index.

getAttributeValue

public java.lang.Object getAttributeValue(java.lang.String attributeName)

Returns the value of the attribute with given name as Object or throws an IllegalArgumentException, if attributeName is no valid name for an attribute.

Parameters:

attributeName - the name of the attribute

Returns:

Object the value of the attribute with given name as Object or throws an IllegalArgumentException, if attributeName is no valid name for an attribute.

getAttributeValue

public java.lang.Object getAttributeValue(int attributeIndex)

Returns the value of the attribute to given index as Object or throws an IndexOutOfBoundsException, if attributeIndex is no valide index.

Parameters:

attributeIndex - the index of the attribute

Returns:

Object the value of the attribute to given index as Object or throws an IndexOutOfBoundsException, if attributeIndex is no valide index.

setAttributeValue

public void setAttributeValue(java.lang.String attributeName,
                              java.lang.Object value)

Sets the given value to the attribute with given name or throws an IllegalArgumentException, if attributeName is no valid name for an attribute.

Parameters:

attributeName - the name of the attribute

value - the value of the attribute as Object to set

setAttributeValue

public void setAttributeValue(int attributeIndex,
                              java.lang.Object value)

Sets the given value to the attribute with given index or throws an IndexOutOfBoundsException.

Parameters:

attributeIndex - the index of the attribute

value - the value of the attribute as Object to set

isAttributeInitial

public boolean isAttributeInitial(int attributeIndex)

returns true, if attribute with given attributeIndex is in initial state, or false otherwise.

Parameters:

attributeIndex - the index of the attribute to check

Returns:

boolean true, if attribute with given index is in initial state, or false otherwise.

isAttributeInitial

public boolean isAttributeInitial(java.lang.String attributeName)

returns true, if attribute with given attributeName is in initial state, or false otherwise.

Parameters:

attributeName - the name of the attribute to check

Returns:

boolean true, if attribute with given index is in initial state, or false otherwise.

getDescriptor

public IStructureDescriptor getDescriptor()

Returns the meta data of this Structure.

typically meta data are the name of the Structure and the meta data of the different fields (attributes).

Returns:

IStructureDescriptor the meta data of this structure

size

public int size()

returns the number of fields in this Structure, which corresponds to the number of Fields in StructureDescriptor. It is only a shortcut for:

getDescriptor().size()

.

Returns:

int the number of fields

toString

public java.lang.String toString()

returns a string representation of this object.

Usage is recommended for tracing purposes only

Returns:

String a string representation of this object