Package de.xima.fc.user_portal.route

Enum EUserPortalPortalView

java.lang.Object

java.lang.Enum<EUserPortalPortalView>

de.xima.fc.user_portal.route.EUserPortalPortalView

All Implemented Interfaces:

IAnyUserPortalRoute, IUserPortalRoute<IRoutingContext.IPortalRoutingContext>, Serializable, Comparable<EUserPortalPortalView>

public enum EUserPortalPortalView
extends Enum<EUserPortalPortalView>
implements IUserPortalRoute<IRoutingContext.IPortalRoutingContext>

Views for the user portal that require a portal alias to be specified.

Since:

8.2.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
PROTECTED_DASHBOARD
PROTECTED_FORM_RECORDS
PROTECTED_FORMS
PROTECTED_MESSAGES
PUBLIC_FORMS
PUBLIC_SIGN_IN
PUBLIC_WELCOME

Method Summary

Modifier and Type	Method	Description
int	defaultStatusCode()	The default HTTP status code to return.
String	id()	Gets the ID of this route.
org.ocpsoft.rewrite.servlet.config.HttpConfigurationProvider	rewriteConfigurator()	Gets the configurator for the configuring rewrite rules for this route.
IUserPortalRouterUrlHandler<IRoutingContext.IPortalRoutingContext>	urlHandler()	Gets the URL handler for this route.
static EUserPortalPortalView	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EUserPortalPortalView[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PUBLIC_WELCOME

public static final EUserPortalPortalView PUBLIC_WELCOME

PUBLIC_FORMS

public static final EUserPortalPortalView PUBLIC_FORMS

PUBLIC_SIGN_IN

public static final EUserPortalPortalView PUBLIC_SIGN_IN

PROTECTED_FORMS

public static final EUserPortalPortalView PROTECTED_FORMS

PROTECTED_DASHBOARD

public static final EUserPortalPortalView PROTECTED_DASHBOARD

PROTECTED_MESSAGES

public static final EUserPortalPortalView PROTECTED_MESSAGES

PROTECTED_FORM_RECORDS

public static final EUserPortalPortalView PROTECTED_FORM_RECORDS

Method Detail

values

public static EUserPortalPortalView[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EUserPortalPortalView c : EUserPortalPortalView.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EUserPortalPortalView valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

defaultStatusCode

public int defaultStatusCode()

Description copied from interface: IAnyUserPortalRoute

The default HTTP status code to return. Defaults to 200.

Specified by:

defaultStatusCode in interface IAnyUserPortalRoute

Returns:

The default HTTP status code.

id

public String id()

Description copied from interface: IAnyUserPortalRoute

Gets the ID of this route.

Specified by:

id in interface IAnyUserPortalRoute

Returns:

The ID.

rewriteConfigurator

public org.ocpsoft.rewrite.servlet.config.HttpConfigurationProvider rewriteConfigurator()

Description copied from interface: IAnyUserPortalRoute

Gets the configurator for the configuring rewrite rules for this route.

Specified by:

rewriteConfigurator in interface IAnyUserPortalRoute

Returns:

The rewrite configurator.

urlHandler

public IUserPortalRouterUrlHandler<IRoutingContext.IPortalRoutingContext> urlHandler()

Description copied from interface: IAnyUserPortalRoute

Gets the URL handler for this route.

Specified by:

urlHandler in interface IAnyUserPortalRoute

Specified by:

urlHandler in interface IUserPortalRoute<IRoutingContext.IPortalRoutingContext>

Returns:

The URL handler.