com.maxleap.code.LASClassManagerHook Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cloud-code-base Show documentation

There is a newer version: 2.4.9

package com.maxleap.code;


import com.maxleap.las.sdk.DeleteMsg;
import com.maxleap.las.sdk.SaveMsg;
import com.maxleap.las.sdk.UpdateMsg;

/**
 * The hooks for some db operation.
 */
public interface LASClassManagerHook {

  /**
   * hook before save
   *
   * @param entity operator object
   * @param userPrincipal userPrincipal
   * @return BeforeResult result of before create entity
   */
  BeforeResult beforeCreate(T entity, UserPrincipal userPrincipal);

  /**
   * hook after save
   *
   * @param beforeResult result of before create entity
   * @param saveMessage  result of create entity
   * @param userPrincipal userPrincipal
   * @return AfterResult result of after create entity
   */
  AfterResult afterCreate(BeforeResult beforeResult, SaveMsg saveMessage, UserPrincipal userPrincipal);

  /**
   * hook before delete
   *
   * @param objectId entity object id
   * @param userPrincipal userPrincipal
   * @return BeforeResult result of before delete entity
   */
  BeforeResult beforeDelete(String objectId, UserPrincipal userPrincipal);

  /**
   * hook before delete
   *
   * @param objectIds collection of entity objects id
   * @param userPrincipal userPrincipal
   * @return BeforeResult result of before delete some of entity object by id
   */
  BeforeResult beforeDelete(String[] objectIds, UserPrincipal userPrincipal);

  /**
   * hook after delete
   *
   * @param beforeResult  result of before delete entity
   * @param deleteMessage result of delete entity
   * @param userPrincipal userPrincipal
   * @return result of after delete entity
   */
  AfterResult afterDelete(BeforeResult beforeResult, DeleteMsg deleteMessage, UserPrincipal userPrincipal);

  /**
   * do something after completed update operation.
   *
   * @param objectId      object id of entity
   * @param updateMessage result of update entity
   * @param userPrincipal userPrincipal
   * @return result of after delete entity
   */
  AfterResult afterUpdate(String objectId, UpdateMsg updateMessage, UserPrincipal userPrincipal);


}