org.kuali.rice.kns.util
Class ForeignKeyFieldsPopulationState

java.lang.Object
  org.kuali.rice.kns.util.ForeignKeyFieldsPopulationState

All Implemented Interfaces:

Serializable

public class ForeignKeyFieldsPopulationState
extends Object
implements Serializable

This class is a token-style class, that is write-once, then read-only for all consumers of the class. It is often used as a return value from various PersistenceStructureService methods. The object represents the state of the foreign-key fields of a reference object. For example, if Account is the bo, and organization is the reference object, then chartOfAccountsCode and organizationCode are the foreign key fields. Their state, rather they are all filled out, whether any of them are filled out, and which ones are not filled out, is what this class represents.

See Also:

Serialized Form

Field Summary

private boolean	allFieldsPopulated
private boolean	anyFieldsPopulated
private List<String>	unpopulatedFieldNames

Constructor Summary

ForeignKeyFieldsPopulationState(boolean allFieldsPopulated, boolean anyFieldsPopulated, List<String> unpopulatedFieldNames)

Method Summary

List<String>	getUnpopulatedFieldNames() Gets the unpopulatedFieldNames attribute.
boolean	hasUnpopulatedFieldName(String fieldName)
boolean	isAllFieldsPopulated() Gets the allFieldsPopulated attribute.
boolean	isAnyFieldsPopulated() Gets the anyFieldsPopulated attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

allFieldsPopulated

private boolean allFieldsPopulated

anyFieldsPopulated

private boolean anyFieldsPopulated

unpopulatedFieldNames

private List<String> unpopulatedFieldNames

Constructor Detail

ForeignKeyFieldsPopulationState

public ForeignKeyFieldsPopulationState(boolean allFieldsPopulated,
                                       boolean anyFieldsPopulated,
                                       List<String> unpopulatedFieldNames)

Method Detail

isAllFieldsPopulated

public boolean isAllFieldsPopulated()

Gets the allFieldsPopulated attribute.

Returns:

Returns the allFieldsPopulated.

isAnyFieldsPopulated

public boolean isAnyFieldsPopulated()

Gets the anyFieldsPopulated attribute.

Returns:

Returns the anyFieldsPopulated.

getUnpopulatedFieldNames

public List<String> getUnpopulatedFieldNames()

Gets the unpopulatedFieldNames attribute.

Returns:

Returns the unpopulatedFieldNames.

hasUnpopulatedFieldName

public boolean hasUnpopulatedFieldName(String fieldName)

See Also:

org.kuali.rice.kns.service.PersistenceStructureService.ForeignKeyFieldsPopulation#hasUnpopulatedFieldName(java.lang.String)