com.filenet.download.api

Class Package

  • java.lang.Object
    • com.filenet.download.api.Package


  • public class Package
    extends java.lang.Object
    Represents a logical grouping of client features available on a content platform engine server.
    • Constructor Summary

      Constructors 
      Constructor and Description
      Package() 
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getDescription()
      Returns the package description.
      java.util.List<Feature> getFeatures()
      Returns all of the features contained in this Package object.
      java.util.List<Feature> getFeatures(java.lang.String featureId, java.lang.String language, java.lang.String buildNumber)
      Returns the features contained in this Package object based on the criteria specified by this method's arguments.
      java.lang.String getId()
      Returns the ID value of the package, expressed in GUID format.
      java.lang.String getServerBuildNumber()
      Returns the content platform engine server build number for the package
      java.lang.String getVersion()
      Returns the content platform engine server version number for the package.
      static java.util.List<Package> search(ServerConnectionData serverConnectionData)
      Static method that executes a search for all packages available from the specified content platform engine server location.
      static java.util.List<Package> search(ServerConnectionData serverConnectionData, java.lang.String id, java.lang.String version, java.lang.String serverBuildNumber)
      Static method that uses filter criteria to execute a search for all packages available from the specified content platform engine server location.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • IBM_FILENET_CONTENT_MANAGER_PACKAGE_ID

        public static final java.lang.String IBM_FILENET_CONTENT_MANAGER_PACKAGE_ID
        A constant representing the ID of the IBM FileNet Content Manager package. This constant can be used as a filter value when performing a call to Package.search().
        See Also:
        Constant Field Values
      • IBM_FILENET_PROCESS_ENGINE_ID

        public static final java.lang.String IBM_FILENET_PROCESS_ENGINE_ID
        A constant representing the ID of the IBM FileNet Process Engine package. This constant can be used as a filter value when performing a call to Package.search().
        See Also:
        Constant Field Values
      • IBM_FILENET_CLIENT_DOWNLOAD_SERVICE_ID

        public static final java.lang.String IBM_FILENET_CLIENT_DOWNLOAD_SERVICE_ID
        A constant representing the ID of the IBM FileNet Client Download Service package. This constant can be used as a filter value when performing a call to Package.search().
        See Also:
        Constant Field Values
    • Constructor Detail

      • Package

        public Package()
    • Method Detail

      • getId

        public java.lang.String getId()
        Returns the ID value of the package, expressed in GUID format.
        Returns:
        A String representing the ID of the package.
      • getDescription

        public java.lang.String getDescription()
        Returns the package description.
        Returns:
        A String representing the package description.
      • getVersion

        public java.lang.String getVersion()
        Returns the content platform engine server version number for the package.
        Returns:
        A String representing the package server version number.
      • getServerBuildNumber

        public java.lang.String getServerBuildNumber()
        Returns the content platform engine server build number for the package
        Returns:
        A String representing the package server build number.
      • getFeatures

        public java.util.List<Feature> getFeatures()
                                            throws java.io.IOException
        Returns all of the features contained in this Package object.
        Returns:
        A list of Feature objects representing the features contained in this package.
        Throws:
        java.io.IOException
      • getFeatures

        public java.util.List<Feature> getFeatures(java.lang.String featureId,
                                                   java.lang.String language,
                                                   java.lang.String buildNumber)
                                            throws java.io.IOException
        Returns the features contained in this Package object based on the criteria specified by this method's arguments. Use null for any arguments that are not to be used for filtering.
        Parameters:
        featureId - A String argument that can be used to search for a by feature id, for example, Feature.JAVA_EJB_CLIENT_FEATURE_ID.
        language - A String argument that can be used to search for a Feature by its language, "java" or "C#".

        For this release, only the Java language is supported.

        buildNumber - A String argument that can be used to search for a Feature based on the build number of the feature modules, for example, dap452.154.

        For this release, this parameter is not applicable. Enter a null value.

        Returns:
        A list of Feature objects that match the specified criteria. If there is no match, null is returned.
        Throws:
        java.io.IOException
      • search

        public static java.util.List<Package> search(ServerConnectionData serverConnectionData)
                                              throws java.io.IOException
        Static method that executes a search for all packages available from the specified content platform engine server location.
        Parameters:
        serverConnectionData - A ServerConnectionData object representing the HTTP or HTTPS connection to the server.
        Returns:
        A list of Package objects representing the packages that are available from the server, or null if no packages are found.
        Throws:
        java.io.IOException
      • search

        public static java.util.List<Package> search(ServerConnectionData serverConnectionData,
                                                     java.lang.String id,
                                                     java.lang.String version,
                                                     java.lang.String serverBuildNumber)
                                              throws java.io.IOException
        Static method that uses filter criteria to execute a search for all packages available from the specified content platform engine server location.
        Parameters:
        serverConnectionData - A ServerConnectionData object representing the HTTP or HTTPS connection to the server.
        id - A String to filter the search results based on package ID. Use null to leave unspecified.
        version - A String to filter the search results based on server version number. Use null to leave unspecified.
        serverBuildNumber - A String to filter the search results based on server build number. Use null to leave unspecified.
        Returns:
        A list of Package objects representing the packages that are available from the server that match the specified search criteria, or null if no packages are found that match.
        Throws:
        java.io.IOException

© Copyright IBM Corporation 2006, 2019. All rights reserved.