com.beasys.commerce.portal
Interface PortalManager

All Superinterfaces:

javax.ejb.EJBObject, java.rmi.Remote

public interface PortalManager

extends javax.ejb.EJBObject

Copyright (c) 2000 BEA Systems, Inc. All Rights Reserved Wrapper interface for getting portal and administration data.

Version:

$Revision: 2$, $Date: 2/11/00 4:28:06 PM$

Author:

Scott Musson

Field Summary

static java.lang.String

LOOKUP_NAME The public JNDI lookup name for the Portal Manager session bean.

Method Summary

void	addGroupToPortal(Portal aPortal, long aGroup) Create a group for a portal.
void	addPortletTo(Portlet aPortlet, Portal aPortal) Add a portlet to a portal name.
void	createPortal(Portal aPortal) Persist a new portal.
void	createPortlet(Portlet aPortlet) Persist a new portlet.
void	createPortletForGroup(Portal aPortal, PortalCategory aCategory, long aGroup, Portlet aPortlet) Create a GroupPersonalization for a portal and a group.
void	createPortletForPortal(Portal aPortal, PortalCategory aCategory, Portlet aPortlet) Create a PortalPersonalization for a portlet.
void	createPortletForUser(Portal aPortal, PortalCategory aCategory, long aGroup, long aUser, Portlet aPortlet) Create a UserPersonalization for a portal, group, and user.
Portlet[]	fastGetAvailablePortletsFor(Portal aPortal, PortalCategory aCategory, long aGroup, long aUser) Get all of the available portlets associated to a portal, a group, and a user.
PortalColumnInformation[]	fastGetColumnInformationFor(Portal aPortal, PortalCategory aCategory) Using straight JDBC.
Portal	fastGetPortalFor(java.lang.String aName) Using straight JDBC.
Portlet[]	fastGetPortletDefinitionsFor(Portal aPortal) Using straight JDBC.
Portlet[]	fastGetPortletsFor(Portal aPortal, PortalCategory aCategory) Using straight JDBC.
Portlet[]	fastGetPortletsFor(Portal aPortal, PortalCategory aCategory, long aGroup) Using straight JDBC.
Portlet[]	fastGetPortletsFor(Portal aPortal, PortalCategory aCategory, long aGroup, long aUser) Using straight JDBC.
Portlet[][]	fastGetRCPortletsFor(Portal aPortal, PortalCategory aCategory, long aGroup, long aUser) Using straight JDBC.
Portlet[]	getAvailablePortletsFor(Portal aPortal, PortalCategory aCategory) Get all of the available portlets associated to a portal.
Portlet[]	getAvailablePortletsFor(Portal aPortal, PortalCategory aCategory, long aGroup) Get all of the available portlets associated to a portal and a group.
Portlet[]	getAvailablePortletsFor(Portal aPortal, PortalCategory aCategory, long aGroup, long aUser) Get all of the available portlets associated to a portal, a group, and a user.
PortalColumnInformation[]	getColumnInformationFor(Portal aPortal, PortalCategory aCategory) Get the column information (sizes) for a given portal and category.
PortalCategory	getDefaultCategory(Portal aPortal)
long[]	getGroupsForPortal(Portal aPortal) Get the groups associated to a portal
Portal	getPortalFor(java.lang.String aName) Get a portal from the name.
Portal[]	getPortals() Get all of the portals defined within a system.
Portal[]	getPortalsFor(Portlet aPortlet) Get the portal names associated to a portlet.
Portlet[]	getPortletDefinitionsFor(Portal aPortal) Get all of the portlets (definitions) associated to a portal, it is just the PORTLET_DEFINITION.
Portlet	getPortletFor(java.lang.String aPortlet) Get the PortletDefinition for the name.
Portlet	getPortletForGroup(Portal aPortal, PortalCategory aCategoryName, long aGroup, Portlet aPortlet) Get the GroupPersonalization for the name.
Portlet	getPortletForGroup(Portal aPortal, PortalCategory aCategory, long aGroup, Portlet aPortlet, boolean isWaterfall) Get the GroupPersonalization for the name.
Portlet	getPortletForPortal(Portal aPortal, PortalCategory aCategory, Portlet aPortlet) Get the PortalPersonalization for the name.
Portlet	getPortletForPortal(Portal aPortal, PortalCategory aCategory, Portlet aPortlet, boolean isWaterfall) Get the PortalPersonalization for the name.
Portlet	getPortletForUser(Portal aPortal, PortalCategory aCategory, long aGroup, long aUser, Portlet aPortlet) Get the UserPersonalization for the name.
Portlet	getPortletForUser(Portal aPortal, PortalCategory aCategory, long aGroup, long aUser, Portlet aPortlet, boolean isWaterfall) Get the UserPersonalization for the name.
long[]	getPortletIdsForPortal(Portal aPortal) Get the portlet uids associated to a portal
Portlet[]	getPortlets() Get all of the portlets (PortletDefinition) defined within a system.
Portlet[][]	getRCPortletsFor(Portal aPortal, PortalCategory aCategory, long aGroup, long aUser) Get all of the portlets related to a PortalName, aGroup and a user.
Portlet[]	getVisiblePortletsFor(Portal aPortal, PortalCategory aCategory) Get all of the available and visible portlets associated to a portal.
Portlet[]	getVisiblePortletsFor(Portal aPortal, PortalCategory aCategory, long aGroup) Get all of the available and visible portlets associated to a portal and a group.
Portlet[]	getVisiblePortletsFor(Portal aPortal, PortalCategory aCategory, long aGroup, long aUser) Get all of the available and visible portlets associated to a portal, a group, and a user.
void	removeGroupForPortal(Portal aPortal, long aGroup) Remove a group from the portal.
void	removePortal(Portal aPortal) Remove a portal.
void	removePortlet(Portlet aPortlet) Remove a portlet.
void	removePortletForGroup(Portal aPortal, PortalCategory aCategory, long aGroup, Portlet aPortlet) Remove a GroupPersonalization for a portal and a group.
void	removePortletForPortal(Portal aPortal, PortalCategory aCategory, Portlet aPortlet) Remove a PortalPersonalization for a portlet.
void	removePortletForUser(Portal aPortal, PortalCategory aCategory, long aGroup, long aUser, Portlet aPortlet) Remove a UserPersonalization for a portal, group, and user.
void	removePortletFrom(Portlet aPortlet, Portal aPortal) Remove the portlet/portal from the hierarchy.
void	setColumnInformationFor(Portal aPortal, PortalCategory aCategory, PortalColumnInformation[] someColumnInformation) Set the column information for a portal.
void	updatePortal(Portal aPortal) Update a portal.
void	updatePortlet(Portlet aPortlet) Update a portlet.
void	updatePortletForGroup(Portal aPortal, PortalCategory aCategory, long aGroup, Portlet aPortlet) Update a GroupPersonalization for a portal and a group.
void	updatePortletForGroup(Portal aPortal, PortalCategory aCategory, long aGroup, Portlet aPortlet, boolean createIfNotFound) Update a Group Personalization for a portlet.
void	updatePortletForPortal(Portal aPortal, PortalCategory aCategory, Portlet aPortlet) Update a PortalPersonalization for a portlet.
void	updatePortletForPortal(Portal aPortal, PortalCategory aCategory, Portlet aPortlet, boolean createIfNotFound) Update a PortalPersonalization for a portlet.
void	updatePortletForUser(Portal aPortal, PortalCategory aCategory, long aGroup, long aUser, Portlet aPortlet) Update a UserPersonalization for a portal, group, and user.
void	updatePortletForUser(Portal aPortal, PortalCategory aCategory, long aGroup, long aUser, Portlet aPortlet, boolean createIfNotFound) Update a PortalPersonalization for a portlet.

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

