com.foreach.across.modules.webcms.domain.domain

Interface WebCmsDomainService

All Known Subinterfaces:

WebCmsMultiDomainService

public interface WebCmsDomainService

Core API for retrieving domain data, with caching support. If you want to use domain-aware methods in a multi-domain context, you should use the WebCmsMultiDomainService instead. The latter extends this interface.

Since:

0.0.3

Author:

Arne Vandamme

See Also:

WebCmsMultiDomainService

Method Summary

Modifier and Type	Method and Description
WebCmsDomain	getDomain(String objectId) Get the domain with that object id.
WebCmsDomain	getDomainByKey(String domainKey) Get the domain with the specified domain key.
<U> U	getMetadataForDomain(WebCmsDomain domain, Class<U> metadataType) Retrieve the metadata for a specific domain.

Method Detail

getDomain

WebCmsDomain getDomain(String objectId)

Get the domain with that object id.

Parameters:

objectId - of the domain

Returns:

domain or null if not found

getDomainByKey

WebCmsDomain getDomainByKey(String domainKey)

Get the domain with the specified domain key.

Parameters:

domainKey - of the domain

Returns:

domain or null if not found

getMetadataForDomain

<U> U getMetadataForDomain(WebCmsDomain domain,
                           Class<U> metadataType)

Retrieve the metadata for a specific domain. Coerce it to the given type. A ClassCastException will be thrown if the metadata is not of the right type.

Parameters:

domain - or null for the no-domain

metadataType - type the metadata should have

Returns:

metadata or null if none available