public class AttachmentResultDataBean extends SmartDataBeanImpl
AttachmentDataBean
.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASSNAME
Define the CLASSNAME.
|
emptyString
Constructor and Description |
---|
AttachmentResultDataBean() |
Modifier and Type | Method and Description |
---|---|
AttachmentDataBean |
getAttachmentDataBeanAt(int index)
Gets the specific data bean at the passed index within the array of data beans returned,
represented by a
AttachmentDataBean object. |
java.util.Vector |
getAttachmentId()
Gets the vector containing the attachment IDs.
|
AttachmentDataBean[] |
getAttachmentList()
Gets the list of data beans found from the browse or search tool, represented by an array of
AttachmentDataBean object. |
java.lang.String |
getDirectoryId()
Gets the directory Id.
|
java.lang.String |
getErrorCode()
Gets the error code.
|
java.lang.String |
getInClauseForDirectoryIds(java.lang.String aStoreDirectoryName)
Gets the "in clause" for the directory ids for the search SQL.
|
java.lang.String |
getIndexBegin()
Gets the beginning index into the search results
|
java.lang.String |
getIndexEnd()
Gets the end index into the search results
|
int |
getListSize()
Gets the size of the list of
AttachmentDataBean . |
java.lang.Long |
getOwner()
Gets the member Id of the store.
|
java.lang.String[] |
getResultList()
Gets the array containing the name of the files.
|
int |
getResultSetSize()
Gets the total number of entries found.
|
java.lang.String |
getSearchDescription()
Gets the string used for the search on the description field.
|
java.lang.String |
getSearchLanguageId()
Gets the language ID used to search for the language dependent short description.
|
java.lang.String |
getSearchName()
Gets the string to search for the file name.
|
java.lang.String |
getSearchType()
Sets the string used for the search to restrict the type of assets.
|
java.lang.String |
getTool()
Gets the tool used to display the attachments: search or browse.
|
boolean |
isCorruptedManagedFile()
Gets if the file is a duplicate file across workspaces.
|
void |
populate()
Populates the databean based on inputs received from the UI.
|
void |
setCorruptedManagedFile(boolean hasCorruptedManagedFile)
Sets to indicate if the file is a duplicate file across workspaces.
|
void |
setDirectoryId(java.lang.String string)
Sets the directory Id.
|
void |
setErrorCode(java.lang.String anErrorCode)
Sets the error code.
|
void |
setIndexBegin(java.lang.String newIndexBegin)
Sets the starting index of the result items.
|
void |
setIndexEnd(java.lang.String newIndexEnd)
Sets the end index of the result items.
|
void |
setParm(java.lang.String para,
java.lang.String value)
Sets some parameters.
|
void |
setResultSetSize(int newResultSetSize)
Sets the total number of entries found.
|
void |
setSearchDescription(java.lang.String string)
Sets the string to search on the description field.
|
void |
setSearchLanguageId(java.lang.String string)
Sets the language ID used to search for the language dependent short description.
|
void |
setSearchName(java.lang.String string)
Sets the string to search for the file name.
|
void |
setSearchType(java.lang.String string)
Sets the string used to perform a search restricted to the type of assets.
|
void |
setTool(java.lang.String string)
Sets the tool used to display the attachments: search or browse.
|
fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext
getRequestProperties, setRequestProperties
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getRequestProperties, setRequestProperties
public static final java.lang.String CLASSNAME
public int getListSize()
AttachmentDataBean
.AttachmentDataBean
.public java.lang.String[] getResultList()
public java.util.Vector getAttachmentId()
public AttachmentDataBean[] getAttachmentList()
AttachmentDataBean
object.AttachmentDataBean
object.public AttachmentDataBean getAttachmentDataBeanAt(int index) throws java.lang.ArrayIndexOutOfBoundsException
AttachmentDataBean
object. If the index is larger than
the size of the array, an ArrayIndexOutOfBoundsException
is thrown.index
- The index of the result array.AttachmentDataBean
object.java.lang.ArrayIndexOutOfBoundsException
- Thrown when access an array with an out of bound index.public java.lang.Long getOwner() throws java.lang.Exception
java.lang.Exception
public void populate() throws java.lang.Exception
com.ibm.commerce.tools.attachment.beans.AttachmentDataBean
.populate
in interface SmartDataBean
populate
in class SmartDataBeanImpl
java.lang.Exception
public java.lang.String getInClauseForDirectoryIds(java.lang.String aStoreDirectoryName)
aStoreDirectoryName
- The store directory namepublic java.lang.String getIndexBegin()
public java.lang.String getIndexEnd()
public java.lang.String getDirectoryId()
public void setDirectoryId(java.lang.String string)
string
- The directory Id.public java.lang.String getSearchName()
public int getResultSetSize()
public void setResultSetSize(int newResultSetSize)
The
- size of the result set.public void setSearchName(java.lang.String string)
string
- The string to search for the file name.public java.lang.String getTool()
public void setTool(java.lang.String string)
string
- The tool used to do the search. The possible values should be: search and browser.public void setParm(java.lang.String para, java.lang.String value)
para
- The parameter to set. There are 3 values: orderby,endindex,startindex.value
- The value to assign to the parameter para.public java.lang.String getSearchDescription()
public java.lang.String getSearchType()
public void setSearchDescription(java.lang.String string)
string
- The string used to search on the description field.public void setSearchType(java.lang.String string)
string
- The string used for the search to restrict the type of assets.public void setIndexBegin(java.lang.String newIndexBegin)
newIndexBegin
- The starting index.public void setIndexEnd(java.lang.String newIndexEnd)
newIndexEnd
- The end index.public java.lang.String getSearchLanguageId()
public void setSearchLanguageId(java.lang.String string)
string
- The language ID against which we will search for the short description.public boolean isCorruptedManagedFile()
public void setCorruptedManagedFile(boolean hasCorruptedManagedFile)
hasCorruptedManagedFile
- The isCorruptedManagedFile flag to set: true or false.public java.lang.String getErrorCode()
public void setErrorCode(java.lang.String anErrorCode)
isCorruptedManagedFile()
returns true
.anErrorCode
- The error code.