Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.1.0)

E17493-02

oracle.ideimpl.webupdate
Class UpdateInfo

java.lang.Object
  extended by oracle.ideimpl.webupdate.UpdateInfo
All Implemented Interfaces:
java.lang.Comparable
Direct Known Subclasses:
UpdateCenterMessage

public class UpdateInfo
extends java.lang.Object
implements java.lang.Comparable

Information from an update center about an update (either an extension or a patch).

Since:
10.1.3

Nested Class Summary
static class UpdateInfo.Type
           
 
Constructor Summary
UpdateInfo()
           
 
Method Summary
 void addRequiredUpdate(java.lang.String id, Version minVersion, Version maxVersion)
           
 int compareTo(java.lang.Object other)
           
 boolean equals(java.lang.Object that)
           
 java.lang.String getAuthor()
           
 java.lang.String getAuthorURL()
           
 UpdateBundle getBundle()
           
 java.lang.String getClickThroughURL()
          Get the url of a click through license that the user must agree to before installing this update.
 java.lang.String getDescription()
          Get a description of this update.
 java.lang.String getID()
          Get the id of this update.
 java.lang.String getName()
          Get the (human readable) name of this update.
 java.lang.String getPostStartupHookClass()
          Get the post startup hook class.
 java.lang.String getPreferredInstallLocation()
           
 java.util.Collection getRequiredIds()
          Get a collection of ids of all required extensions for this update.
 Version getRequiredMaxVersion(java.lang.String id)
          Get the maximum required version of the specified extension that is needed to install this update.
 Version getRequiredMinVersion(java.lang.String id)
          Get the minimum required version of the specified extension that is needed to install this update.
 java.util.List getRequiredUpdates()
          Get other UpdateInfos that must be installed for this update.
 UpdateCenter getSourceCenter()
          Get the update center that provided this update, if any.
 UpdateInfo.Type getType()
           
 java.lang.String getURL()
           
 Version getVersion()
          Get the version of this update.
 boolean hasClickThrough()
          Get whether this update requires agreement to a click through license.
 int hashCode()
           
 boolean isNew()
          Is this a new update or an upgrade of an existing extension?
 void setAuthor(java.lang.String author)
           
 void setAuthorURL(java.lang.String authorUrl)
           
 void setBundle(UpdateBundle bundle)
           
 void setClickThroughURL(java.lang.String url)
          Set the URL of a click through license that the user must agree to before installing this update.
 void setDescription(java.lang.String description)
          Set a description for this update.
 void setDownloadURL(java.lang.String url)
           
 void setID(java.lang.String id)
          Set the id of this update.
 void setName(java.lang.String name)
          Set the (human readable) name of this update.
 void setPostStartupHookClass(java.lang.String postStartupHookClass)
           
 void setPreferredInstallLocation(java.lang.String preferredInstallLocation)
           
 void setSourceCenter(UpdateCenter center)
          Set the update center that provided this update.
 void setType(UpdateInfo.Type type)
           
 void setVersion(Version version)
          Set the version of this update.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UpdateInfo

public UpdateInfo()
Method Detail

equals

public boolean equals(java.lang.Object that)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

setBundle

public void setBundle(UpdateBundle bundle)

getBundle

public UpdateBundle getBundle()

getPostStartupHookClass

public java.lang.String getPostStartupHookClass()
Get the post startup hook class.

Returns:

setPostStartupHookClass

public void setPostStartupHookClass(java.lang.String postStartupHookClass)

getPreferredInstallLocation

public java.lang.String getPreferredInstallLocation()

setPreferredInstallLocation

public void setPreferredInstallLocation(java.lang.String preferredInstallLocation)

setSourceCenter

public void setSourceCenter(UpdateCenter center)
Set the update center that provided this update.

Parameters:
center - the center that provided this update.

getSourceCenter

public UpdateCenter getSourceCenter()
Get the update center that provided this update, if any.

Returns:
the center that provided this update if known, or null.

isNew

public boolean isNew()
Is this a new update or an upgrade of an existing extension?


getRequiredUpdates

public java.util.List getRequiredUpdates()
Get other UpdateInfos that must be installed for this update.

Returns:
a list of other updateinfos that must be installed for this update.

setAuthor

public void setAuthor(java.lang.String author)

getAuthor

public java.lang.String getAuthor()

setAuthorURL

public void setAuthorURL(java.lang.String authorUrl)

getAuthorURL

public java.lang.String getAuthorURL()

setDownloadURL

public void setDownloadURL(java.lang.String url)

getURL

public java.lang.String getURL()

addRequiredUpdate

public void addRequiredUpdate(java.lang.String id,
                              Version minVersion,
                              Version maxVersion)

getRequiredIds

public java.util.Collection getRequiredIds()
Get a collection of ids of all required extensions for this update.

Returns:
a collection of Strings, each of which is the id of an update this update depends on.

getRequiredMinVersion

public Version getRequiredMinVersion(java.lang.String id)
Get the minimum required version of the specified extension that is needed to install this update.

Parameters:
id - the id of a required extension, must be in the collection returned by getRequiredIds().
Returns:
the minimum required version of the specified extension. null if no such dependency exists, or there is no minimum version.

getRequiredMaxVersion

public Version getRequiredMaxVersion(java.lang.String id)
Get the maximum required version of the specified extension that is needed to install this update.

Parameters:
id - the id of a required extension, must be in the collection returned by getRequiredIds().
Returns:
the maximum required version of the specified extension. null if no such dependency exists, or there is no maximum version.

setClickThroughURL

public void setClickThroughURL(java.lang.String url)
Set the URL of a click through license that the user must agree to before installing this update.

Parameters:
url - the url of a click through license.

getClickThroughURL

public java.lang.String getClickThroughURL()
Get the url of a click through license that the user must agree to before installing this update.

Returns:
the url of a click through license, null if none.

hasClickThrough

public boolean hasClickThrough()
Get whether this update requires agreement to a click through license. Shortcut for getClickThroughURL() != null.

Returns:
true if this update requires the user to agree to a click through license before installation.

setID

public void setID(java.lang.String id)
Set the id of this update. If the update is an extension, this is the same as the extension id. Patches always have a unique id.

Parameters:
id - the id of the update.

getID

public java.lang.String getID()
Get the id of this update.

Returns:
the id of this update.

setVersion

public void setVersion(Version version)
Set the version of this update. This is only required for extension updates, and matches the version of the extension being installed.

Parameters:
version - the version of this update.

getVersion

public Version getVersion()
Get the version of this update.

Returns:
the version of this update.

getType

public UpdateInfo.Type getType()

setType

public void setType(UpdateInfo.Type type)

getName

public java.lang.String getName()
Get the (human readable) name of this update.

Returns:
the name of the update.

setName

public void setName(java.lang.String name)
Set the (human readable) name of this update.

Parameters:
name - the name of the update.

getDescription

public java.lang.String getDescription()
Get a description of this update.

Returns:
a description of this update.

setDescription

public void setDescription(java.lang.String description)
Set a description for this update.

Parameters:
description - a description for this update.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

compareTo

public int compareTo(java.lang.Object other)
Specified by:
compareTo in interface java.lang.Comparable

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.1.0)

E17493-02

Copyright © 1997, 2011, Oracle. All rights reserved.