public class InvalidChannelNameException extends FaultException
Modifier and Type | Class and Description |
---|---|
static class |
InvalidChannelNameException.Reason
Flags indicating the different reasons that may have caused a channel name to be
invalid.
|
arguments, errorCode, label
Constructor and Description |
---|
InvalidChannelNameException()
Creates a new indication of a channel name issue that does not specify the reason
for the error.
|
InvalidChannelNameException(java.lang.String nameIn,
InvalidChannelNameException.Reason reasonIn)
Creates a new indication that a given channel name is invalid.
|
InvalidChannelNameException(java.lang.String nameIn,
InvalidChannelNameException.Reason reasonIn,
java.lang.String messageIdIn,
java.lang.String argIn)
Creates a new indication that a given channel name is invalid.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getName() |
InvalidChannelNameException.Reason |
getReason() |
create, getArgs, getErrorCode, getLabel, setArgs, setErrorCode, setLabel
public InvalidChannelNameException()
Ideally, this won't be used frequently. This was kept in to support current uses that don't fit into the idea of validating if a name can be used in a channel creation/edit.
public InvalidChannelNameException(java.lang.String nameIn, InvalidChannelNameException.Reason reasonIn)
nameIn
- name the user attempted to give the channelreasonIn
- flag indicating why the channel name is invalid; cannot be
null
public InvalidChannelNameException(java.lang.String nameIn, InvalidChannelNameException.Reason reasonIn, java.lang.String messageIdIn, java.lang.String argIn)
nameIn
- name the user attempted to give the channelreasonIn
- flag indicating why the channel name is invalid; cannot be
null
messageIdIn
- the string resource message IDargIn
- an optional argument that is associated with messageId. If there
is no argument, pass in an empty string.public java.lang.String getName()
null
public InvalidChannelNameException.Reason getReason()
getName()
invalid; may be null