dk.netarkivet.harvester.webinterface
Enum HarvestStatusQuery.UI_FIELD

java.lang.Object
  java.lang.Enum<HarvestStatusQuery.UI_FIELD>
      dk.netarkivet.harvester.webinterface.HarvestStatusQuery.UI_FIELD

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HarvestStatusQuery.UI_FIELD>

Enclosing class:

HarvestStatusQuery

public static enum HarvestStatusQuery.UI_FIELD
extends java.lang.Enum<HarvestStatusQuery.UI_FIELD>

Defines the UI fields and their default values.

Enum Constant Summary

END_DATE
The harvest end date.

HARVEST_ID
The harvest ID.

HARVEST_NAME
harvest name.

HARVEST_RUN
The harvest Run number.

JOB_ID_ORDER
JOB ID order.

JOB_STATUS
jobstatus with default status STARTED.

PAGE_SIZE
The number of results on each page.

RESUBMIT_JOB_IDS
The number of Jobs to resubmit identified by ID.

START_DATE
The harvest start date.

START_PAGE_INDEX
The starting page.

Method Summary

java.lang.String	getValue(javax.servlet.ServletRequest req) Extracts the field's value from a servlet request.
java.lang.String[]	getValues(javax.servlet.ServletRequest req) Get the values stored in the request for this UI_FIELD.
static HarvestStatusQuery.UI_FIELD	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HarvestStatusQuery.UI_FIELD[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

JOB_STATUS

public static final HarvestStatusQuery.UI_FIELD JOB_STATUS

jobstatus with default status STARTED.

JOB_ID_ORDER

public static final HarvestStatusQuery.UI_FIELD JOB_ID_ORDER

JOB ID order. default is ascending.

HARVEST_NAME

public static final HarvestStatusQuery.UI_FIELD HARVEST_NAME

harvest name. default is ALL (i.e all harvests).

HARVEST_ID

public static final HarvestStatusQuery.UI_FIELD HARVEST_ID

The harvest ID. No default.

HARVEST_RUN

public static final HarvestStatusQuery.UI_FIELD HARVEST_RUN

The harvest Run number. No default.

START_DATE

public static final HarvestStatusQuery.UI_FIELD START_DATE

The harvest start date. No default.

END_DATE

public static final HarvestStatusQuery.UI_FIELD END_DATE

The harvest end date. No default.

PAGE_SIZE

public static final HarvestStatusQuery.UI_FIELD PAGE_SIZE

The number of results on each page. The default is read from the setting CommonSettings.HARVEST_STATUS_DFT_PAGE_SIZE.

START_PAGE_INDEX

public static final HarvestStatusQuery.UI_FIELD START_PAGE_INDEX

The starting page. Default is 1.

RESUBMIT_JOB_IDS

public static final HarvestStatusQuery.UI_FIELD RESUBMIT_JOB_IDS

The number of Jobs to resubmit identified by ID. No default.

Method Detail

values

public static HarvestStatusQuery.UI_FIELD[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HarvestStatusQuery.UI_FIELD c : HarvestStatusQuery.UI_FIELD.values())
    System.out.println(c);

Returns:

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

valueOf

public static HarvestStatusQuery.UI_FIELD valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValues

public java.lang.String[] getValues(javax.servlet.ServletRequest req)

Get the values stored in the request for this UI_FIELD.

Parameters:

req - the servlet request

Returns:

the values stored in the request for this UI_FIELD as a string array.

getValue

public java.lang.String getValue(javax.servlet.ServletRequest req)

Extracts the field's value from a servlet request. If the request does not define the paraeter's value, it is set to the default value.

Parameters:

req - a servlet request

Returns:

the field's value