com.sun.jdo.api.persistence.model.jdo
Interface FieldElementHolder

All Known Implementing Classes:

ConcurrencyGroupElement, FieldGroupElement, PersistenceClassElement

public interface FieldElementHolder

Version:

%I%

Author:

raccah

Method Summary

void	addField(PersistenceFieldElement field) Add the supplied field to the collection of fields maintained by this holder.
void	addFields(PersistenceFieldElement[] fields) Add the supplied fields to the collection of fields maintained by this holder.
boolean	containsField(PersistenceFieldElement field) Tests whether the supplied field is in the collection of fields maintained by this holder.
PersistenceFieldElement	getField(String name) Returns the field with the supplied name from the collection of fields maintained by this holder.
PersistenceFieldElement[]	getFields() Returns the collection of fields maintained by this holder in the form of an array.
void	removeField(PersistenceFieldElement field) Remove the supplied field from the collection of fields maintained by this holder.
void	removeFields(PersistenceFieldElement[] fields) Removed the supplied fields from the collection of fields maintained by this holder.
void	setFields(PersistenceFieldElement[] fields) Sets the collection of fields maintained by this holder to the contents of the supplied array.

Method Detail

addField

void addField(PersistenceFieldElement field)
              throws ModelException

Add the supplied field to the collection of fields maintained by this holder.

Parameters:

field - the field to be added

Throws:

ModelException - if impossible

addFields

void addFields(PersistenceFieldElement[] fields)
               throws ModelException

Add the supplied fields to the collection of fields maintained by this holder.

Parameters:

fields - the array of fields to be added

Throws:

ModelException - if impossible

removeField

void removeField(PersistenceFieldElement field)
                 throws ModelException

Remove the supplied field from the collection of fields maintained by this holder.

Parameters:

field - the field to be removed

Throws:

ModelException - if impossible

removeFields

void removeFields(PersistenceFieldElement[] fields)
                  throws ModelException

Removed the supplied fields from the collection of fields maintained by this holder.

Parameters:

fields - the array of fields to be removed

Throws:

ModelException - if impossible

getFields

PersistenceFieldElement[] getFields()

Returns the collection of fields maintained by this holder in the form of an array.

Returns:

the fields maintained by this holder

setFields

void setFields(PersistenceFieldElement[] fields)
               throws ModelException

Sets the collection of fields maintained by this holder to the contents of the supplied array.

Parameters:

fields - the fields maintained by this holder

Throws:

ModelException - if impossible

getField

PersistenceFieldElement getField(String name)

Returns the field with the supplied name from the collection of fields maintained by this holder.

Parameters:

name - the name to match

Returns:

the field with the supplied name, null if none exists

containsField

boolean containsField(PersistenceFieldElement field)

Tests whether the supplied field is in the collection of fields maintained by this holder.

Parameters:

field - the field to be tested