org.kuali.rice.krad.data

Class MaterializeOption

java.lang.Object

org.kuali.rice.krad.data.MaterializeOption

All Implemented Interfaces:

Serializable

public class MaterializeOption
extends Object
implements Serializable

MaterializeOption is used when calling the DataObjectWrapper.materializeReferencedObjects(MaterializeOption...) method to adjust the behavior of the method. See the constants defined within the class for the available options and descriptions.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static MaterializeOption	COLLECTIONS Specify that only collections should be materialized.
static MaterializeOption	INCLUDE_EAGER_REFS Specify that non-lazy-loaded references should also be reloaded from the persistence provider.
static MaterializeOption	NULL_INVALID_REFS If this option is set, when the foreign key fields do not point to a saved object (per the persistence provider), the object reference will be nulled out.
static MaterializeOption	REFERENCES Specify that only references should be materialized.
static MaterializeOption	UPDATE_UPDATABLE_REFS Specify that references and/or collections which are saved when the wrapped object is saved should also be refreshed.

Constructor Summary

Constructors

Constructor and Description
MaterializeOption(String optionId) Sets the option Id

Method Summary

Methods

Modifier and Type	Method and Description
String	getOptionId() Gets the option id.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

REFERENCES

public static MaterializeOption REFERENCES

Specify that only references should be materialized. Adding this disables the default of refreshing both references and collections.

COLLECTIONS

public static MaterializeOption COLLECTIONS

Specify that only collections should be materialized. Adding this disables the default of refreshing both references and collections.

UPDATE_UPDATABLE_REFS

public static MaterializeOption UPDATE_UPDATABLE_REFS

Specify that references and/or collections which are saved when the wrapped object is saved should also be refreshed. CAUTION: This has the potential to overwrite previously updated data. This will effectively reset all child objects to their current saved state.

NULL_INVALID_REFS

public static MaterializeOption NULL_INVALID_REFS

If this option is set, when the foreign key fields do not point to a saved object (per the persistence provider), the object reference will be nulled out. Without this option, the object in that reference (if any) will be left alone if a valid object is not found.

INCLUDE_EAGER_REFS

public static MaterializeOption INCLUDE_EAGER_REFS

Specify that non-lazy-loaded references should also be reloaded from the persistence provider.

Constructor Detail

MaterializeOption

public MaterializeOption(String optionId)

Sets the option Id

Parameters:

optionId - cannot be null or blank.

Method Detail

getOptionId

public String getOptionId()

Gets the option id.

Returns:

not null or blank.

toString

public String toString()

Overrides:

toString in class Object