IWebEndpoint (formcycle: bom 8.0.4-RC.3 API)

All Superinterfaces:

Serializable

All Known Subinterfaces:

IView

All Known Implementing Classes:

EClientView, EDesignerEndpoint, EInboxEndpoint, EIncludesEndpoint, EProjectView, EProtectedView, EPublicView, ESystemView, PluginMenuEntryView
```
public interface IWebEndpoint
extends Serializable
```
Common interface that defines formcycle web endpoints with basic definitions for availability and authorization requirements. E.g. an endpoint may be a web servlet or a JSF view.

Since:

8.0.0

Author:

XIMA Media GmbH

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`IAuthorizer`	`getAuthorizer()`
`IAvailabiltyResolver`	`getAvailibilityResolver()`
`@NotEmpty String`	`getId()`
`@NotNull IUriResolver`	`getUriResolver()`

- Method Detail
  - getId
```
@NotEmpty
@NotEmpty String getId()
```
    Returns:
    
    the unique ID of this web endpoint.
  - getUriResolver
```
@NotNull
@NotNull IUriResolver getUriResolver()
```
    Returns:
    
    the uri resolver which defines the location of this endpoint.
  - getAvailibilityResolver
```
@Nullable
IAvailabiltyResolver getAvailibilityResolver()
```
    Returns:
    
    the availability resolver that defines the availability requirements of this web endpoint. May be null. If null resolver is returned than the web endpoint is available.
  - getAuthorizer
```
@Nullable
IAuthorizer getAuthorizer()
```
    Returns:
    
    the authorizer that defines authorization requirements of this web endpoint. May be null. If null authorizer is returned than the view web enpoint is public, which means any user can access it.