Field Detail

LOOKUP_NAME

public static final java.lang.String LOOKUP_NAME

The public JNDI lookup name for the Portal Manager session bean.

Method Detail

getPortalFor

public Portal getPortalFor(java.lang.String aName)
                    throws java.rmi.RemoteException,
                           PortalException,
                           PortalFinderException,
                           PortalObjectNotFoundException

Get a portal from the name.

Parameters:

aPortalName - the name of the portal to retrieve.

Returns:

Portal the portal definition

Throws:

PortalObjectNotFoundException - the credentials were not found for criteria.

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

getAvailablePortletsFor

public Portlet[] getAvailablePortletsFor(Portal aPortal,
                                         PortalCategory aCategory)
                                  throws java.rmi.RemoteException,
                                         PortalException,
                                         PortalFinderException

Get all of the available portlets associated to a portal.

Parameters:

the - portal name

the - category

Returns:

all of the available portlets for the portal and category.

Throws:

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

getAvailablePortletsFor

public Portlet[] getAvailablePortletsFor(Portal aPortal,
                                         PortalCategory aCategory,
                                         long aGroup)
                                  throws java.rmi.RemoteException,
                                         PortalException,
                                         PortalFinderException

Get all of the available portlets associated to a portal and a group.

Parameters:

the - portal name

