com.sap.tc.col.client.metadata.api
Interface IStructureDescriptor

public interface IStructureDescriptor

Provides information about structures which are cached in the service manager repository. A structure is uniquely identified by its name within a given service manager instance. Structures contain a number of fields, whose descriptors can be accessed through structure descriptor objects.

See Also:

IFieldDescriptor

Method Summary

IFieldDescriptor	getFieldDescriptor(int index) Returns the field descriptor of the field with index in this structure.
IFieldDescriptor	getFieldDescriptor(java.lang.String fieldName) Returns the field desriptor of the field with the given name in this structure.
IFieldDescriptor[]	getFieldDescriptors() Returns an array which contains all field descriptors in this structure.
int	getFieldIndex(java.lang.String name) Returns the index of the field with given name or -1 if the field does not exist.
java.lang.String	getName() Returns the name of the structure.
boolean	hasField(java.lang.String fieldName) Returns whether this structure contains a field with the given name.
int	size() Returns the number of fields of this structure.

Method Detail

getName

public java.lang.String getName()

Returns the name of the structure.

Returns:

name of the structure.

getFieldIndex

public int getFieldIndex(java.lang.String name)

Returns the index of the field with given name or -1 if the field does not exist.

Parameters:

name - the name of the field

Returns:

int the index of the field with given name or -1 if not exists

size

public int size()

Returns the number of fields of this structure.

getFieldDescriptor

public IFieldDescriptor getFieldDescriptor(int index)

Returns the field descriptor of the field with index in this structure.

Returns:

the requested field descriptor.

getFieldDescriptor

public IFieldDescriptor getFieldDescriptor(java.lang.String fieldName)

Returns the field desriptor of the field with the given name in this structure.

Returns:

the requested field descriptor.

Throws:

java.lang.IllegalArgumentException - if no field with the given name exists in this structure.

getFieldDescriptors

public IFieldDescriptor[] getFieldDescriptors()

Returns an array which contains all field descriptors in this structure. If no fields exist in this structure an empty array is returned

Returns:

An array with the field descriptors.

hasField

public boolean hasField(java.lang.String fieldName)

Returns whether this structure contains a field with the given name.

Parameters:

fieldName - the name of the field

Returns:

boolean true if a field with the given name exists in this structure, otherwise false