PortalDefinition Class
- public class PortalDefinition
extends Object
implements CategoryDefinition
A PortalDefinition
is an aggregator of
DesktopDefinition
s.
Related Topics
DesktopDefinition
-
Hierarchy
-
Object
PortalDefinition
-
All Implemented Interfaces
-
CategoryDefinition
, Serializable
PortalDefinition
public PortalDefinition(String
webAppName,
PortalPath
portalPath,
LocalizationResource
lr,
String
contentUri)
- Constructor to create a new
PortalDefinition
object.
Related Topics
PortalPath
clone(LocalizationResource, PortalDefinition) Method
public static PortalDefinition
clone(LocalizationResource
localizationResource,
PortalDefinition
portalDefinition)
Clones the given PortalDefinition
.
Parameters
-
localizationResource
- localized title and description
-
portalDefinition
- portal to be cloned
Returns
- cloned
PortalDefinition
equals(Object) Method
public boolean equals(Object
o)
-
Overrides
-
Object.equals(Object)
getContentUri() Method
public String
getContentUri()
Returns the contentUri for this PortalDefinition
Returns
- contentUri
getLocalizationResource() Method
public LocalizationResource
getLocalizationResource()
Returns the LocalizationResource
associated with
this CategoryDefinition
.
Returns
- LocalizationResource
getPortalPath() Method
public PortalPath
getPortalPath()
Returns the PortalPath
for this portal.
Returns
PortalPath
getWebAppName() Method
public String
getWebAppName()
Returns the name of the J2EE web application this portal
is scoped to.
Returns
- name of web application
hashCode() Method
public int hashCode()
-
Overrides
-
Object.hashCode()
hasRequiredFields(PortalDefinition) Method
public static String
hasRequiredFields(PortalDefinition
portalDefinition)
Checks that the given PortalDefinition
has fields that are
required of a PortalDefinition
. Returns an error string if
any of the required fields is missing NULL
if everything is
correct.
Returns
- error string if any fields are missing,
NULL
otherwise
isRoot() Method
public boolean isRoot()
Determines if the category is a root category.
Returns
true
if this category is the root
setLocalizationResource(LocalizationResource) Method
public void setLocalizationResource(LocalizationResource
localizationResource)
Sets LocalizationResource
for this
CategoryDefinition
.
toString() Method
public String
toString()
-
Overrides
-
Object.toString()
update(PortalDefinition, PortalDefinition) Method
public static PortalDefinition
update(PortalDefinition
existingDefinition,
PortalDefinition
newDefinition)
Updates an existing portal with a new PortalDefinition
.
Parameters
-
existingDefinition
- existing
PortalDefinition
-
newDefinition
- new
PortalDefinition
Returns
- updated
PortalDefinition