Package org.cyclos.model.access.channels

Enum BuiltInChannel

java.lang.Object

java.lang.Enum<BuiltInChannel>

org.cyclos.model.access.channels.BuiltInChannel

All Implemented Interfaces:

Serializable, Comparable<BuiltInChannel>, HasMessageKey

public enum BuiltInChannel
extends Enum<BuiltInChannel>
implements HasMessageKey

Built-in channels in Cyclos

Enum Constant Summary

Enum Constants

Enum Constant	Description
EASY_INVOICE
MAIN
MOBILE
OIDC
POS
SMS
TICKET
WEB_SERVICES

Method Summary

Modifier and Type	Method	Description
static BuiltInChannel	getByInternalName(String internalName)	Returns the channel with the given internal name, or null if not found (or not a built-in channel)
String	getDisplayName()
String	getInternalName()	Returns the channel internal name
MessageKey	getMessageKey()
boolean	isSpecificEntryPoint()	Returns whether this channel has a specific entry point.
static BuiltInChannel	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BuiltInChannel[]	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

MAIN

public static final BuiltInChannel MAIN

WEB_SERVICES

public static final BuiltInChannel WEB_SERVICES

OIDC

public static final BuiltInChannel OIDC

SMS

public static final BuiltInChannel SMS

POS

public static final BuiltInChannel POS

MOBILE

public static final BuiltInChannel MOBILE

TICKET

public static final BuiltInChannel TICKET

EASY_INVOICE

public static final BuiltInChannel EASY_INVOICE

Method Detail

values

public static BuiltInChannel[] 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 (BuiltInChannel c : BuiltInChannel.values())
    System.out.println(c);

Returns:

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

valueOf

public static BuiltInChannel 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

getByInternalName

public static BuiltInChannel getByInternalName(String internalName)

Returns the channel with the given internal name, or null if not found (or not a built-in channel)

getDisplayName

public String getDisplayName()

getInternalName

public String getInternalName()

Returns the channel internal name

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey

isSpecificEntryPoint

public boolean isSpecificEntryPoint()

Returns whether this channel has a specific entry point. Those which return false allow web service callers to use the Channel header.