|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.portlet.prefs.spi.PortletPreferencesId
public class PortletPreferencesId
Specifies a unique identifier for managing preferences.
This unique identifier is made up of the instance ID of the portlet, and optionally additional properties.
This class is not thread-safe.
Field Summary | |
---|---|
static String |
DESKTOP_PATH
A constant defining the desktop path |
static int |
NO_INSTANCE
Default instance ID. |
static String |
PORTAL_PATH
A constant defining the portal path |
static String |
WEBAPP_NAME
A constant defining the web app name |
Constructor Summary | |
---|---|
PortletPreferencesId(int instanceId)
Creates an instance with the given instance ID. |
|
PortletPreferencesId(int instanceId,
String webappName,
String portalPath,
String desktopPath)
Creates an instance with the given arguments. |
Method Summary | |
---|---|
Object |
clone()
Returns a deep copy of this object. |
boolean |
equals(Object that)
Returns true if the given object is equal in
value to this object. |
String |
getDefinitionLabel()
Returns the definition label. |
String |
getDesktopPath()
|
int |
getInstanceId()
Returns the instance ID. |
String |
getInstanceLabel()
Returns the instance label. |
String |
getPortalPath()
|
String |
getProperty(String key)
Returns the value of the property with the given key. |
String |
getWebappName()
|
int |
hashCode()
Returns the hashcode. |
void |
setDefinitionLabel(String definitionLabel)
Sets definition label. |
void |
setDesktopPath(String desktopPath)
|
void |
setInstanceId(int instanceId)
Sets the instance ID. |
void |
setInstanceLabel(String instanceLabel)
Sets the instance label. |
void |
setPortalPath(String portalPath)
|
void |
setProperty(String key,
String value)
Associates a property with the given key and value with this identifier. |
void |
setWebappName(String webappName)
|
String |
toString()
Returns a string value. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String WEBAPP_NAME
A constant defining the web app name
public static final String PORTAL_PATH
A constant defining the portal path
public static final String DESKTOP_PATH
A constant defining the desktop path
public static final int NO_INSTANCE
Default instance ID. The default ID is used to indicate that this ID does not correspond to persistent portlet instance.
Constructor Detail |
---|
public PortletPreferencesId(int instanceId)
Creates an instance with the given instance ID.
instanceId
- instance IDpublic PortletPreferencesId(int instanceId, String webappName, String portalPath, String desktopPath)
Creates an instance with the given arguments.
instanceId
- instance IDMethod Detail |
---|
public int getInstanceId()
Returns the instance ID.
public void setInstanceId(int instanceId)
Sets the instance ID.
instanceId
- instance IDpublic void setDefinitionLabel(String definitionLabel)
Sets definition label.
definitionLabel
- definition labelpublic String getDefinitionLabel()
Returns the definition label.
public String getInstanceLabel()
Returns the instance label.
public void setInstanceLabel(String instanceLabel)
Sets the instance label.
instanceLabel
- instance labelpublic void setProperty(String key, String value)
Associates a property with the given key and value with this identifier.
The value of a property may be null.
key
- keyvalue
- valuepublic String getWebappName()
public void setWebappName(String webappName)
public String getPortalPath()
public void setPortalPath(String portalPath)
public String getDesktopPath()
public void setDesktopPath(String desktopPath)
public String getProperty(String key)
Returns the value of the property with the given key.
key
- key
public String toString()
Returns a string value. The returned string will be of the
form "/
toString
in class Object
public int hashCode()
Returns the hashcode.
hashCode
in class Object
public boolean equals(Object that)
Returns true
if the given object is equal in
value to this object. Returns false
otherwise.
equals
in class Object
that
- objectpublic Object clone()
Returns a deep copy of this object.
clone
in class Object
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |