org.dd4t.providers

Interface TaxonomyProvider

public interface TaxonomyProvider

Method Summary

Methods

Modifier and Type	Method and Description
String	getTaxonomyByURI(String taxonomyURI, boolean resolveContent) Retrieves a Taxonomy TCMURI.
String	getTaxonomyFilterBySchema(String taxonomyURI, String schemaURI) Retrieves a Taxonomy TCMURI.

Method Detail

getTaxonomyByURI

String getTaxonomyByURI(String taxonomyURI,
                      boolean resolveContent)
                        throws ItemNotFoundException,
                               SerializationException

Retrieves a Taxonomy TCMURI. It returns a Keyword object representing the root taxonomy node with all the parent/ children relationships resolved.

Parameters:

taxonomyURI - String representing the TCMURI of the taxonomy to retrieve

resolveContent - boolean indicating whether or not to resolverepresenting the context Publication id to read the Page from

Returns:

String representing the Keyword object

Throws:

ItemNotFoundException - if said taxonomy cannot be found

SerializationException - if response from service does not represent a serialized Keyword object

getTaxonomyFilterBySchema

String getTaxonomyFilterBySchema(String taxonomyURI,
                               String schemaURI)
                                 throws ItemNotFoundException,
                                        SerializationException

Retrieves a Taxonomy TCMURI. It returns a Keyword object representing the root taxonomy node with all the parent/ children relationships resolved. The related items are filtered to only Components based on the given Schema URI.

Parameters:

taxonomyURI - String representing the TCMURI of the taxonomy to retrieve

schemaURI - String representing the filter for classified related Components to return for each Keyword

Returns:

String representing the Keyword object

Throws:

ItemNotFoundException - if said taxonomy cannot be found

SerializationException - if response from service does not represent a serialized Keyword object