the - category

the - group name

Returns:

all of the portals defined.

Throws:

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

getAvailablePortletsFor

public Portlet[] getAvailablePortletsFor(Portal aPortal,
                                         PortalCategory aCategory,
                                         long aGroup,
                                         long aUser)
                                  throws java.rmi.RemoteException,
                                         PortalException,
                                         PortalFinderException

Get all of the available portlets associated to a portal, a group, and a user.

Parameters:

the - portal name

the - category

the - group name

the - user name

Returns:

all of the portals defined.

Throws:

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

fastGetAvailablePortletsFor

public Portlet[] fastGetAvailablePortletsFor(Portal aPortal,
                                             PortalCategory aCategory,
                                             long aGroup,
                                             long aUser)
                                      throws java.rmi.RemoteException,
                                             PortalException,
                                             PortalFinderException

Get all of the available portlets associated to a portal, a group, and a user.

Parameters:

the - portal name

the - category

the - group name

the - user name

Returns:

all of the portals defined.

Throws:

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

getVisiblePortletsFor

public Portlet[] getVisiblePortletsFor(Portal aPortal,
                                       PortalCategory aCategory)
                                throws java.rmi.RemoteException,
                                       PortalException,
                                       PortalFinderException

Get all of the available and visible portlets associated to a portal.

Parameters:

the - portal name

the - category

Returns:

all of the portals defined.

Throws:

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

getVisiblePortletsFor

public Portlet[] getVisiblePortletsFor(Portal aPortal,
                                       PortalCategory aCategory,
                                       long aGroup)
                                throws java.rmi.RemoteException,
                                       PortalException,
                                       PortalFinderException

Get all of the available and visible portlets associated to a portal and a group.

Parameters:

the - portal name

the - category

the - group name

Returns:

all of the portals defined.

Throws:

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

getVisiblePortletsFor

public Portlet[] getVisiblePortletsFor(Portal aPortal,
                                       PortalCategory aCategory,
                                       long aGroup,
                                       long aUser)
                                throws java.rmi.RemoteException,
                                       PortalException,
                                       PortalFinderException

Get all of the available and visible portlets associated to a portal, a group, and a user.

Parameters:

the - portal name

the - category

the - group name

the - user name

Returns:

all of the portals defined.

Throws:

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

getPortletDefinitionsFor

public Portlet[] getPortletDefinitionsFor(Portal aPortal)
                                   throws java.rmi.RemoteException,
                                          PortalException,
                                          PortalFinderException

Get all of the portlets (definitions) associated to a portal, it is just the PORTLET_DEFINITION.

Returns:

all of the portals defined, will return an empty array if none are found.

Throws:

PortalObjectNotFoundException - the credentials were not found for criteria.

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

getRCPortletsFor

public Portlet[][] getRCPortletsFor(Portal aPortal,
                                    PortalCategory aCategory,
                                    long aGroup,
                                    long aUser)
                             throws java.rmi.RemoteException,
                                    PortalException,
                                    PortalFinderException

Get all of the portlets related to a PortalName, aGroup and a user. This method will pull all of the personalizations for each level in the portlet definition that is returned. It sorts them according to their row/column values.

Parameters:

the - portal name

the - category

the - group name

the - user id

Returns:

Portlet[][] the rows and columns of information for the user. Will return an empty array if none available.

Throws:

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

getColumnInformationFor

public PortalColumnInformation[] getColumnInformationFor(Portal aPortal,
                                                         PortalCategory aCategory)
                                                  throws java.rmi.RemoteException,
                                                         PortalException,
                                                         PortalFinderException

Get the column information (sizes) for a given portal and category.

Parameters:

String - the portal name.

the - category

Returns:

PortalColumnInformation[] the column sizes in the correct order

Throws:

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

setColumnInformationFor

public void setColumnInformationFor(Portal aPortal,
                                    PortalCategory aCategory,
                                    PortalColumnInformation[] someColumnInformation)
                             throws java.rmi.RemoteException,
                                    PortalException,
                                    PortalRemoveException,
                                    PortalCreateException

Set the column information for a portal. This method assumes that the order of the array matches the columnOrder specified within the PortalColumnInformation.

