# com.bea.netuix.application.identifier
DesktopDefinitionId Class

public class DesktopDefinitionId
extends `Object`
implements `Serializable`

The DesktopDefinitionId is the webapp name, portal path, and desktop path together that uniquely identifies a portal desktop. They are used in the url of a customized portal desktop.

An example of what the `DesktopDefinitionId` is can be derived from the example url below.

http://host:port/webappName/appmanager/portalPath/desktopPath

The `DesktopDefinitionId` is the aggregation of the webappName, portalPath, and desktopPath from the url above.

Hierarchy
  `Object`
  `DesktopDefinitionId`

All Implemented Interfaces
  `Serializable`

## Constructor Summary

DesktopDefinitionId(`String` webAppName, `PortalPath` portalPath, `DesktopPath` desktopPath)

## Method Summary

`public static `DesktopDefinitionId`` | `clone`(`DesktopDefinitionId` desktopDefinitionId)
`protected `Object`` | `clone`()
`public static `DesktopDefinitionId`` | `createDesktopDefinitionId`(`String` webAppName, `String` portalPathStr, `String` desktopPathStr)
`public boolean` | `equals`(`Object` o)
`public `DesktopPath`` | `getDesktopPath`()
`public `PortalPath`` | `getPortalPath`()
`public `String`` | `getWebAppName`()
`public int` | `hashCode`()
`public void` | `setDesktopPath`(`DesktopPath` desktopPath)
`public void` | `setPortalPath`(`PortalPath` portalPath)
`public void` | `setWebAppName`(`String` webAppName)
`public `String`` | `toString`()

Methods from class `java.lang.`Object``
`finalize, getClass, notify, notifyAll, wait, wait, wait`

## Constructor Detail

### DesktopDefinitionId

    public DesktopDefinitionId(String webAppName,
                               PortalPath portalPath,
                               DesktopPath desktopPath)

## Method Detail

### clone(DesktopDefinitionId) Method

    public static DesktopDefinitionId clone(DesktopDefinitionId desktopDefinitionId)

#### Parameters

desktopDefinitionId
  the `DesktopDefinitionId` to clone.

#### Returns

a new `DesktopDefinitionId` with the exact same parameters as the `DesktopDefinitionId` passed in.

### clone() Method

    protected Object clone()

Overrides
  `Object.clone()`

#### Returns

a new `DesktopDefinitionId` with the exact same parameters as this `DesktopDefinitionId`.

### createDesktopDefinitionId(String, String, String) Method

    public static DesktopDefinitionId createDesktopDefinitionId(String webAppName,
                                                                String portalPathStr,
                                                                String desktopPathStr)

#### Parameters

webAppName
  the name of the webapp where this desktop will reside.

portalPathStr
  the part of the url that identifies this portal.

desktopPathStr
  the part of the url that identifies this desktop.

#### Returns

a new `DesktopDefinitionId` with the webapp name, portal path, and desktop path set to the values passed in.

### equals(Object) Method

    public boolean equals(Object o)

Overrides
  `Object.equals(Object)`

#### Parameters

o
  a `DesktopDefinitionId` object to compare to this `DesktopDefinitionId`.

#### Returns

`true` if this `DesktopDefinitionId` is the same as the `DesktopDefinitionId` object passed in; `false` otherwise.

### getDesktopPath() Method

    public DesktopPath getDesktopPath()

#### Returns

the `DesktopPath` that is basically a string representing a part of the url for the customized portal desktop.

### getPortalPath() Method

    public PortalPath getPortalPath()

#### Returns

the `PortalPath` that is basically a string representing a part of the url for the customized portal desktop.

### getWebAppName() Method

    public String getWebAppName()

#### Returns

the webapp name where the desktop resides.

### hashCode() Method

    public int hashCode()

Overrides
  `Object.hashCode()`

#### Returns

a hash code value for this object.

### setDesktopPath(DesktopPath) Method

    public void setDesktopPath(DesktopPath desktopPath)

#### Parameters

desktopPath
  an object representing a part of the url for the customized portal desktop.

### setPortalPath(PortalPath) Method

    public void setPortalPath(PortalPath portalPath)

#### Parameters

portalPath
  an object representing a part of the url for the customized portal desktop.

### setWebAppName(String) Method

    public void setWebAppName(String webAppName)

#### Parameters

webAppName
  the webapp name where the desktop resides.

### toString() Method

    public String toString()

Overrides
  `Object.toString()`

#### Returns

the name of the webapp with the `PortalPath` and `DesktopPath` appended.