com.ibm.portal.vanityurl.model
Interface VanityURLModelLocator<E extends VanityURLNode>

All Superinterfaces:

Locator<E>

public interface VanityURLModelLocator<E extends VanityURLNode>
extends Locator<E>

This interface provides finder methods for vanity URLs. An instance can be obtained from the VanityURLModel.

Since:

8.5

Method Summary

IterableListModel<E>	findByPath(java.lang.String path) Locates all vanity URLs matching a given path.
IterableListModel<E>	findByTargetPageOID(ObjectID pageOID) Locates all vanity URLs that map to a given page.
IterableListModel<E>	findByTargetVPOID(ObjectID vpOID) Locates all vanity URLs that map to pages in a given virtual portal.
E	findByURL(java.net.URL url) Locates a vanity URL given a host, port and path.

Methods inherited from interface com.ibm.portal.Locator

findByID, findByUniqueName

Method Detail

findByURL

E findByURL(java.net.URL url)
                                  throws ModelException

Locates a vanity URL given a host, port and path.

Parameters:

url - the URL for that a vanity URL shall be searched for

Returns:

the vanity URL that matches the given URL, or null if no match was found

Throws:

ModelException - in case the data could not be retrieved

findByPath

IterableListModel<E> findByPath(java.lang.String path)
                                                      throws ModelException

Locates all vanity URLs matching a given path.

Parameters:

path - the path

Returns:

the vanity URLs that match the given path

Throws:

ModelException - in case the data could not be retrieved

findByTargetPageOID

IterableListModel<E> findByTargetPageOID(ObjectID pageOID)
                                                               throws ModelException

Locates all vanity URLs that map to a given page.

Parameters:

pageOID - the target page

Returns:

the vanity URLs that map to the given page

Throws:

ModelException - in case the data could not be retrieved

findByTargetVPOID

IterableListModel<E> findByTargetVPOID(ObjectID vpOID)
                                                             throws ModelException

Locates all vanity URLs that map to pages in a given virtual portal.

Parameters:

vpOID - the virtual portal ObjectID

Returns:

the vanity URLs for the given virtual portal

Throws:

ModelException - in case the data could not be retrieved