com.ibm.commerce.content.facade.server.commands

Class AbstractFetchManagedFileCmdImpl

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static java.lang.String DEFAULT_DIRECTORY_SEPARATOR
      This is the directory separator used.
      static java.util.logging.Logger LOGGER
      The logger of the class.
      • Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

        LOCAL
      • Fields inherited from interface com.ibm.websphere.command.Command

        serialVersionUID
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      GetManagedFileType getGetManagedFileType()
      This method gets the value of GetManagedFileType.
      java.util.List getManagedFiles()
      Returns the list of ManagedFiles that where retrieved when executing the fetch.
      java.util.List getManagedFiles(java.util.List lstManagedFiles, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems)
      This methods gets a certain number of managed files.
      java.util.List getNouns()
      This method gets a list of managed directory nouns.
      ShowType getPagingParameter()
      This method gets the paging parameters
      SelectionCriteriaMapper getSelectionCriteria()
      This is a get method for SelectionCriteriaMapper;
      ShowType getShow()
      This method returns the show verb response that represent the results of the fetch operation.
      boolean isReadyToCallExecute()
      This method returns if this command is ready to execute
      void performExecute()
      This method is to get the result using the parameter of GetManagedFileType by calling the Abstract method fetch().
      void reset()
      This method resets this command.
      void setGet(GetType getVerb)
      This method sets the get expression for the fetch operation.
      void setGetManagedFile(GetManagedFileType aGetManagedFile)
      This method sets the GetManagedFileType.
      void setPagingParameter(ShowType aPagingParameter)
      This method set the paging parameters
      void setSelectionCriteria(SelectionCriteriaMapper aSelectionCriteria)
      This method is to set the SelectionCriteriaMapper.
      • Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

        execute, executeFromCache, getCaller, getEntryInfo, getId, getObjectSize, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache
      • Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

        getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.ibm.websphere.command.Command

        execute
      • Methods inherited from interface com.ibm.websphere.command.TargetableCommand

        getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties
    • Field Detail

      • COPYRIGHT

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

        public static final java.util.logging.Logger LOGGER
        The logger of the class.
      • DEFAULT_DIRECTORY_SEPARATOR

        public static final java.lang.String DEFAULT_DIRECTORY_SEPARATOR
        This is the directory separator used.
        See Also:
        Constant Field Values
    • Constructor Detail

      • AbstractFetchManagedFileCmdImpl

        public AbstractFetchManagedFileCmdImpl()
    • Method Detail

      • isReadyToCallExecute

        public boolean isReadyToCallExecute()
        This method returns if this command is ready to execute
        Specified by:
        isReadyToCallExecute in interface com.ibm.websphere.command.Command
        Overrides:
        isReadyToCallExecute in class AbstractFetchNounCmdImpl
        Returns:
        boolean
        See Also:
        Command.isReadyToCallExecute()
      • performExecute

        public void performExecute()
                            throws java.lang.Exception
        This method is to get the result using the parameter of GetManagedFileType by calling the Abstract method fetch().
        Specified by:
        performExecute in interface com.ibm.websphere.command.TargetableCommand
        Specified by:
        performExecute in class com.ibm.websphere.command.TargetableCommandImpl
        Throws:
        java.lang.Exception
        See Also:
        TargetableCommandImpl.performExecute()
      • getManagedFiles

        public java.util.List getManagedFiles(java.util.List lstManagedFiles,
                                              java.math.BigInteger recordSetStartNumber,
                                              java.math.BigInteger maxItems)
        This methods gets a certain number of managed files.
        Parameters:
        lstManagedFiles - a list of managed files
        recordSetStartNumber - record set start number
        maxItems - the maximum of managed files returned
        Returns:
        a list of managed files
      • reset

        public void reset()
        This method resets this command.
        Specified by:
        reset in interface com.ibm.websphere.command.Command
        Overrides:
        reset in class AbstractFetchNounCmdImpl
        See Also:
        Command.reset()
      • setPagingParameter

        public void setPagingParameter(ShowType aPagingParameter)
        This method set the paging parameters
        Specified by:
        setPagingParameter in interface FetchManagedFileCmd
        Parameters:
        aPagingParameter - The paging parameter to set.
      • setGetManagedFile

        public void setGetManagedFile(GetManagedFileType aGetManagedFile)
        This method sets the GetManagedFileType.
        Specified by:
        setGetManagedFile in interface FetchManagedFileCmd
        Parameters:
        aGetManagedFile - The GetManagedFileType to be set which contains the parameters used to fetch.
      • getGetManagedFileType

        public GetManagedFileType getGetManagedFileType()
        This method gets the value of GetManagedFileType.
        Returns:
        GetManagedFileType The GetManagedFileType is gotten in this method.
      • getManagedFiles

        public java.util.List getManagedFiles()
        Returns the list of ManagedFiles that where retrieved when executing the fetch.
        Specified by:
        getManagedFiles in interface FetchManagedFileCmd
        Returns:
        A list of ManagedFiles that represents the results of executing the query expression.
      • getSelectionCriteria

        public SelectionCriteriaMapper getSelectionCriteria()
        This is a get method for SelectionCriteriaMapper;
        Returns:
        Returns the selectionCriteria.
      • setSelectionCriteria

        public void setSelectionCriteria(SelectionCriteriaMapper aSelectionCriteria)
        This method is to set the SelectionCriteriaMapper.
        Parameters:
        aSelectionCriteria - The SelectionCriteriaMapper to set.
      • getNouns

        public java.util.List getNouns()
        This method gets a list of managed directory nouns.
        Specified by:
        getNouns in interface AbstractFetchNounCmd
        Returns:
        a list of managed directory nouns.