Parameters:

the - portal.

the - category.

the - new column information.

Throws:

PortalCreateException - Could not recreate the column information.

PortalException - general error.

java.rmi.RemoteException - error within the container.

getDefaultCategory

public PortalCategory getDefaultCategory(Portal aPortal)
                                  throws java.rmi.RemoteException,
                                         PortalException,
                                         PortalFinderException,
                                         PortalObjectNotFoundException,
                                         PortalCreateException

createPortal

public void createPortal(Portal aPortal)
                  throws java.rmi.RemoteException,
                         PortalException,
                         PortalCreateException

Persist a new portal.

Parameters:

aPortal - a portal instance.

Throws:

PortalCreateException - Could not create the exception.

PortalException - general error.

java.rmi.RemoteException - error within the container.

updatePortal

public void updatePortal(Portal aPortal)
                  throws java.rmi.RemoteException,
                         PortalException,
                         PortalFinderException,
                         PortalObjectNotFoundException

Update a portal.

Parameters:

aPortal - a portal instance.

Throws:

PortalObjectNotFoundException - the portal could not be found

PortalFinderException - error on the query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

removePortal

public void removePortal(Portal aPortal)
                  throws java.rmi.RemoteException,
                         PortalException,
                         PortalFinderException,
                         PortalObjectNotFoundException,
                         PortalRemoveException

Remove a portal.

Parameters:

aPortal - a portal instance.

Throws:

PortalObjectNotFoundException - the portal could not be found

PortalFinderException - error on the query.

PortalRemoveException - error removing the portal.

PortalException - general error.

java.rmi.RemoteException - error within the container.

createPortlet

public void createPortlet(Portlet aPortlet)
                   throws java.rmi.RemoteException,
                          PortalException,
                          PortalCreateException

Persist a new portlet.

Parameters:

aPortal - a portal instance.

Throws:

PortalCreateException - error creating the portlet.

PortalException - general error.

java.rmi.RemoteException - error within the container.

updatePortlet

public void updatePortlet(Portlet aPortlet)
                   throws java.rmi.RemoteException,
                          PortalException,
                          PortalFinderException,
                          PortalObjectNotFoundException

Update a portlet.

Parameters:

aPortal - a portal instance.

Throws:

PortalObjectNotFoundException - Could not find the portlet definition.

PortalFinderException - error retrieving information.

PortalException - general error.

java.rmi.RemoteException - error within the container.

removePortlet

public void removePortlet(Portlet aPortlet)
                   throws java.rmi.RemoteException,
                          PortalException,
                          PortalFinderException,
                          PortalObjectNotFoundException,
                          PortalRemoveException

Remove a portlet.

Parameters:

aPortal - a portal instance.

Throws:

PortalObjectNotFoundException - Could not find the portlet.

PortalFinderException - error retrieving information.

PortalRemoveException - error removing the portlet.

PortalException - general error.

java.rmi.RemoteException - error within the container.

createPortletForPortal

public void createPortletForPortal(Portal aPortal,
                                   PortalCategory aCategory,
                                   Portlet aPortlet)
                            throws java.rmi.RemoteException,
                                   PortalException,
                                   PortalCreateException

Create a PortalPersonalization for a portlet. Also add the reference in PortalHierarchy

Parameters:

aPortal - a portal name.

the - category

the - portlet to create

Throws:

PortalCreateException - error creating the portlet.

PortalException - general error.

java.rmi.RemoteException - error within the container.

updatePortletForPortal

public void updatePortletForPortal(Portal aPortal,
                                   PortalCategory aCategory,
                                   Portlet aPortlet)
                            throws java.rmi.RemoteException,
                                   PortalException,
                                   PortalFinderException,
                                   PortalObjectNotFoundException

Update a PortalPersonalization for a portlet.

Parameters:

aPortal - a portal name.

the - category

the - portlet to create

Throws:

PortalObjectNotFoundException - could not find the portal personalization.

PortalFinderException - error getting information for the portal personalization.

PortalException - general error.

java.rmi.RemoteException - error within the container.

updatePortletForPortal

public void updatePortletForPortal(Portal aPortal,
                                   PortalCategory aCategory,
                                   Portlet aPortlet,
                                   boolean createIfNotFound)
                            throws java.rmi.RemoteException,
                                   PortalException,
                                   PortalFinderException,
                                   PortalObjectNotFoundException,
                                   PortalCreateException

