io.jmix.data

Interface ReferenceIdProvider

All Known Implementing Classes:

EclipselinkReferenceIdProvider

public interface ReferenceIdProvider

Enables working with references to entities without loading them from the database.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ReferenceIdProvider.RefId A wrapper for the reference ID value returned by getReferenceId(Object, String) method.

Method Summary

Modifier and Type	Method and Description
ReferenceIdProvider.RefId	getReferenceId(java.lang.Object entity, java.lang.String property) Returns an ID of directly referenced entity without loading it from DB.

Method Detail

getReferenceId

ReferenceIdProvider.RefId getReferenceId(java.lang.Object entity,
                                         java.lang.String property)

Returns an ID of directly referenced entity without loading it from DB.

If the fetchPlan does not contain the reference and FetchPlan.loadPartialEntities() is true, the returned ReferenceIdProvider.RefId will have ReferenceIdProvider.RefId.isLoaded() = false.

Usage example:

   ReferenceIdProvider.RefId refId = referenceIdProvider.getReferenceId(doc, "currency");
   if (refId.isLoaded()) {
       String currencyCode = (String) refId.getValue();
   }
 

Parameters:

entity - entity instance in managed state

property - name of reference property

Returns:

ReferenceIdProvider.RefId instance which contains the referenced entity ID

Throws:

java.lang.IllegalArgumentException - if the specified property is not a reference

java.lang.IllegalStateException - if the entity is not in Managed state

java.lang.RuntimeException - if anything goes wrong when retrieving the ID