Package com.apgar.common.lib.rules

Class CommonRules

java.lang.Object
com.apgar.common.lib.rules.CommonRules
public class CommonRules extends Object
This class allows to define common rules of the project.

It includes methods commonly used in triggers and in the implementation of business rules. These include:

  • Setting a record's meta data information
  • Setting a field's time and date
  • Getting the foreign key label for a record
  • Getting a path relative to its root
Author:
APGAR Consulting

  • Method Details

    • setTrackingMetaDataInformations

      public static Adaptation setTrackingMetaDataInformations(Adaptation record, ProcedureContext procedureContext, Session session, Path pathToParentSdlId, boolean isCreation) throws OperationException
      Allows setting the Meta Data Information in the Tracking tab depending on the type of flow.
      Parameters:
      record - Record updated
      procedureContext - ProcedureContext
      session - Session
      pathToParentSdlId - Path
      isCreation - True if record is being created
      Returns:
      Adaptation modified record
      Throws:
      OperationException - Exception

    • getUserWithSalutation

      public static String getUserWithSalutation(Repository repository, UserReference userReference, Locale locale)
      Gets the user with the salutation.
      Parameters:
      repository - Repository
      userReference - UserReference
      locale - Locale
      Returns:
      String User ID

    • setCurrentTime

      public static void setCurrentTime(ValueContextForUpdate pValue, Path pPath)
      Sets the date of the day.
      Parameters:
      pValue - ValueContextForUpdate
      pPath - Path the date will be set to

    • setCurrentDateTime

      public static void setCurrentDateTime(ValueContextForUpdate pValue, Path pPath)
      Sets the date and current hour, minute, and seconds.
      Parameters:
      pValue - ValueContextForUpdate
      pPath - Path the date will be set to

    • doesActiveIndicatorHaveToBeSet

      public static boolean doesActiveIndicatorHaveToBeSet(TriggerSetupContext context)
      Checks whether the Active Indicator needs to be set.
      Parameters:
      context - TriggerSetupContext
      Returns:
      boolean True if field needs to be set

    • setActiveIndicator

      public static void setActiveIndicator(ValueContextForUpdate vcfu)
      Sets the Active Indicator field.
      Parameters:
      vcfu - ValueContextForUpdate of the record the indicator will be set for

    • setTimeToZero

      public static Date setTimeToZero(Date date)
      Sets the time to zero for a given date.
      Parameters:
      date - Date where the time will be set to 0
      Returns:
      Date modified date

    • setMillisecondsToZero

      public static Date setMillisecondsToZero(Date date)
      Sets the milliseconds to zero for a given date.
      Parameters:
      date - Date where the milliseconds will be set to 0
      Returns:
      Date modified date

    • isActive

      public static boolean isActive(Adaptation record)
      Checks if Active Indicator is Active.
      Parameters:
      record - Adaptation
      Returns:
      true if Active Indicator is Active

    • getRelativePathToRoot

      public static Path getRelativePathToRoot(ValueContext pContext)
      Gets Relative Path To Root.
      Parameters:
      pContext - ValueContext
      Returns:
      Path the path relative to root

    • getRelativeParent

      public static Path getRelativeParent(Path pathInAdaptation)
      Retrieves the relative parent path of the given path. TODO: check it and check previous method for differences
      Parameters:
      pathInAdaptation - the path to determine the parent for.
      Returns:
      the relative parent path.

    • getFkLabel

      public static String getFkLabel(Adaptation currRecord, Path currPath, Session session)
      Gets foreign key label from record and path.
      Parameters:
      currRecord - Current Record
      currPath - Current Path
      session - Session
      Returns:
      String FK Label as a String