wt.util.version
Class WindchillVersion

java.lang.Object
  wt.util.version.WindchillVersion

public class WindchillVersion
extends Object

Provides APIs for querying the release identifiers and display labels for all installed assemblies.

Supported API: true

Extendable: false

Method Summary

static String	getDisplayLabelFor(ReleaseId release_identifier) Query the display label associated with an assembly's release id.
static String	getDisplayLabelFor(String assembly_identifier) Query the display label associated with a particular assembly id.
static ReleaseId	getInstalledAssemblyReleaseIdFor(String assembly_id) Query the release id for the assembly with the specified assembly id.
static ReleaseId[]	getInstalledAssemblyReleaseIds() Query the release ids of all installed assemblies.
static String	getSupportDateCodeFor(ReleaseId release_identifier) Query the date code associated with an assembly's release id.
static String	getSupportDateCodeFor(String assembly_id) Query the date code associated with a particular assembly id.
static String	getSupportReleaseNumberFor(ReleaseId release_identifier) Query the release number associated with an assembly's release id.
static String	getSupportReleaseNumberFor(String assembly_id) Query the release number associated with a particular assembly id
static boolean	isAssemblyInstalled(String assembly_id) Determine if the assembly with the specified id is installed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstalledAssemblyReleaseIds

public static final ReleaseId[] getInstalledAssemblyReleaseIds()
                                                        throws com.ptc.windchill.instassm.ReleaseIdException

Query the release ids of all installed assemblies.

These release ids are queries from the $(wt.home)/codebase/instreg/registry resource located on the server. This .iar resource is queries through the WTContext. So if invoking from a Windchill client, the HTTP server must be running.

Supported API: true

Extendable: false

Returns:

non-null collection of versions in no particular order

Throws:

com.ptc.windchill.instassm.ReleaseIdException - if there is a problem reading the InstallationRegistry resource

isAssemblyInstalled

public static final boolean isAssemblyInstalled(String assembly_id)
                                         throws com.ptc.windchill.instassm.ReleaseIdException

Determine if the assembly with the specified id is installed.

These ids is queries from the $(wt.home)/codebase/instreg/registry resource located on the server. This .iar resource is queries through the WTContext. So if invoking from a Windchill client, the HTTP server must be running.

Supported API: true

Extendable: false

Returns:

true if the assembly with the specified id is installed

Throws:

com.ptc.windchill.instassm.ReleaseIdException - if there is a problem reading the InstallationRegistry resource or if the named assembly is not installed

getInstalledAssemblyReleaseIdFor

public static final ReleaseId getInstalledAssemblyReleaseIdFor(String assembly_id)
                                                        throws com.ptc.windchill.instassm.ReleaseIdException

Query the release id for the assembly with the specified assembly id.

These ids is queries from the $(wt.home)/codebase/instreg/registry resource located on the server. This .iar resource is queries through the WTContext. So if invoking from a Windchill client, the HTTP server must be running.

Supported API: true

Extendable: false

Returns:

POSSIBLY-NULL ReleaseId corresponding to the provided assembly id (i.e. null when isAssemblyInstalled = false)

Throws:

com.ptc.windchill.instassm.ReleaseIdException - if there is a problem reading the InstallationRegistry resource or if the named assembly is not installed

See Also:

isAssemblyInstalled(java.lang.String)

getDisplayLabelFor

public static final String getDisplayLabelFor(ReleaseId release_identifier)
                                       throws com.ptc.windchill.instassm.ReleaseIdException

Query the display label associated with an assembly's release id.

This information is queried from the $(wt.home)/codebase/instreg/registry resource located on the server. This .iar resource is queries through the WTContext. So if invoking from a Windchill client, the HTTP server must be running.

Supported API: true

Extendable: false

Returns:

non-null string that may be empty of the assembly with the release identifier was never installed

Throws:

com.ptc.windchill.instassm.ReleaseIdException - if there is a problem reading the InstallationRegistry resource

See Also:

isAssemblyInstalled(java.lang.String)

getDisplayLabelFor

public static final String getDisplayLabelFor(String assembly_identifier)
                                       throws com.ptc.windchill.instassm.ReleaseIdException

Query the display label associated with a particular assembly id.

This information is queried from the $(wt.home)/codebase/instreg/registry resource located on the server. This .iar resource is queries through the WTContext. So if invoking from a Windchill client, the HTTP server must be running.

Supported API: true

Extendable: false

Returns:

non-null string that may be empty of the assembly with the release identifier was never installed

Throws:

com.ptc.windchill.instassm.ReleaseIdException - if there is a problem reading the InstallationRegistry resource

See Also:

isAssemblyInstalled(java.lang.String)

getSupportDateCodeFor

public static final String getSupportDateCodeFor(ReleaseId release_identifier)
                                          throws com.ptc.windchill.instassm.ReleaseIdException

Query the date code associated with an assembly's release id.

This information is queried from the $(wt.home)/codebase/instreg/registry resource located on the server. This .iar resource is queries through the WTContext. So if invoking from a Windchill client, the HTTP server must be running.

Supported API: true

Extendable: false

Returns:

non-null, possibly-empty string

Throws:

com.ptc.windchill.instassm.ReleaseIdException - if there is a problem reading the InstallationRegistry resource

getSupportDateCodeFor

public static final String getSupportDateCodeFor(String assembly_id)
                                          throws com.ptc.windchill.instassm.ReleaseIdException

Query the date code associated with a particular assembly id.

This information is queried from the $(wt.home)/codebase/instreg/registry resource located on the server. This .iar resource is queries through the WTContext. So if invoking from a Windchill client, the HTTP server must be running.

Supported API: true

Extendable: false

Returns:

non-null, possibly-empty string

Throws:

com.ptc.windchill.instassm.ReleaseIdException - if there is a problem reading the InstallationRegistry resource

getSupportReleaseNumberFor

public static final String getSupportReleaseNumberFor(ReleaseId release_identifier)
                                               throws com.ptc.windchill.instassm.ReleaseIdException

Query the release number associated with an assembly's release id.

This is not the formal release identifier (ReleaseId), but rather the truncated version number to display in a product's about page allong with the date code to clearly identify the product when requesting techinical support.

This information is queried from the $(wt.home)/codebase/instreg/registry resource located on the server. This .iar resource is queries through the WTContext. So if invoking from a Windchill client, the HTTP server must be running.

Supported API: true

Extendable: false

Returns:

non-null, possibly-empty string

Throws:

com.ptc.windchill.instassm.ReleaseIdException - if there is a problem reading the InstallationRegistry resource

getSupportReleaseNumberFor

public static final String getSupportReleaseNumberFor(String assembly_id)
                                               throws com.ptc.windchill.instassm.ReleaseIdException

Query the release number associated with a particular assembly id

This is not the formal release identifier (ReleaseId), but rather the truncated version number to display in a product's about page allong with the date code to clearly identify the product when requesting techinical support.

This information is queried from the $(wt.home)/codebase/instreg/registry resource located on the server. This .iar resource is queries through the WTContext. So if invoking from a Windchill client, the HTTP server must be running.

Supported API: true

Extendable: false

Returns:

non-null, possibly-empty string

Throws:

com.ptc.windchill.instassm.ReleaseIdException - if there is a problem reading the InstallationRegistry resource