com.foreach.across.modules.webcms.domain.endpoint.web.context

Interface WebCmsEndpointContext

All Known Subinterfaces:

ConfigurableWebCmsEndpointContext

All Known Implementing Classes:

DefaultWebCmsEndpointContext

public interface WebCmsEndpointContext

Represents the resolved WebCmsEndpoint for the current request.

Since:

0.0.1

Author:

Sander Van Loock

Method Summary

Modifier and Type	Method and Description
WebCmsEndpoint	getEndpoint()
<T extends WebCmsEndpoint> T	getEndpoint(Class<T> endpointType)
WebCmsUrl	getUrl()
boolean	isAvailable() Returns true if and only if this context is resolved and an endpoint was found.
<T extends WebCmsEndpoint> boolean	isOfType(Class<T> endpointType)
boolean	isPreviewMode()

Method Detail

getUrl

WebCmsUrl getUrl()

Returns:

url that was used for resolving the endpoint

getEndpoint

WebCmsEndpoint getEndpoint()

Returns:

resolved endpoint

getEndpoint

<T extends WebCmsEndpoint> T getEndpoint(Class<T> endpointType)

Type Parameters:

T - endpoint type

Parameters:

endpointType - to coerce to

Returns:

resolved endpoint as type

isAvailable

boolean isAvailable()

Returns true if and only if this context is resolved and an endpoint was found.

isPreviewMode

boolean isPreviewMode()

Returns:

true if the context is rendered in preview mode - in this case isAvailable() should also return true

isOfType

<T extends WebCmsEndpoint> boolean isOfType(Class<T> endpointType)

Returns:

true if the context is available and of the expected type