com.filenet.download.api
Class Package
- java.lang.Object
-
- com.filenet.download.api.Package
-
public class Package extends java.lang.ObjectRepresents a logical grouping of client features available on a content platform engine server.
-
-
Field Summary
Fields Modifier and Type Field and Description static java.lang.StringIBM_FILENET_CLIENT_DOWNLOAD_SERVICE_IDA constant representing the ID of the IBM FileNet Client Download Service package.static java.lang.StringIBM_FILENET_CONTENT_MANAGER_PACKAGE_IDA constant representing the ID of the IBM FileNet Content Manager package.static java.lang.StringIBM_FILENET_PROCESS_ENGINE_IDA constant representing the ID of the IBM FileNet Process Engine package.
-
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.StringgetDescription()Returns the package description.java.util.List<Feature>getFeatures()Returns all of the features contained in thisPackageobject.java.util.List<Feature>getFeatures(java.lang.String featureId, java.lang.String language, java.lang.String buildNumber)Returns the features contained in thisPackageobject based on the criteria specified by this method's arguments.java.lang.StringgetId()Returns the ID value of the package, expressed in GUID format.java.lang.StringgetServerBuildNumber()Returns the content platform engine server build number for the packagejava.lang.StringgetVersion()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.
-
-
-
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 toPackage.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 toPackage.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 toPackage.search().- See Also:
- Constant Field Values
-
-
Method Detail
-
getId
public java.lang.String getId()
Returns the ID value of the package, expressed in GUID format.- Returns:
- A
Stringrepresenting the ID of the package.
-
getDescription
public java.lang.String getDescription()
Returns the package description.- Returns:
- A
Stringrepresenting the package description.
-
getVersion
public java.lang.String getVersion()
Returns the content platform engine server version number for the package.- Returns:
- A
Stringrepresenting the package server version number.
-
getServerBuildNumber
public java.lang.String getServerBuildNumber()
Returns the content platform engine server build number for the package- Returns:
- A
Stringrepresenting the package server build number.
-
getFeatures
public java.util.List<Feature> getFeatures() throws java.io.IOException
Returns all of the features contained in thisPackageobject.- Returns:
- A list of
Featureobjects 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 thisPackageobject based on the criteria specified by this method's arguments. Usenullfor any arguments that are not to be used for filtering.- Parameters:
featureId- AStringargument that can be used to search for aby feature id, for example, Feature.JAVA_EJB_CLIENT_FEATURE_ID.language- AStringargument that can be used to search for aFeatureby its language, "java" or "C#".For this release, only the Java language is supported.
buildNumber- AStringargument that can be used to search for aFeaturebased on the build number of the feature modules, for example, dap452.154.For this release, this parameter is not applicable. Enter a
nullvalue.- Returns:
- A list of
Featureobjects that match the specified criteria. If there is no match,nullis 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- AServerConnectionDataobject representing the HTTP or HTTPS connection to the server.- Returns:
- A list of
Packageobjects 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- AServerConnectionDataobject representing the HTTP or HTTPS connection to the server.id- AStringto filter the search results based on package ID. Usenullto leave unspecified.version- AStringto filter the search results based on server version number. Usenullto leave unspecified.serverBuildNumber- AStringto filter the search results based on server build number. Usenullto leave unspecified.- Returns:
- A list of
Packageobjects representing the packages that are available from the server that match the specified search criteria, ornullif no packages are found that match. - Throws:
java.io.IOException
-
-