com.ibm.commerce.tools.contract.beans
Class PolicyListDataBean

java.lang.Object
  |
  +--com.ibm.commerce.beans.InputDataBeanImpl
        |
        +--com.ibm.commerce.beans.SmartDataBeanImpl
              |
              +--com.ibm.commerce.tools.contract.beans.PolicyListDataBean
All Implemented Interfaces:
DataBean, InputDataBean, java.io.Serializable, SmartDataBean

public class PolicyListDataBean
extends SmartDataBeanImpl

List the business policies in a store

See Also:
Serialized Form

Field Summary
protected  java.lang.String _findBy
           
protected  java.lang.String _orderBy
           
protected   PolicyDataBean[] _policyList
           
protected  java.lang.String _policyName
           
protected  java.lang.String _policyType
           
protected  java.lang.Long _tc
           
static java.lang.String FIND_BY_NAME_TYPE_STORE
          Find by constants
static java.lang.String FIND_BY_STORE_ENTITY
          Find by constants
static java.lang.String FIND_BY_TC
          Find by constants
static java.lang.String FIND_BY_TC_TYPE
          Find by constants
static java.lang.String FIND_BY_TYPE_STORE
          Find by constants
static java.lang.String FIND_BY_TYPE_STORE_ENTITY
          Find by constants
static java.lang.String ORDER_BY_NAME
          Order by constants
static java.lang.String ORDER_BY_STORE_ENTITY
          Order by constants
static java.lang.String ORDER_BY_TYPE
          Order by constants
static java.lang.String PARAMETER_FIND_BY
          NVP constants
static java.lang.String PARAMETER_ORDER_BY
          NVP constants
static java.lang.String TYPE_INVOICE_FORMAT
          Policy type constants
static java.lang.String TYPE_PAYMENT
          Policy type constants
static java.lang.String TYPE_PRICE
          Policy type constants
static java.lang.String TYPE_PRODUCT_SET
          Policy type constants
static java.lang.String TYPE_RETURN_APPROVAL
          Policy type constants
static java.lang.String TYPE_RETURN_CHARGE
          Policy type constants
static java.lang.String TYPE_RETURN_PAYMENT
          Policy type constants
static java.lang.String TYPE_SHIPPING_CHARGE
          Policy type constants
static java.lang.String TYPE_SHIPPING_MODE
          Policy type constants
 
Fields inherited from class com.ibm.commerce.beans. SmartDataBeanImpl
commandContext, COPYRIGHT
 
Fields inherited from class com.ibm.commerce.beans. InputDataBeanImpl
requestProperties
 
Fields inherited from interface com.ibm.commerce.beans. DataBean
emptyString
 
Constructor Summary
PolicyListDataBean()
           
 
Method Summary
  PolicyDataBean[] getPolicyList()
          Get the list of policies in the store
protected  java.lang.Integer getStoreId()
          Returns the storeId property of the Bean
 void populate()
          Populates the databean with elements.
 void setFindBy(java.lang.String findBy)
          Set the findBy type of policy to find.
 void setOrderBy(java.lang.String orderBy)
          Set the orderBy type of policy to find.
 void setPolicyName(java.lang.String policyName)
          Set the name of the policy to find
 void setPolicyType(java.lang.String policyType)
          Set the type of the policies to find
 void setStoreId(java.lang.Integer storeId)
          Sets the Store ID for which the list of usable Policies are requested.
 void setTC(java.lang.Long tc)
          Set the term and condition identifier of the policy to find
 
Methods inherited from class com.ibm.commerce.beans. SmartDataBeanImpl
fulfills, getCommandContext, getResources, setCommandContext
 
Methods inherited from class com.ibm.commerce.beans. InputDataBeanImpl
getRequestProperties, setRequestProperties
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.beans. InputDataBean
getRequestProperties, setRequestProperties
 

Field Detail

PARAMETER_ORDER_BY

public static final java.lang.String PARAMETER_ORDER_BY
NVP constants
See Also:
Constant Field Values

PARAMETER_FIND_BY

public static final java.lang.String PARAMETER_FIND_BY
NVP constants
See Also:
Constant Field Values

FIND_BY_TYPE_STORE

public static final java.lang.String FIND_BY_TYPE_STORE
Find by constants
See Also:
Constant Field Values

FIND_BY_NAME_TYPE_STORE

