org.jpox
Interface FetchGroup

All Known Implementing Classes:

FetchGroupImpl

public interface FetchGroup

Representation of a FetchGroup for a class. Has a symbolic name for the group, and the class and the fields of the class that are part of the group.

Version:

$Revision: 1.4 $

Method Summary

FetchGroup	add(java.lang.String fieldName) Method to add a field of the class to the fetch group.
java.lang.String	getClassName() Accessor for the class for this fetch group.
java.lang.String[]	getFieldNames() Accessor for the names of the fields in this fetch group.
java.lang.String	getName() Accessor for the group name.
boolean	getPostLoad() Accessor for whether to call postLoad when this group is loaded.
boolean	hasField(java.lang.String fieldName) Accessor for whether a particular field is in this group.
FetchGroup	remove(java.lang.String fieldName) Method to remove a field of the class from the fetch group.
void	setPostLoad(boolean postLoad) Mutator for whether the postLoad callback should be called on loading this fetch group.

Method Detail

getName

java.lang.String getName()

Accessor for the group name.

Returns:

Name of the group

getClassName

java.lang.String getClassName()

Accessor for the class for this fetch group.

Returns:

Name of the class for this group

setPostLoad

void setPostLoad(boolean postLoad)

Mutator for whether the postLoad callback should be called on loading this fetch group.

Parameters:

postLoad - Whether the postLoad callback should be called.

getPostLoad

boolean getPostLoad()

Accessor for whether to call postLoad when this group is loaded.

Returns:

Whether to call postLoad

add

FetchGroup add(java.lang.String fieldName)

Method to add a field of the class to the fetch group.

Parameters:

fieldName - Name of the field

Returns:

This FetchGroup

remove

FetchGroup remove(java.lang.String fieldName)

Method to remove a field of the class from the fetch group.

Parameters:

fieldName - Name of the field

Returns:

This FetchGroup

hasField

boolean hasField(java.lang.String fieldName)

Accessor for whether a particular field is in this group.

Parameters:

fieldName - Name of the field

Returns:

Whether it is present

getFieldNames

java.lang.String[] getFieldNames()

Accessor for the names of the fields in this fetch group.

Returns:

Names of the fields in the group