com.ibm.commerce.tools.attachment.beans

Class AttachmentResultDataBean

    • Field Detail

      • CLASSNAME

        public static final java.lang.String CLASSNAME
        Define the CLASSNAME.
        See Also:
        Constant Field Values
    • Constructor Detail

      • AttachmentResultDataBean

        public AttachmentResultDataBean()
    • Method Detail

      • getListSize

        public int getListSize()
        Gets the size of the list of AttachmentDataBean.
        Returns:
        The size of the list of AttachmentDataBean.
      • getResultList

        public java.lang.String[] getResultList()
        Gets the array containing the name of the files.
        Returns:
        The array containing the name of the files.
      • getAttachmentId

        public java.util.Vector getAttachmentId()
        Gets the vector containing the attachment IDs.
        Returns:
        The vector containing the attachment ID. This is used in UI for the check box.
      • getAttachmentList

        public AttachmentDataBean[] getAttachmentList()
        Gets the list of data beans found from the browse or search tool, represented by an array of AttachmentDataBean object.
        Returns:
        The list of AttachmentDataBean object.
      • getAttachmentDataBeanAt

        public AttachmentDataBean getAttachmentDataBeanAt(int index)
                                                   throws java.lang.ArrayIndexOutOfBoundsException
        Gets the specific data bean at the passed index within the array of data beans returned, represented by a AttachmentDataBean object. If the index is larger than the size of the array, an ArrayIndexOutOfBoundsException is thrown.
        Parameters:
        index - The index of the result array.
        Returns:
        The specific entry that was found in the array of AttachmentDataBean object.
        Throws:
        java.lang.ArrayIndexOutOfBoundsException - Thrown when access an array with an out of bound index.
      • getOwner

        public java.lang.Long getOwner()
                                throws java.lang.Exception
        Gets the member Id of the store.
        Returns:
        The member Id.
        Throws:
        java.lang.Exception
      • populate

        public void populate()
                      throws java.lang.Exception
        Populates the databean based on inputs received from the UI. First, based on the inputs, an appropriate SQL query is used to get a list of file name or URL name. Second, this list of file name and URL name is converted in a list of com.ibm.commerce.tools.attachment.beans.AttachmentDataBean.
        Specified by:
        populate in interface SmartDataBean
        Overrides:
        populate in class SmartDataBeanImpl
        Throws:
        java.lang.Exception
      • getInClauseForDirectoryIds

        public java.lang.String getInClauseForDirectoryIds(java.lang.String aStoreDirectoryName)
        Gets the "in clause" for the directory ids for the search SQL. This string follows the following format: (number1, number2, ..., numberN) .
        Parameters:
        aStoreDirectoryName - The store directory name
        Returns:
        The "in clause" for the directory ids for the search SQL.
      • getIndexBegin

        public java.lang.String getIndexBegin()
        Gets the beginning index into the search results
        Returns:
        The beginning index.
      • getIndexEnd

        public java.lang.String getIndexEnd()
        Gets the end index into the search results
        Returns:
        The end index.
      • getDirectoryId

        public java.lang.String getDirectoryId()
        Gets the directory Id.
        Returns:
        The directory Id.
      • setDirectoryId

        public void setDirectoryId(java.lang.String string)
        Sets the directory Id.
        Parameters:
        string - The directory Id.
      • getSearchName

        public java.lang.String getSearchName()
        Gets the string to search for the file name.
        Returns:
        The string to search for the file name.
      • getResultSetSize

        public int getResultSetSize()
        Gets the total number of entries found.
        Returns:
        The size of the result set.
      • setResultSetSize

        public void setResultSetSize(int newResultSetSize)
        Sets the total number of entries found.
        Parameters:
        The - size of the result set.
      • setSearchName

        public void setSearchName(java.lang.String string)
        Sets the string to search for the file name.
        Parameters:
        string - The string to search for the file name.
      • getTool

        public java.lang.String getTool()
        Gets the tool used to display the attachments: search or browse.
        Returns:
        The tool used to do the search. Two possible values: search or browser.
      • setTool

        public void setTool(java.lang.String string)
        Sets the tool used to display the attachments: search or browse.
        Parameters:
        string - The tool used to do the search. The possible values should be: search and browser.
      • setParm

        public void setParm(java.lang.String para,
                            java.lang.String value)
        Sets some parameters. These parameters can be: orderby, endindex, or startindex.
        Parameters:
        para - The parameter to set. There are 3 values: orderby,endindex,startindex.
        value - The value to assign to the parameter para.
      • getSearchDescription

        public java.lang.String getSearchDescription()
        Gets the string used for the search on the description field.
        Returns:
        The string used for the search on the description field.
      • getSearchType

        public java.lang.String getSearchType()
        Sets the string used for the search to restrict the type of assets.
        Returns:
        The string used for the search to restrict the type of assets.
      • setSearchDescription

        public void setSearchDescription(java.lang.String string)
        Sets the string to search on the description field.
        Parameters:
        string - The string used to search on the description field.
      • setSearchType

        public void setSearchType(java.lang.String string)
        Sets the string used to perform a search restricted to the type of assets.
        Parameters:
        string - The string used for the search to restrict the type of assets.
      • setIndexBegin

        public void setIndexBegin(java.lang.String newIndexBegin)
        Sets the starting index of the result items.
        Parameters:
        newIndexBegin - The starting index.
      • setIndexEnd

        public void setIndexEnd(java.lang.String newIndexEnd)
        Sets the end index of the result items.
        Parameters:
        newIndexEnd - The end index.
      • getSearchLanguageId

        public java.lang.String getSearchLanguageId()
        Gets the language ID used to search for the language dependent short description.
        Returns:
        The language ID against which we will search for the short description. This is the language ID in which we are logon in Accelerator.
      • setSearchLanguageId

        public void setSearchLanguageId(java.lang.String string)
        Sets the language ID used to search for the language dependent short description.
        Parameters:
        string - The language ID against which we will search for the short description.
      • isCorruptedManagedFile

        public boolean isCorruptedManagedFile()
        Gets if the file is a duplicate file across workspaces.
        Returns:
        true if the file is a duplicate file across workspaces ; false otherwise.
      • setCorruptedManagedFile

        public void setCorruptedManagedFile(boolean hasCorruptedManagedFile)
        Sets to indicate if the file is a duplicate file across workspaces.
        Parameters:
        hasCorruptedManagedFile - The isCorruptedManagedFile flag to set: true or false.
      • getErrorCode

        public java.lang.String getErrorCode()
        Gets the error code.
        Returns:
        The error code.
      • setErrorCode

        public void setErrorCode(java.lang.String anErrorCode)
        Sets the error code. This is used if the isCorruptedManagedFile() returns true.
        Parameters:
        anErrorCode - The error code.