Tree

 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES   SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ibm.portal.admin
Interface VirtualPortalLocator

All Superinterfaces:

Locator

public interface VirtualPortalLocator
extends Locator

Admin model interface for the list of virtual portal elements. Admin portlets can obtain this list to get a the information about virtual portals that the portal supports.

Since:

6.1.0

See Also:

VirtualPortal

Method Summary
ListModel	findAllByRealm(java.lang.String realm)           Finds all virtual portals that share the same supplied realm.
ListModel	findByDescriptionContains(java.util.Locale locale, java.lang.String pattern)           Find all virtual portals that contain a given pattern in their description.
ListModel	findByDescriptionStartsWith(java.util.Locale locale, java.lang.String pattern)           Find all virtual portals that start with a given pattern in their description.
ListModel	findByTitleContains(java.util.Locale locale, java.lang.String pattern)           Find all virtual portals that contain a given pattern in their title.
ListModel	findByTitleStartsWith(java.util.Locale locale, java.lang.String pattern)           Find all virtual portals that start with a given pattern in their title.

 

Methods inherited from interface com.ibm.portal.Locator

findByID, findByUniqueName

 

Method Detail

findAllByRealm

ListModel findAllByRealm(java.lang.String realm)
                         throws DataException

Finds all virtual portals that share the same supplied realm.

Parameters:

realm - the realm that is shared by the virtual portals

Returns:

a list of VirtualPortal objects that identify matching virtual portal

Throws:

DataBackendException

DataException

findByTitleContains

ListModel findByTitleContains(java.util.Locale locale,
                              java.lang.String pattern)
                              throws DataException

Find all virtual portals that contain a given pattern in their title. This method takes only titles of a given locale into account.
If no VirtualPortal object could be found, an empty collection is returned.
NOTE: Pattern is case-insensitive!

Parameters:

locale - the locale to search the pattern in

pattern - the pattern to search for

Returns:

A list of com.ibm.portal.admin.VirtualPortal objects.

Throws:

DataException

findByTitleStartsWith

ListModel findByTitleStartsWith(java.util.Locale locale,
                                java.lang.String pattern)
                                throws DataException

Find all virtual portals that start with a given pattern in their title. This method takes only titles of a given locale into account.
If no VirtualPortal object could be found, an empty collection is returned.
NOTE: Pattern is case-insensitive!

Parameters:

locale - the locale to search the pattern in

pattern - the pattern to search for

Returns:

A list of com.ibm.portal.admin.VirtualPortal objects.

Throws:

DataException

findByDescriptionContains

ListModel findByDescriptionContains(java.util.Locale locale,
                                    java.lang.String pattern)
                                    throws DataException

Find all virtual portals that contain a given pattern in their description. This method takes only descriptions of a given locale into accoutn.
If no VirtualPortal could be found, an empty collection is returned.
NOTE: Pattern is case-insensitive!

Parameters:

locale - the locale to search the pattern in

pattern - the pattern to search for

Returns:

A list of com.ibm.portal.admin.VirtualPortal objects.

Throws:

DataException

findByDescriptionStartsWith

ListModel findByDescriptionStartsWith(java.util.Locale locale,
                                      java.lang.String pattern)
                                      throws DataException

Find all virtual portals that start with a given pattern in their description. This method takes only descriptions of a given locale into account.
If no VirtualPortal object could be found, an empty collection is returned.
NOTE: Pattern is case-insensitive!

Parameters:

locale - the locale to search the pattern in

pattern - the pattern to search for

Returns:

A list of com.ibm.portal.admin.VirtualPortal objects.

Throws:

DataException

Tree

 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES   SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD