Package csw.params.commands

Interface CommandIssue

All Known Implementing Classes:

CommandIssue.AssemblyBusyIssue, CommandIssue.HCDBusyIssue, CommandIssue.IdNotAvailableIssue, CommandIssue.MissingKeyIssue, CommandIssue.OtherIssue, CommandIssue.ParameterValueOutOfRangeIssue, CommandIssue.RequiredAssemblyUnavailableIssue, CommandIssue.RequiredHCDUnavailableIssue, CommandIssue.RequiredSequencerUnavailableIssue, CommandIssue.RequiredServiceUnavailableIssue, CommandIssue.UnresolvedLocationsIssue, CommandIssue.UnsupportedCommandInStateIssue, CommandIssue.UnsupportedCommandIssue, CommandIssue.WrongCommandTypeIssue, CommandIssue.WrongInternalStateIssue, CommandIssue.WrongNumberOfParametersIssue, CommandIssue.WrongParameterTypeIssue, CommandIssue.WrongPrefixIssue, CommandIssue.WrongUnitsIssue

public interface CommandIssue

Describes a command issue with appropriate reason for validation failure

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CommandIssue.AssemblyBusyIssue	Returned when an Assembly receives a command and one is already executing
static class	CommandIssue.AssemblyBusyIssue$
static final class	CommandIssue.HCDBusyIssue	A required HCD is busy and cannot be used
static class	CommandIssue.HCDBusyIssue$
static final class	CommandIssue.IdNotAvailableIssue	Returned when a CommandResponse associated with runId is not available
static class	CommandIssue.IdNotAvailableIssue$
static final class	CommandIssue.MissingKeyIssue	Returned when a command is missing a required key/parameter
static class	CommandIssue.MissingKeyIssue$
static final class	CommandIssue.OtherIssue	Returned when some other issue occurred apart from those already defined
static class	CommandIssue.OtherIssue$
static final class	CommandIssue.ParameterValueOutOfRangeIssue	Parameter of a command is out of range
static class	CommandIssue.ParameterValueOutOfRangeIssue$
static final class	CommandIssue.RequiredAssemblyUnavailableIssue	A required Assembly is not available
static class	CommandIssue.RequiredAssemblyUnavailableIssue$
static final class	CommandIssue.RequiredHCDUnavailableIssue	A required HCD is not available
static class	CommandIssue.RequiredHCDUnavailableIssue$
static final class	CommandIssue.RequiredSequencerUnavailableIssue	A required Sequencer is not available
static class	CommandIssue.RequiredSequencerUnavailableIssue$
static final class	CommandIssue.RequiredServiceUnavailableIssue	A required service is not available
static class	CommandIssue.RequiredServiceUnavailableIssue$
static final class	CommandIssue.UnresolvedLocationsIssue	Returned when some required location is not available
static class	CommandIssue.UnresolvedLocationsIssue$
static final class	CommandIssue.UnsupportedCommandInStateIssue	A command is unsupported in the current state
static class	CommandIssue.UnsupportedCommandInStateIssue$
static final class	CommandIssue.UnsupportedCommandIssue	A command is unsupported by component
static class	CommandIssue.UnsupportedCommandIssue$
static final class	CommandIssue.WrongCommandTypeIssue	Returned when some given command type is not expected
static class	CommandIssue.WrongCommandTypeIssue$
static final class	CommandIssue.WrongInternalStateIssue	The component is in the wrong internal state to handle a command
static class	CommandIssue.WrongInternalStateIssue$
static final class	CommandIssue.WrongNumberOfParametersIssue	Returned when a command does not have the correct number of parameters
static class	CommandIssue.WrongNumberOfParametersIssue$
static final class	CommandIssue.WrongParameterTypeIssue	Returned when the parameter for a key is not the correct type (i.e.
static class	CommandIssue.WrongParameterTypeIssue$
static final class	CommandIssue.WrongPrefixIssue	Returned when an Assembly receives a configuration with a Prefix that it doesn't support
static class	CommandIssue.WrongPrefixIssue$
static final class	CommandIssue.WrongUnitsIssue	Returned when a parameter value does not have the correct units
static class	CommandIssue.WrongUnitsIssue$

Method Summary

Modifier and Type	Method	Description
String	reason()	A method to access the reason of command issue

Method Details

reason

String reason()

A method to access the reason of command issue

Returns:

the reason for a command issue