|
EclipseLink 2.2.0, build 'v20110202-r8913' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProviderUtil
Utility interface implemented by the persistence provider. This
interface is invoked by the PersistenceUtil
implementation to determine
the load status of an entity or entity attribute.
Method Summary | |
---|---|
LoadState |
isLoaded(java.lang.Object entity)
If the provider determines that the entity has been provided by itself and that the state of all attributes for which FetchType.EAGER has been specified have been loaded, this
method returns LoadState.LOADED . |
LoadState |
isLoadedWithoutReference(java.lang.Object entity,
java.lang.String attributeName)
If the provider determines that the entity has been provided by itself and that the state of the specified attribute has been loaded, this method returns LoadState.LOADED . |
LoadState |
isLoadedWithReference(java.lang.Object entity,
java.lang.String attributeName)
If the provider determines that the entity has been provided by itself and that the state of the specified attribute has been loaded, this method returns LoadState.LOADED . |
Method Detail |
---|
LoadState isLoadedWithoutReference(java.lang.Object entity, java.lang.String attributeName)
LoadState.LOADED
.
If the provider determines that the entity has been provided
by itself and that either entity attributes with FetchType.EAGER
have not been loaded or that the state of the specified
attribute has not been loaded, this methods returns
LoadState.NOT_LOADED
.
If a provider cannot determine the load state, this method
returns LoadState.UNKNOWN
.
The provider's implementation of this method must not obtain a reference to an attribute value, as this could trigger the loading of entity state if the entity has been provided by a different provider.
entity
- entity instanceattributeName
- name of attribute whose load status is
to be determined
LoadState isLoadedWithReference(java.lang.Object entity, java.lang.String attributeName)
LoadState.LOADED
.
If a provider determines that the entity has been provided
by itself and that either the entity attributes with FetchType.EAGER
have not been loaded or that the state of the specified
attribute has not been loaded, this method returns
return LoadState.NOT_LOADED
.
If the provider cannot determine the load state, this method
returns LoadState.UNKNOWN
.
The provider's implementation of this method is permitted to
obtain a reference to the attribute value. (This access is
safe because providers which might trigger the loading of the
attribute state will have already been determined by
isLoadedWithoutReference
. )
entity
- entity instanceattributeName
- name of attribute whose load status is
to be determined
LoadState isLoaded(java.lang.Object entity)
FetchType.EAGER
has been specified have been loaded, this
method returns LoadState.LOADED
.
If the provider determines that the entity has been provided
by itself and that not all attributes with FetchType.EAGER
have been loaded, this method returns LoadState.NOT_LOADED
.
If the provider cannot determine if the entity has been
provided by itself, this method returns LoadState.UNKNOWN
.
The provider's implementation of this method must not obtain a reference to any attribute value, as this could trigger the loading of entity state if the entity has been provided by a different provider.
entity
- whose loaded status is to be determined
|
EclipseLink 2.2.0, build 'v20110202-r8913' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |