Module org.cruk.clarity.api
Package com.genologics.ri

Annotation Type ClarityBatchRetrieveResult

@Retention(RUNTIME) @Target(TYPE) public @interface ClarityBatchRetrieveResult
Annotation for classes that contain lists of entities fetched from the API's batch retrieve mechanism.

Some entities can also be created or updated with a batch call. The attributes of this annotation specify which of these operations can take place like this.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Class<? extends Locatable>
    entityClass
    The class of entity indicated by the links returned in the annotated object.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    batchCreate
    Flag indicating that the annotated entity can be created using a batch creation call.
    boolean
    batchUpdate
    Flag indicating that the annotated entity can be updated using a batch update call.

  • Element Details

    • entityClass

      Class<? extends Locatable> entityClass
      The class of entity indicated by the links returned in the annotated object.
      Returns:
      The LIMS entity class.

    • batchCreate

      boolean batchCreate
      Flag indicating that the annotated entity can be created using a batch creation call.
      Returns:
      true if entities of the class can be created in batch, false if not.
      Default:
      false

    • batchUpdate

      boolean batchUpdate
      Flag indicating that the annotated entity can be updated using a batch update call.
      Returns:
      true if entities of the class can be updated in batch, false if not.
      Default:
      false