com.sdl.web.api.meta

Interface WebPageMetaFactory

public interface WebPageMetaFactory

Provides access to PageMeta that can be obtained using a page Id or TCM URI or it's URL.

Method Summary

Modifier and Type	Method and Description
com.tridion.meta.PageMeta	getMeta(int pageId) Return the PageMeta for the given page item id within the publication this PageMetaFactory was created with.
com.tridion.meta.PageMeta	getMeta(String pageId) Return the PageMeta for the given page TCMURI within the publication this PageMetaFactory was created with.
com.tridion.meta.PageMeta	getMetaByURL(int publicationId, String urlPath) Returns the PageMeta object in the Publication identified by the publicationId parameter which has the URL Path as passed by the urlPath parameter.
Collection<com.tridion.meta.PageMeta>	getMetaByURL(String urlPath) Returns all PageMeta objects which exactly match the URL Path passed as the urlPath parameter.
com.tridion.meta.PageMeta	getMetaByURL(String publicationURI, String urlPath) Returns the PageMeta object in the Publication identified by the publicationURI parameter which has the URL Path as passed by the urlPath parameter.
com.tridion.taxonomies.Keyword[]	getTaxonomyKeywords(String[] pageURIS, com.tridion.taxonomies.Keyword[] contextKeywords, WebTaxonomyFilter taxonomyFilter) Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.
com.tridion.taxonomies.Keyword[]	getTaxonomyKeywords(String pageURI, com.tridion.taxonomies.Keyword[] contextKeywords, WebTaxonomyFilter taxonomyFilter) Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.
com.tridion.taxonomies.Keyword[]	getTaxonomyKeywords(String taxonomyURI, String[] pageURIS, com.tridion.taxonomies.Keyword[] contextKeywords, WebTaxonomyFilter taxonomyFilter) Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.
com.tridion.taxonomies.Keyword[]	getTaxonomyKeywords(String taxonomyURI, String pageURI, com.tridion.taxonomies.Keyword[] contextKeywords, WebTaxonomyFilter taxonomyFilter) Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.
com.tridion.meta.PageMeta[]	getTaxonomyPages(com.tridion.taxonomies.Keyword[] taxonomyKeywords, boolean includeBranchedKeywords) This returns all the pagemetas for pages related to the specified taxonomy facets.
com.tridion.meta.PageMeta[]	getTaxonomyPages(com.tridion.taxonomies.Keyword taxonomyKeyword, boolean includeBranchedKeywords) This returns all the pagemetas for pages related to the specified taxonomy facet.

Method Detail

getTaxonomyPages

com.tridion.meta.PageMeta[] getTaxonomyPages(com.tridion.taxonomies.Keyword taxonomyKeyword,
                                             boolean includeBranchedKeywords)
                                      throws com.tridion.broker.StorageException

This returns all the pagemetas for pages related to the specified taxonomy facet. This could be a direct link or the branches of the specified facet.

Parameters:

taxonomyKeyword - The taxonomy facet to retrieve related pages for

includeBranchedKeywords - True if all the childkeywords of the specified keywords should be included

Returns:

A list of Pages, empty if nothing was found

Throws:

com.tridion.broker.StorageException - If unable to retrieve related pages.

getTaxonomyPages

com.tridion.meta.PageMeta[] getTaxonomyPages(com.tridion.taxonomies.Keyword[] taxonomyKeywords,
                                             boolean includeBranchedKeywords)
                                      throws com.tridion.broker.StorageException

This returns all the pagemetas for pages related to the specified taxonomy facets. This could be a direct link or one of the branches of the specified facets. The pages must be related to all of the specified keywords.

Parameters:

taxonomyKeywords - The taxonomy keywords to retrieve related pages for

includeBranchedKeywords - True if all the childkeywords of the specified keywords should be included

Returns:

A list of Pages, empty if nothing was found

Throws:

com.tridion.broker.StorageException - If unable to retrieve related pages.

getTaxonomyKeywords

com.tridion.taxonomies.Keyword[] getTaxonomyKeywords(String pageURI,
                                                     com.tridion.taxonomies.Keyword[] contextKeywords,
                                                     WebTaxonomyFilter taxonomyFilter)

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Parameters:

pageURI - THe URI of the page to search facets for

contextKeywords - The URIs of already selected context keywords, this will be used to retrieve related items.

