com.ibm.commerce.context.content.resources.file.beans

Class ManagedFileListDataBean

  • All Implemented Interfaces:
    DataBean, InputDataBean, SmartDataBean, Delegator, Protectable, java.io.Serializable

    public class ManagedFileListDataBean
extends SmartDataBeanImpl
implements Protectable, Delegator
    The ManagedFileListDataBean can operate in two modes depending on the values of the file directory ID and the file full path.

    Mode 1: when the file directory ID is specified.
    This ManagedFileListDataBean when populated will give a list of managed file databeans. The list contains all the managed files in the given directory.

    Mode 2: when the file full path is specified.
    The ManagedFileListDataBean can be used to search managed files by the given file full path. The search is case sensitive. The search criteria can be starts with, contains, ends with and exact match.

    See Also:
    Serialized Form

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        The IBM copyright notice field.
        See Also:
        Constant Field Values

      • MATCHCASE_STARTWITH

        public static final java.lang.String MATCHCASE_STARTWITH
        Case sensitive; starts with
        See Also:
        Constant Field Values

      • MATCHCASE_CONTAINING

        public static final java.lang.String MATCHCASE_CONTAINING
        Case sensitive; contains
        See Also:
        Constant Field Values

      • MATCHCASE_ENDWITH

        public static final java.lang.String MATCHCASE_ENDWITH
        Case sensitive; ends with
        See Also:
        Constant Field Values

      • EXACT_MATCH

        public static final java.lang.String EXACT_MATCH
        Case sensitive; exact match
        See Also:
        Constant Field Values

    • Constructor Detail

      • ManagedFileListDataBean

        public ManagedFileListDataBean()

    • Method Detail

      • setFileDirectoryId

        public void setFileDirectoryId(java.lang.Long aFileDirectoryId)
        This method sets the file directory id.
        Parameters:
        aFileDirectoryId - the file directory id.

      • getFileDirectoryId

        public java.lang.Long getFileDirectoryId()
        This method gets the file directory id.
        Returns:
        the file directory id.

      • getFilePath

        public java.lang.String getFilePath()
        Get the file path.
        Returns:
        Returns the file path.

      • setFilePath

        public void setFilePath(java.lang.String astrFilePath)
        Set the file path.
        Parameters:
        astrFilePath - The file path to set.

      • populate

        public void populate()
              throws java.lang.Exception
        This method is used to populate the ManagedFileListDataBean. The file directory ID must be set using the setFileDirectoryId method before running this method.
        Specified by:
        populate in interface SmartDataBean
        Overrides:
        populate in class SmartDataBeanImpl
        Throws:
        java.lang.Exception

      • getManagedFiles

        public java.util.List getManagedFiles()
        This method returns the list of managed files. The elements in the list are of type ManagedFileDataBean.
        Returns:
        the list of managed files.

      • setManagedFiles

        public void setManagedFiles(java.util.List alstManagedFiles)
        This method sets the list of managed files.
        Parameters:
        alstManagedFiles - The list of managed files.

      • getDelegate

        public Protectable getDelegate()
                        throws java.lang.Exception
        This method returns the Protectable object whose access control policies will indirectly control the access control for this object.
        Specified by:
        getDelegate in interface Delegator
        Returns:
        The Protectable object whose access control policies will indirectly control the access control for this object
        Throws:
        java.lang.Exception

      • getOwner

        public java.lang.Long getOwner()
                        throws java.lang.Exception
        Return the member reference number of the owner.
        Specified by:
        getOwner in interface Protectable
        Returns:
        the member ID of the owner.
        Throws:
        java.lang.Exception - thrown when the owner's member ID cannot be retrieved through the StoreAccessBean.

      • getFilePathSearchCriteria

        public java.lang.String getFilePathSearchCriteria()
        Get file path search criteria.
        Returns:
        Returns the file path search criteria.

      • setFilePathSearchCriteria

        public void setFilePathSearchCriteria(java.lang.String astrFilePathSearchCriteria)
        Set file path search criteria.
        Parameters:
        astrFilePathSearchCriteria - The file path search criteria to set.
Skip navigation links