Update a PortalPersonalization for a portlet. Possibly force the creation.

Parameters:

aPortal - a portal name.

the - category

the - portlet to update.

if - it is true it will create the object if it doesn't exist for update.

Throws:

PortalObjectNotFoundException - could not find the portal personalization.

PortalFinderException - error getting information for the portal personalization.

PortalException - general error.

java.rmi.RemoteException - error within the container.

removePortletForPortal

public void removePortletForPortal(Portal aPortal,
                                   PortalCategory aCategory,
                                   Portlet aPortlet)
                            throws java.rmi.RemoteException,
                                   PortalException,
                                   PortalFinderException,
                                   PortalObjectNotFoundException,
                                   PortalRemoveException

Remove a PortalPersonalization for a portlet. Also remove reference in PortalHierarchy.

Parameters:

aPortal - a portal name.

the - category

the - portlet to remove.

Throws:

PortalObjectNotFoundException - could not find the portal personalization.

PortalFinderException - error getting information for the portal personalization.

PortalRemoveException - error removing the portal personalization.

PortalException - general error.

java.rmi.RemoteException - error within the container.

createPortletForGroup

public void createPortletForGroup(Portal aPortal,
                                  PortalCategory aCategory,
                                  long aGroup,
                                  Portlet aPortlet)
                           throws java.rmi.RemoteException,
                                  PortalException,
                                  PortalCreateException

Create a GroupPersonalization for a portal and a group.

Parameters:

aPortal - a portal name.

the - category

the - group

the - portlet to create

Throws:

PortalCreateException - error creating the group personalization for the portlet.

PortalException - general error.

java.rmi.RemoteException - error within the container.

updatePortletForGroup

public void updatePortletForGroup(Portal aPortal,
                                  PortalCategory aCategory,
                                  long aGroup,
                                  Portlet aPortlet)
                           throws java.rmi.RemoteException,
                                  PortalException,
                                  PortalFinderException,
                                  PortalObjectNotFoundException

Update a GroupPersonalization for a portal and a group.

Parameters:

aPortal - a portal name.

the - category

the - group

the - portlet to create

Throws:

PortalObjectNotFoundException - could not find the group personalization for the portlet.

PortalFinderException - error on th query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

updatePortletForGroup

public void updatePortletForGroup(Portal aPortal,
                                  PortalCategory aCategory,
                                  long aGroup,
                                  Portlet aPortlet,
                                  boolean createIfNotFound)
                           throws java.rmi.RemoteException,
                                  PortalException,
                                  PortalFinderException,
                                  PortalObjectNotFoundException,
                                  PortalCreateException

Update a Group Personalization for a portlet. Possibly force the creation.

Parameters:

aPortal - a portal name.

the - category

the - group name

the - portlet to update.

if - it is true it will create the object if it doesn't exist for update.

Throws:

PortalObjectNotFoundException - could not find the group personalization for the portlet.

PortalFinderException - error on the query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

removePortletForGroup

public void removePortletForGroup(Portal aPortal,
                                  PortalCategory aCategory,
                                  long aGroup,
                                  Portlet aPortlet)
                           throws java.rmi.RemoteException,
                                  PortalException,
                                  PortalFinderException,
                                  PortalObjectNotFoundException,
                                  PortalRemoveException

Remove a GroupPersonalization for a portal and a group.

Parameters:

aPortal - a portal instance.

the - portal name.

the - category

the - group name

the - portlet to update.

Throws:

PortalObjectNotFoundException - could not find the group personalization for the portlet.

PortalFinderException - error on the query.

PortalRemoveException - error on removing the group personalization for the portlet.

PortalException - general error.

java.rmi.RemoteException - error within the container.

createPortletForUser

public void createPortletForUser(Portal aPortal,
                                 PortalCategory aCategory,
                                 long aGroup,
                                 long aUser,
                                 Portlet aPortlet)
                          throws java.rmi.RemoteException,
                                 PortalException,
                                 PortalCreateException

Create a UserPersonalization for a portal, group, and user.

Parameters:

the - portal name.

the - category

the - group name

the - user

the - portlet to update.

Throws:

PortalCreateException - error on creating the user personalization for the portlet.

PortalException - general error.

java.rmi.RemoteException - error within the container.

updatePortletForUser

public void updatePortletForUser(Portal aPortal,
                                 PortalCategory aCategory,
                                 long aGroup,
                                 long aUser,
                                 Portlet aPortlet)
                          throws java.rmi.RemoteException,
                                 PortalException,
                                 PortalFinderException,
                                 PortalObjectNotFoundException

