OrderListState (ofbiz API)

java.lang.Object
- org.apache.ofbiz.order.order.OrderListState

All Implemented Interfaces:

Serializable
```
public class OrderListState
extends Object
implements Serializable
```
Session object for keeping track of the list of orders. The state of the list is preserved here instead of via url parameters, which can get messy. There are three types of state: Order State, Order Type, and pagination position. Also provides convenience methods for retrieving the right set of data for a particular state. TODO: this can be generalized to use a set of State objects, including Pagination. Think about design patterns in Fowler.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`module`
`protected Map<String,String>`	`orderFilterState`
`protected int`	`orderListSize`
`protected Map<String,String>`	`orderStatusState`
`protected Map<String,String>`	`orderTypeState`
`protected static Map<String,String>`	`parameterToFilterId`
`protected static Map<String,String>`	`parameterToOrderStatusId`
`protected static Map<String,String>`	`parameterToOrderTypeId`
`static String`	`SESSION_KEY`
`static String`	`VIEW_INDEX_PARAM`
`static String`	`VIEW_SIZE_PARAM`
`protected int`	`viewIndex`
`protected int`	`viewSize`

Constructor Summary

Constructors
Modifier Constructor and Description

protected OrderListState()
Initializes the order list state with default values.

Constructors
Modifier	Constructor and Description
`protected`	`OrderListState()` Initializes the order list state with default values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static OrderListState`	`getInstance(HttpServletRequest request)` Retrieves the current user's OrderListState from the session or creates a new one with defaults.
`Map<String,String>`	`getorderFilterState()`
`List<GenericValue>`	`getOrders(String facilityId, Timestamp filterDate, Delegator delegator)` Get the OrderHeaders corresponding to the state.
`Map<String,String>`	`getOrderStatusState()`
`Map<String,String>`	`getOrderTypeState()`
`int`	`getSize()`
`int`	`getViewIndex()`
`int`	`getViewSize()`
`boolean`	`hasAllStatus()`
`boolean`	`hasFilter(String param)`
`boolean`	`hasNext()`
`boolean`	`hasPrevious()`
`boolean`	`hasStatus(String param)`
`boolean`	`hasType(String param)`
`void`	`setStatus(String param, boolean b)`
`void`	`setType(String param, boolean b)`
`String`	`toString()`
`void`	`update(HttpServletRequest request)` Given a request, decides what state to change.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

module
```
public static final String module
```

SESSION_KEY
```
public static final String SESSION_KEY
```
See Also:

Constant Field Values

VIEW_SIZE_PARAM

public static final String VIEW_SIZE_PARAM

See Also:: Constant Field Values

VIEW_INDEX_PARAM

public static final String VIEW_INDEX_PARAM

See Also:: Constant Field Values

viewSize
```
protected int viewSize
```

viewIndex
```
protected int viewIndex
```

orderStatusState

protected Map<String,String> orderStatusState

orderTypeState

protected Map<String,String> orderTypeState

orderFilterState

protected Map<String,String> orderFilterState

orderListSize
```
protected int orderListSize
```

parameterToOrderStatusId

protected static final Map<String,String> parameterToOrderStatusId

parameterToOrderTypeId

protected static final Map<String,String> parameterToOrderTypeId

parameterToFilterId

protected static final Map<String,String> parameterToFilterId

Constructor Detail
- OrderListState
```
protected OrderListState()
```
  Initializes the order list state with default values. Do not use directly, instead use getInstance().

Method Detail

getInstance
```
public static OrderListState getInstance(HttpServletRequest request)
```
Retrieves the current user's OrderListState from the session or creates a new one with defaults.

update
```
public void update(HttpServletRequest request)
```
Given a request, decides what state to change. If a parameter changeStatusAndTypeState is present with value "Y", the status and type state will be updated. Otherwise, if the viewIndex and viewSize parameters are present, the pagination changes.

getOrderStatusState

public Map<String,String> getOrderStatusState()

getOrderTypeState

public Map<String,String> getOrderTypeState()

getorderFilterState

public Map<String,String> getorderFilterState()

setStatus

public void setStatus(String param,
                      boolean b)

setType

public void setType(String param,
                    boolean b)

hasStatus

public boolean hasStatus(String param)

hasType
```
public boolean hasType(String param)
```

hasFilter

public boolean hasFilter(String param)

hasAllStatus
```
public boolean hasAllStatus()
```

getViewSize
```
public int getViewSize()
```

getViewIndex
```
public int getViewIndex()
```

getSize
```
public int getSize()
```

hasPrevious
```
public boolean hasPrevious()
```

hasNext
```
public boolean hasNext()
```

getOrders

public List<GenericValue> getOrders(String facilityId,
                                    Timestamp filterDate,
                                    Delegator delegator)
                             throws GenericEntityException

Get the OrderHeaders corresponding to the state.

Throws:: GenericEntityException

toString
```
public String toString()
```
Overrides:

toString in class Object

Class OrderListState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

module

SESSION_KEY

VIEW_SIZE_PARAM

VIEW_INDEX_PARAM

viewSize

viewIndex

orderStatusState

orderTypeState

orderFilterState

orderListSize

parameterToOrderStatusId

parameterToOrderTypeId

parameterToFilterId

Constructor Detail

OrderListState

Method Detail

getInstance

update

getOrderStatusState

getOrderTypeState

getorderFilterState

setStatus

setType

hasStatus

hasType

hasFilter

hasAllStatus

getViewSize

getViewIndex

getSize

hasPrevious

hasNext

getOrders

toString