Package com.jbstrap.core.cache

Enum Class TempDataExportCache

java.lang.Object

java.lang.Enum<TempDataExportCache>

com.jbstrap.core.cache.TempDataExportCache

All Implemented Interfaces:

Serializable, Comparable<TempDataExportCache>, Constable

public enum TempDataExportCache
extends Enum<TempDataExportCache>

Since:

4.0

Author:

JBStrap

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
String	addExportData(ExportTypes exportType, String filename, DataDescriptor dataDescriptor, Criteria criteria, List<Order> orders, List<String> columnNames, String clientId, String languageCode, char separator)
String	getClientId(String id)
List<String>	getColumnNames(String id)
Criteria	getCriteria(String id)
DataDescriptor	getDataDescriptor(String id)
ExportTypes	getExportType(String id)
String	getFilename(String id)
String	getLanguageCode(String id)
List<Order>	getOrders(String id)
char	getSeparator(String id)
void	remove(String id)
static TempDataExportCache	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TempDataExportCache[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final TempDataExportCache INSTANCE

Method Details

values

public static TempDataExportCache[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TempDataExportCache valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

addExportData

public String addExportData(ExportTypes exportType,
 String filename,
 DataDescriptor dataDescriptor,
 Criteria criteria,
 List<Order> orders,
 List<String> columnNames,
 String clientId,
 String languageCode,
 char separator)

Parameters:

exportType - The export type ExportTypes

filename - the output filename (The downloadable filename)

dataDescriptor - The DataDescriptor to be exported DataDescriptor

criteria - The filtering criteria to be used on the DataDescriptor during the export process. The only lines that get exported, are those that follow the specified Criteria

orders - The Order to be used during the export process

columnNames - The list of the names of the columns that are to be exported

clientId - The ID of the client, where the exported file will need to be downloaded to

languageCode - The client's language code

separator - The data separator character, which needs to be specified if the output file is a text file

Returns:

A exportálás egyedi azonosítója The export ID

Throws:

NullPointerException - If the export type, DataDescriptor or Client ID are null

getExportType

public ExportTypes getExportType(String id)

Parameters:

id - The export's ID

Returns:

The export type or null null, if not found

Throws:

NullPointerException - If the specified ID is null

See Also:

• ExportTypes

getFilename

public String getFilename(String id)

Parameters:

id - The export ID

Returns:

The output filename or null, if not found

Throws:

NullPointerException - If the specified ID is null

getDataDescriptor

public DataDescriptor getDataDescriptor(String id)

Parameters:

id - The export ID

Returns:

The DataDescriptor used for the exporting or null, if not found

Throws:

NullPointerException - If the specified ID is null

See Also:

• DataDescriptor

getCriteria

public Criteria getCriteria(String id)

Parameters:

id - The export ID

Returns:

The filter Criteria instance or null, if not found

Throws:

NullPointerException - If the specified ID is null

getOrders

public List<Order> getOrders(String id)

Parameters:

id - The export id

Returns:

The list of orders used for the exporting process or null, if not found

Throws:

NullPointerException - If the specified ID is null

See Also:

• Order

getColumnNames

public List<String> getColumnNames(String id)

Parameters:

id - The export ID

Returns:

A list of column names used in the export or null, if not found

Throws:

NullPointerException - If the specified ID is null

getClientId

public String getClientId(String id)

Parameters:

id - The export ID

Returns:

The client id or null, if not found

getLanguageCode

public String getLanguageCode(String id)

Parameters:

id - The export ID

Returns:

The language code or null, if not found

Throws:

NullPointerException - If the specified ID is null

getSeparator

public char getSeparator(String id)

Parameters:

id - The export ID

Returns:

The separator character or null, if not found

Throws:

NullPointerException - If the specified id is null

remove

public void remove(String id)

Parameters:

id - The export ID