public static final java.lang.String FIND_BY_NAME_TYPE_STORE
Find by constants
See Also:
Constant Field Values

FIND_BY_STORE_ENTITY

public static final java.lang.String FIND_BY_STORE_ENTITY
Find by constants
See Also:
Constant Field Values

FIND_BY_TC

public static final java.lang.String FIND_BY_TC
Find by constants
See Also:
Constant Field Values

FIND_BY_TC_TYPE

public static final java.lang.String FIND_BY_TC_TYPE
Find by constants
See Also:
Constant Field Values

FIND_BY_TYPE_STORE_ENTITY

public static final java.lang.String FIND_BY_TYPE_STORE_ENTITY
Find by constants
See Also:
Constant Field Values

TYPE_PRICE

public static final java.lang.String TYPE_PRICE
Policy type constants
See Also:
Constant Field Values

TYPE_PAYMENT

public static final java.lang.String TYPE_PAYMENT
Policy type constants
See Also:
Constant Field Values

TYPE_SHIPPING_MODE

public static final java.lang.String TYPE_SHIPPING_MODE
Policy type constants
See Also:
Constant Field Values

TYPE_SHIPPING_CHARGE

public static final java.lang.String TYPE_SHIPPING_CHARGE
Policy type constants
See Also:
Constant Field Values

TYPE_RETURN_CHARGE

public static final java.lang.String TYPE_RETURN_CHARGE
Policy type constants
See Also:
Constant Field Values

TYPE_INVOICE_FORMAT

public static final java.lang.String TYPE_INVOICE_FORMAT
Policy type constants
See Also:
Constant Field Values

TYPE_PRODUCT_SET

public static final java.lang.String TYPE_PRODUCT_SET
Policy type constants
See Also:
Constant Field Values

TYPE_RETURN_PAYMENT

public static final java.lang.String TYPE_RETURN_PAYMENT
Policy type constants
See Also:
Constant Field Values

TYPE_RETURN_APPROVAL

public static final java.lang.String TYPE_RETURN_APPROVAL
Policy type constants
See Also:
Constant Field Values

ORDER_BY_NAME

public static final java.lang.String ORDER_BY_NAME
Order by constants
See Also:
Constant Field Values

ORDER_BY_STORE_ENTITY

public static final java.lang.String ORDER_BY_STORE_ENTITY
Order by constants
See Also:
Constant Field Values

ORDER_BY_TYPE

public static final java.lang.String ORDER_BY_TYPE
Order by constants
See Also:
Constant Field Values

_policyList

protected PolicyDataBean[] _policyList

_policyType

protected java.lang.String _policyType

_policyName

protected java.lang.String _policyName

_tc

protected java.lang.Long _tc

_findBy

protected java.lang.String _findBy

_orderBy

protected java.lang.String _orderBy
Constructor Detail

PolicyListDataBean

public PolicyListDataBean()
Method Detail

getPolicyList

public PolicyDataBean[] getPolicyList()
Get the list of policies in the store
Returns:
PolicyDataBean[]

getStoreId

protected java.lang.Integer getStoreId()
Returns the storeId property of the Bean
Returns:
the Store ID

populate

public void populate()
              throws java.lang.Exception
Description copied from class: SmartDataBeanImpl
Populates the databean with elements.
Specified by:
populate in interface SmartDataBean
Overrides:
populate in class SmartDataBeanImpl
Throws:
java.lang.Exception - should not happen since there is no data retrieved to populate the databean.

setPolicyName

public void setPolicyName(java.lang.String policyName)
Set the name of the policy to find
Parameters:
policyName - String

setPolicyType

public void setPolicyType(java.lang.String policyType)
Set the type of the policies to find
Parameters:
policyType - String

setStoreId

public void setStoreId(java.lang.Integer storeId)
Sets the Store ID for which the list of usable Policies are requested.
Parameters:
storeId - the Store ID.

setTC

public void setTC(java.lang.Long tc)
Set the term and condition identifier of the policy to find
Parameters:
tc - Long

setFindBy

public void setFindBy(java.lang.String findBy)
Set the findBy type of policy to find. This can either be set explicitly using this setter, or read from the request properties
Parameters:
findBy - String

setOrderBy

public void setOrderBy(java.lang.String orderBy)
Set the orderBy type of policy to find. This can either be set explicitly using this setter, or read from the request properties
Parameters:
orderBy - String