Update a UserPersonalization for a portal, group, and user.

Parameters:

the - portal name.

the - category

the - group name

the - user

the - portlet to update.

Throws:

PortalObjectNotFoundException - could not find the user personalization for the portlet.

PortalFinderException - error on the query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

updatePortletForUser

public void updatePortletForUser(Portal aPortal,
                                 PortalCategory aCategory,
                                 long aGroup,
                                 long aUser,
                                 Portlet aPortlet,
                                 boolean createIfNotFound)
                          throws java.rmi.RemoteException,
                                 PortalException,
                                 PortalFinderException,
                                 PortalObjectNotFoundException,
                                 PortalCreateException

Update a PortalPersonalization for a portlet. Possibly force the creation.

Parameters:

aPortal - a portal name.

the - category

the - group name

the - user

the - portlet to update.

if - it is true it will create the object if it doesn't exist for update.

Throws:

PortalObjectNotFoundException - could not find the user personalization for the portlet.

PortalFinderException - error on the query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

removePortletForUser

public void removePortletForUser(Portal aPortal,
                                 PortalCategory aCategory,
                                 long aGroup,
                                 long aUser,
                                 Portlet aPortlet)
                          throws java.rmi.RemoteException,
                                 PortalException,
                                 PortalFinderException,
                                 PortalObjectNotFoundException,
                                 PortalRemoveException

Remove a UserPersonalization for a portal, group, and user.

Parameters:

aPortal - a portal instance.

the - category

the - group name

the - user

Throws:

PortalObjectNotFoundException - could not find the user personalization for the portlet.

PortalFinderException - error on the query.

PortalRemoveException - error on removing the user personalization for the portlet.

PortalException - general error.

java.rmi.RemoteException - error within the container.

getPortals

public Portal[] getPortals()
                    throws java.rmi.RemoteException,
                           PortalException,
                           PortalFinderException

Get all of the portals defined within a system.

Returns:

all of the portals defined.

Throws:

java.rmi.RemoteException - container error.

PortalFinderException - query error.

PortalException - General portal exception.

getPortlets

public Portlet[] getPortlets()
                      throws java.rmi.RemoteException,
                             PortalException,
                             PortalFinderException

Get all of the portlets (PortletDefinition) defined within a system.

Returns:

all of the portals defined.

Throws:

java.rmi.RemoteException - container error.

PortalFinderException - query error.

PortalException - General portal exception.

getPortalsFor

public Portal[] getPortalsFor(Portlet aPortlet)
                       throws java.rmi.RemoteException,
                              PortalException,
                              PortalFinderException

Get the portal names associated to a portlet.

Parameters:

the - portlet name.

Returns:

String[] the portal names.

Throws:

java.rmi.RemoteException - container error.

PortalFinderException - query error.

PortalException - General portal exception.

addPortletTo

public void addPortletTo(Portlet aPortlet,
                         Portal aPortal)
                  throws java.rmi.RemoteException,
                         PortalException,
                         PortalCreateException

Add a portlet to a portal name.

Parameters:

the - portlet to add

the - portal name to add it to.

removePortletFrom

public void removePortletFrom(Portlet aPortlet,
                              Portal aPortal)
                       throws java.rmi.RemoteException,
                              PortalException,
                              PortalFinderException,
                              PortalObjectNotFoundException,
                              PortalRemoveException

Remove the portlet/portal from the hierarchy.

Parameters:

aPortlet - the portlet object

aPortalName - the portal name.

Throws:

RemoteException - container error.

PortalException - general portal error.

PortalFinderException - error on query.

PortalObjectNotFoundException - the portlet could not be found.

PortalRemoveException - the portlet could not be removed.

getPortletFor

public Portlet getPortletFor(java.lang.String aPortlet)
                      throws java.rmi.RemoteException,
                             PortalException,
                             PortalFinderException,
                             PortalObjectNotFoundException

Get the PortletDefinition for the name.

Parameters:

the - portlet name.

Returns:

Portlet

Throws:

java.rmi.RemoteException - container error.

PortalFinderException - query error.

PortalObjectNotFoundException - the portlet definition does not exist.

PortalException - General portal exception.

getPortletForPortal

public Portlet getPortletForPortal(Portal aPortal,
                                   PortalCategory aCategory,
                                   Portlet aPortlet)
                            throws java.rmi.RemoteException,
                                   PortalException,
                                   PortalFinderException,
                                   PortalObjectNotFoundException

