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

Interface WebCmsTypeSpecifierService

public interface WebCmsTypeSpecifierService

Service for retrieving WebCmsTypeSpecifier instances. Inspects the multi-domain configuration to determine which domains should be investigated for finding the type specifiers.

Since:

0.0.3

Author:

Arne Vandamme

Method Summary

Modifier and Type	Method and Description
WebCmsTypeSpecifier<?>	getTypeSpecifier(String objectId) Finds the type specifier with that object id.
<T extends WebCmsTypeSpecifier> T	getTypeSpecifier(String objectId, Class<T> expectedType) Finds the type specifier with that object id, assuming it is of the expected java type.
<T extends WebCmsTypeSpecifier> T	getTypeSpecifierByKey(String typeKey, Class<T> expectedType) Finds the type specifier represented by the type key, assuming it is of the expected java type.
<T extends WebCmsTypeSpecifier> T	getTypeSpecifierByKey(String typeKey, Class<T> expectedType, WebCmsDomain domain) Finds the type specifier represented by the type key, assuming it is of the expected java type.

Method Detail

getTypeSpecifier

WebCmsTypeSpecifier<?> getTypeSpecifier(String objectId)

Finds the type specifier with that object id.

Parameters:

objectId - the type specifier has

Returns:

type specifier or null if not found

getTypeSpecifier

<T extends WebCmsTypeSpecifier> T getTypeSpecifier(String objectId,
                                                   Class<T> expectedType)

Finds the type specifier with that object id, assuming it is of the expected java type. If type exists but not of the specified type, an IllegalArgumentException will be thrown.

Type Parameters:

T - expected type

Parameters:

objectId - the type specifier has

expectedType - the type should have

Returns:

type specifier or null if not found

getTypeSpecifierByKey

<T extends WebCmsTypeSpecifier> T getTypeSpecifierByKey(String typeKey,
                                                        Class<T> expectedType)

Finds the type specifier represented by the type key, assuming it is of the expected java type. Requires all types to be registered in the WebCmsTypeRegistry.

Will inspect the multi-domain configuration and use the current domain as well as fallback to no-domain if allowed for that type.

Type Parameters:

T - expected type

Parameters:

typeKey - of the type

expectedType - output

Returns:

type specifier or null if not found

getTypeSpecifierByKey

<T extends WebCmsTypeSpecifier> T getTypeSpecifierByKey(String typeKey,
                                                        Class<T> expectedType,
                                                        WebCmsDomain domain)

Finds the type specifier represented by the type key, assuming it is of the expected java type. Requires all types to be registered in the WebCmsTypeRegistry.

Will inspect the multi-domain configuration and use the current domain as well as fallback to no-domain if allowed for that type.

Type Parameters:

T - expected type

Parameters:

typeKey - of the type

expectedType - output

domain - to look for the type

Returns:

type specifier or null if not found