Package com.nuix.nx

Class NuixConnection

java.lang.Object

com.nuix.nx.NuixConnection

public class NuixConnection
extends java.lang.Object

This class provides a way to hand required Nuix objects over to the library for the methods that need them. In the least you will probably want to call setUtilities(Utilities) before using any of the classes in the com.nuix.nx.* package.

Constructor Summary

Constructors

Constructor	Description
NuixConnection()

Method Summary

Modifier and Type	Method	Description
static nuix.Case	getCurrentCase()	Get the Nuix case provided via setCurrentCase(Case)
static NuixVersion	getCurrentNuixVersion()	Gets a NuixVersion object representing the current version of Nuix, assuming code using the library has previously made a call to setCurrentNuixVersion(String) previously.
static nuix.Utilities	getUtilities()	Gets the instance of Utilities provided by previous call to setUtilities(Utilities)
static void	setCurrentCase(nuix.Case currentCase)	Set the Nuix case to be considered the "current" case
static void	setCurrentNuixVersion(java.lang.String version)	Sets the current Nuix version.
static void	setUtilities(nuix.Utilities utilities)	Sets the instance of Utilities for the current session.

Methods inherited from class java.lang.Object

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

Constructor Detail

NuixConnection

public NuixConnection()

Method Detail

getUtilities

public static nuix.Utilities getUtilities()

Gets the instance of Utilities provided by previous call to setUtilities(Utilities)

Returns:

Utilities instance provided by code using library, or null if setUtilities(Utilities) was not yet called

setUtilities

public static void setUtilities(nuix.Utilities utilities)

Sets the instance of Utilities for the current session. It is important to note that without making this call aspects of this library may fail with exceptions as they need to have an instance of Utilities to function. It is recommended that any code using this library call this shortly after loading the JAR file.

Parameters:

utilities - The Nuix Utilities object associated with the current session.

getCurrentCase

public static nuix.Case getCurrentCase()

Get the Nuix case provided via setCurrentCase(Case)

Returns:

The case previously provided or null if no case has been provided

setCurrentCase

public static void setCurrentCase(nuix.Case currentCase)

Set the Nuix case to be considered the "current" case

Parameters:

currentCase - The case to set as being the "current" case

setCurrentNuixVersion

public static void setCurrentNuixVersion(java.lang.String version)

Sets the current Nuix version. This may be used by library to detect features which are not available in a given version of Nuix.

Parameters:

version - A String containing the current Nuix version.

getCurrentNuixVersion

public static NuixVersion getCurrentNuixVersion()

Gets a NuixVersion object representing the current version of Nuix, assuming code using the library has previously made a call to setCurrentNuixVersion(String) previously.

Returns:

A NuixVersion if previously set by call to setCurrentNuixVersion(String), else null.