Get the PortalPersonalization for the name.

Parameters:

the - portal name.

the - category

the - portlet name.

Returns:

Portlet

Throws:

java.rmi.RemoteException - container error.

PortalFinderException - query error.

PortalObjectNotFoundException - the portal personalization does not exist.

PortalException - General portal exception.

getPortletForGroup

public Portlet getPortletForGroup(Portal aPortal,
                                  PortalCategory aCategoryName,
                                  long aGroup,
                                  Portlet aPortlet)
                           throws java.rmi.RemoteException,
                                  PortalException,
                                  PortalFinderException,
                                  PortalObjectNotFoundException

Get the GroupPersonalization for the name.

Parameters:

the - portal name.

the - category

the - group name.

the - portlet name.

Returns:

Portlet

Throws:

java.rmi.RemoteException - container error.

PortalFinderException - query error.

PortalObjectNotFoundException - The group personalization does not exist.

PortalException - General portal exception.

getPortletForUser

public Portlet getPortletForUser(Portal aPortal,
                                 PortalCategory aCategory,
                                 long aGroup,
                                 long aUser,
                                 Portlet aPortlet)
                          throws java.rmi.RemoteException,
                                 PortalException,
                                 PortalFinderException,
                                 PortalObjectNotFoundException

Get the UserPersonalization for the name.

Parameters:

the - portal name.

the - category

the - group name.

the - portlet name.

the - user name.

Returns:

Portlet

Throws:

java.rmi.RemoteException - container error.

PortalFinderException - query error.

PortalObjectNotFoundException - the user personalization does not exist.

PortalException - General portal exception.

getPortletForPortal

public Portlet getPortletForPortal(Portal aPortal,
                                   PortalCategory aCategory,
                                   Portlet aPortlet,
                                   boolean isWaterfall)
                            throws java.rmi.RemoteException,
                                   PortalException,
                                   PortalFinderException,
                                   PortalObjectNotFoundException

Get the PortalPersonalization for the name. Waterfall method.

Parameters:

the - portal name.

the - category

the - portlet name.

boolean - should i allow the waterfall

Returns:

Portlet

Throws:

java.rmi.RemoteException - container error.

PortalFinderException - query error.

PortalObjectNotFoundException - the portal personalization does not exist.

PortalException - General portal exception.

getPortletForGroup

public Portlet getPortletForGroup(Portal aPortal,
                                  PortalCategory aCategory,
                                  long aGroup,
                                  Portlet aPortlet,
                                  boolean isWaterfall)
                           throws java.rmi.RemoteException,
                                  PortalException,
                                  PortalFinderException,
                                  PortalObjectNotFoundException

Get the GroupPersonalization for the name. Waterfall method.

Parameters:

the - portal name.

the - category

the - group name.

the - portlet name.

boolean - should i allow the waterfall

Returns:

Portlet

Throws:

java.rmi.RemoteException - container error.

PortalFinderException - query error.

PortalObjectNotFoundException - the group personalization does not exist.

PortalException - General portal exception.

getPortletForUser

public Portlet getPortletForUser(Portal aPortal,
                                 PortalCategory aCategory,
                                 long aGroup,
                                 long aUser,
                                 Portlet aPortlet,
                                 boolean isWaterfall)
                          throws java.rmi.RemoteException,
                                 PortalException,
                                 PortalFinderException,
                                 PortalObjectNotFoundException

Get the UserPersonalization for the name. Waterfall method.

Parameters:

the - portal name.

the - category

the - group name.

the - portlet name.

the - user name.

boolean - should i allow the waterfall

Returns:

Portlet

Throws:

java.rmi.RemoteException - container error.

PortalFinderException - query error.

PortalObjectNotFoundException - the user personalization does not exist.

PortalException - General portal exception.

addGroupToPortal

public void addGroupToPortal(Portal aPortal,
                             long aGroup)
                      throws java.rmi.RemoteException,
                             PortalException,
                             PortalCreateException

Create a group for a portal.

Parameters:

the - portal name

the - group id (name)

Throws:

java.rmi.RemoteException - container error.

PortalFinderException - query error.

PortalException - General portal exception.

getGroupsForPortal

public long[] getGroupsForPortal(Portal aPortal)
                          throws java.rmi.RemoteException,
                                 PortalException,
                                 PortalFinderException