taxonomyFilter - The filter to apply to the found taxonomyFacets

Returns:

An array of found Keywords, a merged keyword array without duplicates.

getTaxonomyKeywords

com.tridion.taxonomies.Keyword[] getTaxonomyKeywords(String[] pageURIS,
                                                     com.tridion.taxonomies.Keyword[] contextKeywords,
                                                     WebTaxonomyFilter taxonomyFilter)

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Parameters:

pageURIS - THe URIs of the pages to search facets for

contextKeywords - The URIs of already selected context keywords, this will be used to retrieve related items.

taxonomyFilter - The filter to apply to the found taxonomyFacets

Returns:

An array of found Keywords, a merged keyword array without duplicates.

getTaxonomyKeywords

com.tridion.taxonomies.Keyword[] getTaxonomyKeywords(String taxonomyURI,
                                                     String pageURI,
                                                     com.tridion.taxonomies.Keyword[] contextKeywords,
                                                     WebTaxonomyFilter taxonomyFilter)

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Parameters:

taxonomyURI - The URI of the Taxonomy

pageURI - THe URI of the page to search facets for

contextKeywords - The URIs of already selected context keywords, this will be used to retrieve related items.

taxonomyFilter - The filter to apply to the found taxonomyFacets

Returns:

An array of found Keywords, a merged keyword array without duplicates.

getTaxonomyKeywords

com.tridion.taxonomies.Keyword[] getTaxonomyKeywords(String taxonomyURI,
                                                     String[] pageURIS,
                                                     com.tridion.taxonomies.Keyword[] contextKeywords,
                                                     WebTaxonomyFilter taxonomyFilter)

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Parameters:

taxonomyURI - The URI of the Taxonomy

pageURIS - THe URIs of the pages to search facets for

contextKeywords - The URIs of already selected context keywords, this will be used to retrieve related items.

taxonomyFilter - The filter to apply to the found taxonomyFacets

Returns:

An array of found Keywords, a merged keyword array without duplicates.

getMeta

com.tridion.meta.PageMeta getMeta(int pageId)

Return the PageMeta for the given page item id within the publication this PageMetaFactory was created with.

Parameters:

pageId - page Id to return the PageMeta for

Returns:

PageMeta for the given id or null when the PageMeta could not be found or when an error occured

getMeta

com.tridion.meta.PageMeta getMeta(String pageId)

Return the PageMeta for the given page TCMURI within the publication this PageMetaFactory was created with.

Parameters:

pageId - page TCMURI to return the PageMeta for

Returns:

PageMeta for the given id or null when the PageMeta could not be found or when an error occured

getMetaByURL

Collection<com.tridion.meta.PageMeta> getMetaByURL(String urlPath)

Returns all PageMeta objects which exactly match the URL Path passed as the urlPath parameter.

Parameters:

urlPath - The URL Path of the Page as it is stored in the Page Metadata.

Returns:

A Collection containing all PageMeta objects with the URLPath used to perform the query. In theory, this is one PageMeta per Publication. If no results are found, an empty Collection is returned.

getMetaByURL

com.tridion.meta.PageMeta getMetaByURL(int publicationId,
                                       String urlPath)

Returns the PageMeta object in the Publication identified by the publicationId parameter which has the URL Path as passed by the urlPath parameter.

Parameters:

publicationId - The Id of the Publication you want to search in. If 0 is used as the Publication Id, then the Publication Id used to construct this PageMetaFactory object will be used as the Publication Id.

urlPath - The URL Path of the Page as it is stored in the Page Metadata.

Returns:

The PageMeta object with the URLPath used to perform the query in the Publication identified by publicationId. If no PageMeta matches the query, returns null;

getMetaByURL

com.tridion.meta.PageMeta getMetaByURL(String publicationURI,
                                       String urlPath)

Returns the PageMeta object in the Publication identified by the publicationURI parameter which has the URL Path as passed by the urlPath parameter.

Parameters:

publicationURI - The string representing theTCM URI of the Publication you want to search in. If 0 is used as the Publication Id, then the Publication Id used to construct this PageMetaFactory object will be used as the Publication Id.

urlPath - The URL Path of the Page as it is stored in the Page Metadata.

Returns:

The PageMeta object with the URLPath used to perform the query in the Publication identified by publicationId. If no PageMeta matches the query, returns null;