public class ContractListDataBean
extends com.ibm.commerce.tools.util.CommonSearchHelperBean
implements com.ibm.commerce.security.Protectable, com.ibm.commerce.security.Delegator
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ORDER_BY_DESCRIPTION
orderby parameter values
|
static java.lang.String |
ORDER_BY_END_DATE
orderby parameter values
|
static java.lang.String |
ORDER_BY_NAME
orderby parameter values
|
static java.lang.String |
ORDER_BY_START_DATE
orderby parameter values
|
static java.lang.String |
ORDER_BY_STATE
orderby parameter values
|
static java.lang.String |
ORDER_BY_STORE_NAME
orderby parameter values
|
static java.lang.String |
ORDER_BY_STORE_STATE
orderby parameter values
|
static java.lang.String |
ORDER_BY_VERSION
orderby parameter values
|
static java.lang.String |
TYPE_EXACT
TYPE_EXACT pattern match constant
|
static java.lang.String |
TYPE_LIKE
TYPE_LIKE pattern match constant
|
Constructor and Description |
---|
ContractListDataBean()
Constructs an ContractListDataBean
|
ContractListDataBean(java.lang.Long newAccount,
java.lang.String newOrder,
java.lang.String newState)
Constructs a ContractListDataBean from an existing account identifier
Find the Contracts in an account
|
ContractListDataBean(java.lang.Long newAccount,
java.lang.String newLanguage,
java.lang.String newOrder,
java.lang.String newState,
java.lang.String newStoreID,
int newUsage)
Constructs a ContractListDataBean from an existing account identifier
Find the Contracts in an account
|
ContractListDataBean(java.lang.String newOrder,
java.lang.String newState)
Constructs an ContractListDataBean for Distributors and Hosted Stores
Find all of the Distributor Contracts
|
ContractListDataBean(java.lang.String newLanguage,
java.lang.String newOrder,
java.lang.String newState,
java.lang.String newStoreID,
int newUsage)
Constructs an ContractListDataBean for Distributors and Hosted Stores
Find all of the Distributor Contracts
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
buildQuery()
Constructs the database query
|
void |
buildResultDataBean(java.util.Vector resultVector)
Constructs the list of data beans
|
java.lang.Long |
getAccountId()
Gets the accountId
|
boolean |
getAllAccounts()
Gets the all accounts parameter.
|
ContractDataBean[] |
getContractList()
Gets the list of entries that were found
|
ContractDataBean |
getContractListData(int index)
Gets a specific entry that was found
|
java.lang.String |
getDefaultLanguageID()
Returns the default language ID.
|
com.ibm.commerce.security.Protectable |
getDelegate()
Returns the access control delegate of this data bean.
|
java.lang.String |
getLanguageID()
Returns the language ID.
|
int |
getNumberOfContracts()
Gets the number of contracts returned.
|
java.lang.String |
getOrderByParameter()
Gets the orderBy parameter.
|
java.lang.Long |
getOwner()
Gets the owner of the contract.
|
java.lang.String |
getSearchDesc()
Gets the search description parameter.
|
java.lang.String |
getSearchDescFilter()
Gets the search description filter parameter
|
java.lang.String |
getSearchName()
Gets the search name parameter.
|
java.lang.String |
getSearchNameFilter()
Gets the search name filter parameter.
|
java.lang.String |
getSearchStoreName()
Gets the search store name parameter.
|
java.lang.String |
getSearchStoreNameFilter()
Gets the search store name filter parameter.
|
java.lang.String |
getStateParameter()
Gets the state parameter.
|
java.lang.String |
getStoreID()
Returns the store ID.
|
java.lang.String |
getType()
Gets the type of contracts to list.
|
int |
getUsage()
Gets the usage of the contracts to list.
|
void |
setAccountId(java.lang.Long newAccountId)
Sets the account ID.
|
void |
setAllAccounts(boolean allAccounts)
Sets whether or not contracts are to be listed from all of the accounts.
|
void |
setContractList(java.util.Vector newContractList)
Set the list of results found
|
void |
setDefaultLanguageID(java.lang.String defaultLanguageID)
Sets the default language ID.
|
void |
setLanguageID(java.lang.String languageID)
Sets the language ID.
|
void |
setNumberOfContracts(int numberOfContracts)
Sets the number of contracts returned.
|
void |
setOrderByParameter(java.lang.String orderByParameter)
Sets the orderBy parameter.
|
void |
setSearchDesc(java.lang.String searchDesc)
Sets the search description parameter.
|
void |
setSearchDescFilter(java.lang.String searchDescFilter)
Sets the search description filter parameter
|
void |
setSearchName(java.lang.String searchName)
Sets the search name parameter.
|
void |
setSearchNameFilter(java.lang.String searchNameFilter)
Sets the search name filter parameter
|
void |
setSearchStoreName(java.lang.String searchStoreName)
Sets the search store name parameter.
|
void |
setSearchStoreNameFilter(java.lang.String searchStoreNameFilter)
Sets the search store name filter parameter.
|
void |
setStateParameter(java.lang.String stateParameter)
Sets the state parameter.
|
void |
setStoreID(java.lang.String storeID)
Sets the store ID.
|
void |
setType(java.lang.String type)
Sets the type of contracts to list.
|
void |
setUsage(int usage)
Sets the usage of the contracts to list.
|
escapeSQLstring, getDefaultLanguageId, getIndexBegin, getIndexEnd, getLanguageId, getListSize, getResultList, getResultSetSize, getStoreId, getStoreIds, getStoreIdsInEntityType, getStoreRelType, getUpperCaseFunction, getUseCursor, populate, setIndexBegin, setIndexEnd, setLanguageId, setResultList, setResultSetSize, setStoreId, setStoreIds, setStoreIdsInEntityType, setStoreRelType, setUseCursor
fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext
getRequestProperties, setRequestProperties
public static final java.lang.String ORDER_BY_DESCRIPTION
public static final java.lang.String ORDER_BY_END_DATE
public static final java.lang.String ORDER_BY_NAME
public static final java.lang.String ORDER_BY_START_DATE
public static final java.lang.String ORDER_BY_STATE
public static final java.lang.String ORDER_BY_STORE_NAME
public static final java.lang.String ORDER_BY_STORE_STATE
public static final java.lang.String ORDER_BY_VERSION
public static final java.lang.String TYPE_EXACT
public static final java.lang.String TYPE_LIKE
public ContractListDataBean()
public ContractListDataBean(java.lang.Long newAccount, java.lang.String newOrder, java.lang.String newState)
newAccount
- an existing account identifiernewOrder
- the column parameter in which to order the datanewState
- the contracts to find should have this statepublic ContractListDataBean(java.lang.Long newAccount, java.lang.String newLanguage, java.lang.String newOrder, java.lang.String newState, java.lang.String newStoreID, int newUsage)
newAccount
- an existing account identifiernewLanguage
- the language for descriptions to be shown and search to take place innewOrder
- the column parameter in which to order the datanewState
- the contracts to find should have this statenewStoreID
- the identifier of the store to which the contracts belongnewUsage
- the type of contracts to be listedpublic ContractListDataBean(java.lang.String newOrder, java.lang.String newState)
newOrder
- the column parameter in which to order the datanewState
- the contracts to find should have this statepublic ContractListDataBean(java.lang.String newLanguage, java.lang.String newOrder, java.lang.String newState, java.lang.String newStoreID, int newUsage)
newLanguage
- the language for descriptions to be shown and search to take place innewOrder
- the column parameter in which to order the datanewState
- the contracts to find should have this statenewStoreID
- the identifier of the store to which the contracts belongnewUsage
- the type of contracts to be listedpublic java.lang.String buildQuery() throws java.lang.Exception
buildQuery
in class com.ibm.commerce.tools.util.CommonSearchHelperBean
java.lang.Exception
public void buildResultDataBean(java.util.Vector resultVector)
buildResultDataBean
in class com.ibm.commerce.tools.util.CommonSearchHelperBean
resultVector
- the result vector returned from the query executionpublic java.lang.Long getAccountId()
public boolean getAllAccounts()
public ContractDataBean[] getContractList()
public ContractDataBean getContractListData(int index) throws java.lang.ArrayIndexOutOfBoundsException
index
- the index of the result arrayjava.lang.ArrayIndexOutOfBoundsException
public java.lang.String getDefaultLanguageID()
public com.ibm.commerce.security.Protectable getDelegate() throws java.lang.Exception
getDelegate
in interface com.ibm.commerce.security.Delegator
java.lang.Exception
public java.lang.String getLanguageID()
public int getNumberOfContracts()
public java.lang.String getOrderByParameter()
public java.lang.Long getOwner() throws java.lang.Exception
getOwner
in interface com.ibm.commerce.security.Protectable
raised
- when there is a remote exceptionraised
- when there is any exceptionjava.lang.Exception
public java.lang.String getSearchDesc()
public java.lang.String getSearchDescFilter()
public java.lang.String getSearchName()
public java.lang.String getSearchNameFilter()
public java.lang.String getSearchStoreName()
public java.lang.String getSearchStoreNameFilter()
public java.lang.String getStateParameter()
public java.lang.String getStoreID()
public java.lang.String getType()
public int getUsage()
public void setAccountId(java.lang.Long newAccountId)
newAccountId
- the accountId to setpublic void setAllAccounts(boolean allAccounts)
allAccounts
- contracts are to be listed from all the accounts when set to truepublic void setContractList(java.util.Vector newContractList)
newContractList
- the result listpublic void setDefaultLanguageID(java.lang.String defaultLanguageID)
defaultLanguageID
- The defaultLanguageID to setpublic void setLanguageID(java.lang.String languageID)
languageID
- The languageID to setpublic void setNumberOfContracts(int numberOfContracts)
numberOfContracts
- the number of contracts to setpublic void setOrderByParameter(java.lang.String orderByParameter)
orderByParameter
- the orderByParameter to setpublic void setSearchDesc(java.lang.String searchDesc)
searchDesc
- the short description search parameter to setpublic void setSearchDescFilter(java.lang.String searchDescFilter)
searchDescFilter
- sets the short description search filterpublic void setSearchName(java.lang.String searchName)
searchName
- The searchName to setpublic void setSearchNameFilter(java.lang.String searchNameFilter)
searchNameFilter
- sets the name search filterpublic void setSearchStoreName(java.lang.String searchStoreName)
searchStoreName
- the searchStoreName to setpublic void setSearchStoreNameFilter(java.lang.String searchStoreNameFilter)
searchStoreNameFilter
- sets the store name search filterpublic void setStateParameter(java.lang.String stateParameter)
stateParameter
- the stateParameter to setpublic void setStoreID(java.lang.String storeID)
storeID
- The storeID to setpublic void setType(java.lang.String type)
type
- the type to setpublic void setUsage(int usage)
usage
- The usage to set