Get the groups associated to a portal

Parameters:

the - portal name

Returns:

the group ids.

Throws:

java.rmi.RemoteException - container error.

PortalFinderException - query error.

PortalException - General portal exception.

getPortletIdsForPortal

public long[] getPortletIdsForPortal(Portal aPortal)
                              throws java.rmi.RemoteException,
                                     PortalException,
                                     PortalFinderException

Get the portlet uids associated to a portal

Parameters:

the - portal

Returns:

the portlet ids.

Throws:

java.rmi.RemoteException - container error.

PortalFinderException - query error.

PortalException - General portal exception.

removeGroupForPortal

public void removeGroupForPortal(Portal aPortal,
                                 long aGroup)
                          throws java.rmi.RemoteException,
                                 PortalException,
                                 PortalFinderException,
                                 PortalObjectNotFoundException,
                                 PortalRemoveException

Remove a group from the portal.

Parameters:

the - portal name.

the - group id.

Throws:

java.rmi.RemoteException - container error.

PortalFinderException - query error.

PortalObjectNotFoundException - Error finding the group to remove.

PortalException - General portal exception.

fastGetColumnInformationFor

public PortalColumnInformation[] fastGetColumnInformationFor(Portal aPortal,
                                                             PortalCategory aCategory)
                                                      throws java.rmi.RemoteException,
                                                             PortalException,
                                                             PortalFinderException

Using straight JDBC. Get the column information for a portal.

Parameters:

the - portal name

the - category

Returns:

PortalColumnInformation[] the column information.

Throws:

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

fastGetRCPortletsFor

public Portlet[][] fastGetRCPortletsFor(Portal aPortal,
                                        PortalCategory aCategory,
                                        long aGroup,
                                        long aUser)
                                 throws java.rmi.RemoteException,
                                        PortalException,
                                        PortalFinderException

Using straight JDBC. Get all of the portlets related to a PortalName, aGroup and a user. This method will pull all of the personalizations for each level in the portlet definition that is returned.It sorts them according to their row/column values.

Parameters:

the - portal name

the - category

the - group name

the - user id

Returns:

Portlet[][] the rows and columns of information for the user.

Throws:

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

fastGetPortletDefinitionsFor

public Portlet[] fastGetPortletDefinitionsFor(Portal aPortal)
                                       throws java.rmi.RemoteException,
                                              PortalException,
                                              PortalFinderException

Using straight JDBC. Get all of the portlet definitions related to a PortalName.

Parameters:

the - portal name

Returns:

Portlet[] the rows and columns of information for the user.

Throws:

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

fastGetPortletsFor

public Portlet[] fastGetPortletsFor(Portal aPortal,
                                    PortalCategory aCategory)
                             throws java.rmi.RemoteException,
                                    PortalException,
                                    PortalFinderException

Using straight JDBC. Get all of the portal personalizations of the portlet related to a PortalName.

Parameters:

the - portal name

the - category

Returns:

Portlet[]the portal personalizations.

Throws:

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

fastGetPortletsFor

public Portlet[] fastGetPortletsFor(Portal aPortal,
                                    PortalCategory aCategory,
                                    long aGroup)
                             throws java.rmi.RemoteException,
                                    PortalException,
                                    PortalFinderException

Using straight JDBC. Get all of the group personalizations of the portlet related to a PortalName.

Parameters:

the - portal name

the - category

the - group name

Returns:

Portlet[] the group personalizations.

Throws:

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

fastGetPortletsFor

public Portlet[] fastGetPortletsFor(Portal aPortal,
                                    PortalCategory aCategory,
                                    long aGroup,
                                    long aUser)
                             throws java.rmi.RemoteException,
                                    PortalException,
                                    PortalFinderException

Using straight JDBC. Get all of the user personalizations of the portlet related to a PortalName.

Parameters:

the - portal name

the - category

the - group name

the - user name

Returns:

Portlet[] the group personalizations.

Throws:

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.

fastGetPortalFor

public Portal fastGetPortalFor(java.lang.String aName)
                        throws java.rmi.RemoteException,
                               PortalException,
                               PortalFinderException,
                               PortalObjectNotFoundException

Using straight JDBC. Get the portal definition for a portal.

Parameters:

the - portal name

Returns:

the Portal.

Throws:

PortalObjectNotFoundException - a portal by the given name does not exist.

PortalFinderException - error on query.

PortalException - general error.

java.rmi.RemoteException - error within the container.