Package com.nuix.superutilities.cases

Class CaseHistoryHelper

  • All Implemented Interfaces:
    java.util.Iterator<nuix.HistoryEvent>
    public class CaseHistoryHelper
extends java.lang.Object
implements java.util.Iterator<nuix.HistoryEvent>
    Helper class for iterating a case's history. The reason for this class is mainly for the functionality to iterate multiple event types at once without having to iterate them all. Same functionality in API requires you either return all history event types or just a single type.

    • Constructor Summary

      Constructors 
      Constructor Description
      CaseHistoryHelper​(nuix.Case nuixCase, java.util.List<java.lang.String> eventTypes, org.joda.time.DateTime minStart, org.joda.time.DateTime maxStart)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static org.joda.time.DateTime getEarliestEventStart​(nuix.Case nuixCase)
      Convenience method for obtaining earliest case history event.
      static org.joda.time.DateTime getLatestEventStart​(nuix.Case nuixCase)
      Convenience method for obtaining most recent case history event.
      boolean hasNext()  
      nuix.HistoryEvent next()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface java.util.Iterator

        forEachRemaining, remove

    • Constructor Detail

      • CaseHistoryHelper

        public CaseHistoryHelper​(nuix.Case nuixCase,
                         java.util.List<java.lang.String> eventTypes,
                         org.joda.time.DateTime minStart,
                         org.joda.time.DateTime maxStart)
                  throws java.lang.Exception
        Throws:
        java.lang.Exception

    • Method Detail

      • hasNext

        public boolean hasNext()
        Specified by:
        hasNext in interface java.util.Iterator<nuix.HistoryEvent>

      • next

        public nuix.HistoryEvent next()
        Specified by:
        next in interface java.util.Iterator<nuix.HistoryEvent>

      • getEarliestEventStart

        public static org.joda.time.DateTime getEarliestEventStart​(nuix.Case nuixCase)
                                                    throws java.lang.Exception
        Convenience method for obtaining earliest case history event.
        Parameters:
        nuixCase - Case to obtain history event from
        Returns:
        Earliest case history event
        Throws:
        java.lang.Exception - Thrown if an error occurs

      • getLatestEventStart

        public static org.joda.time.DateTime getLatestEventStart​(nuix.Case nuixCase)
                                                  throws java.lang.Exception
        Convenience method for obtaining most recent case history event.
        Parameters:
        nuixCase - Case to obtain history event from
        Returns:
        Earliest case history event
        Throws:
        java.lang.Exception - Thrown if an error occurs