com.sdl.web.api.meta

Interface WebPublicationMetaFactory

public interface WebPublicationMetaFactory

Provides access to PublicationMeta that can be obtained using a publication id, title, key, or any other property.

Method Summary

Modifier and Type	Method and Description
com.tridion.meta.PublicationMeta[]	getAllMeta() Finds all the PublicationMeta's.
com.tridion.meta.CustomMeta	getCustomMeta(int publicationId) Find CustomMeta's by publication key.
com.tridion.meta.CustomMeta	getCustomMeta(String publicationUri) Find CustomMeta's by publication key.
com.tridion.meta.PublicationMeta	getMeta(int publicationId) Find PublicationMeta by publication id.
com.tridion.meta.PublicationMeta	getMeta(String publicationUri) Find PublicationMeta by publication id.
com.tridion.meta.PublicationMeta[]	getMetaByKey(String key) Find PublicationMeta's by publication key.
com.tridion.meta.PublicationMeta[]	getMetaByMultimediaPath(String multimediaPath) Find PublicationMeta's by publication's multimedia path.
com.tridion.meta.PublicationMeta[]	getMetaByMultimediaUrl(String multimediaUrl) Find PublicationMeta's by publication's multimedia url.
com.tridion.meta.PublicationMeta[]	getMetaByPublicationPath(String publicationPath) Find PublicationMeta's by publication path.
com.tridion.meta.PublicationMeta[]	getMetaByPublicationUrl(String publicationUrl) Find PublicationMeta's by publication url.
com.tridion.meta.PublicationMeta[]	getMetaByTitle(String title) Find PublicationMeta's by publication title.

Method Detail

getMeta

com.tridion.meta.PublicationMeta getMeta(int publicationId)
                                  throws com.tridion.broker.StorageException

Find PublicationMeta by publication id.

Parameters:

publicationId - The publication id.

Returns:

The PublicationMeta or null if none was found.

Throws:

com.tridion.broker.StorageException - If unable to retrieve the reference data.

getMeta

com.tridion.meta.PublicationMeta getMeta(String publicationUri)
                                  throws com.tridion.broker.StorageException

Find PublicationMeta by publication id.

Parameters:

publicationUri - The publication CMUri for example

tcm:0-1-1

or

ish:0-1-1

Returns:

The PublicationMeta or null if none was found.

Throws:

com.tridion.broker.StorageException - If unable to retrieve the reference data.

getMetaByTitle

com.tridion.meta.PublicationMeta[] getMetaByTitle(String title)
                                           throws com.tridion.broker.StorageException

Find PublicationMeta's by publication title.

Parameters:

title - The publication title.

Returns:

The matching PublicationMeta's or an empty list none were found.

Throws:

com.tridion.broker.StorageException - If unable to retrieve the reference data.

getMetaByKey

com.tridion.meta.PublicationMeta[] getMetaByKey(String key)
                                         throws com.tridion.broker.StorageException

Find PublicationMeta's by publication key.

Parameters:

key - The publication key.

Returns:

The matching PublicationMeta's or an empty list none were found.

Throws:

com.tridion.broker.StorageException - If unable to retrieve the reference data.

getMetaByPublicationPath

com.tridion.meta.PublicationMeta[] getMetaByPublicationPath(String publicationPath)
                                                     throws com.tridion.broker.StorageException

Find PublicationMeta's by publication path.

Parameters:

publicationPath - The publication path.

Returns:

The matching PublicationMeta's or an empty list none were found.

Throws:

com.tridion.broker.StorageException - If unable to retrieve the reference data.

getMetaByPublicationUrl

com.tridion.meta.PublicationMeta[] getMetaByPublicationUrl(String publicationUrl)
                                                    throws com.tridion.broker.StorageException

Find PublicationMeta's by publication url.

Parameters:

publicationUrl - The publication url.

Returns:

The matching PublicationMeta's or an empty list none were found.

Throws:

com.tridion.broker.StorageException - If unable to retrieve the reference data.

getMetaByMultimediaPath

com.tridion.meta.PublicationMeta[] getMetaByMultimediaPath(String multimediaPath)
                                                    throws com.tridion.broker.StorageException

Find PublicationMeta's by publication's multimedia path.

Parameters:

multimediaPath - The publication's multimedia path.

Returns:

The matching PublicationMeta's or an empty list none were found.

Throws:

com.tridion.broker.StorageException - If unable to retrieve the reference data.

getMetaByMultimediaUrl

com.tridion.meta.PublicationMeta[] getMetaByMultimediaUrl(String multimediaUrl)
                                                   throws com.tridion.broker.StorageException

Find PublicationMeta's by publication's multimedia url.

Parameters:

multimediaUrl - The publication's multimedia url.

Returns:

The matching PublicationMeta's or an empty array none were found.

Throws:

com.tridion.broker.StorageException - If unable to retrieve the reference data.

getAllMeta

com.tridion.meta.PublicationMeta[] getAllMeta()
                                       throws com.tridion.broker.StorageException

Finds all the PublicationMeta's.

Returns:

An array of PublicationMeta's.

Throws:

com.tridion.broker.StorageException - If unable to retrieve the reference data.

getCustomMeta

com.tridion.meta.CustomMeta getCustomMeta(String publicationUri)
                                   throws com.tridion.broker.StorageException

Find CustomMeta's by publication key.

Parameters:

publicationUri - The publication key.

Returns:

The matching CustomMeta's or null if none was found.

Throws:

com.tridion.broker.StorageException - If unable to retrieve the reference data.

getCustomMeta

com.tridion.meta.CustomMeta getCustomMeta(int publicationId)
                                   throws com.tridion.broker.StorageException

Find CustomMeta's by publication key.

Parameters:

publicationId - The publication id.

Returns:

The matching CustomMeta's or null if none was found.

Throws:

com.tridion.broker.StorageException - If unable to retrieve the reference data.