com.genesyslab.omsdk.mil
Class MILStopProcessingReason

java.lang.Object
  extended bycom.genesyslab.omsdk.mil.MILStopProcessingReason

public class MILStopProcessingReason
extends java.lang.Object

Placeholder for reason parameters associated with StopProcessing requests to Interaction Server.

Genesys recommends that you use predefined reasons available in the Configuration Layer. These predefined reasons are business attribute values of type "StopProcessing Reason".

To get a MILStopProcessingReason instance for a predefined reason, use createXXX(int code) static method of this class.

Since:
7.1.000.000

Constructor Summary
MILStopProcessingReason(int code, java.lang.String name, java.lang.String description)
          Constructor.
 
Method Summary
static MILStopProcessingReason createAbandoned(int code)
          Creates a MILStopProcessingReason instance named Abandoned, having the following description: "StopProcessing Reason Abandoned".
static MILStopProcessingReason createAutoResponded(int code)
          Creates a MILStopProcessingReason instance named Auto Responded, having the following description: "StopProcessing Reason Auto Responded".
static MILStopProcessingReason createForwarded(int code)
          Creates a MILStopProcessingReason instance named Forwarded, having the following description: "StopProcessing Reason Forwarded".
static MILStopProcessingReason createNormal(int code)
          Creates a MILStopProcessingReason instance named Normal, having the following description: "StopProcessing Reason Auto Normal".
static MILStopProcessingReason createRedirected(int code)
          Creates a MILStopProcessingReason instance named Re-directed, having the following description: "StopProcessing Reason Re-directed".
static MILStopProcessingReason createSent(int code)
          Creates a MILStopProcessingReason instance named Sent, having the following description: "StopProcessing Reason Sent".
static MILStopProcessingReason createTerminated(int code)
          Creates a MILStopProcessingReason instance named Terminated, having the following description: "StopProcessing Reason Terminated".
 int getCode()
          Returns the reason code.
 java.lang.String getDescription()
          Returns the reason description.
 java.lang.String getName()
          Returns the reason name.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MILStopProcessingReason

public MILStopProcessingReason(int code,
                               java.lang.String name,
                               java.lang.String description)
Constructor.

For predefined reasons, use createXXX methods.

Parameters:
code - reason code; this code is specific to your application, not used by framework.
name - the reason name.
description - the reason description.
Method Detail

getCode

public int getCode()
Returns the reason code.

This reason code can be specific to the application.

Returns:
the reason code.

getName

public java.lang.String getName()
Returns the reason name.

Returns:
the reason name.

getDescription

public java.lang.String getDescription()
Returns the reason description.

Returns:
the reason description.

createAutoResponded

public static MILStopProcessingReason createAutoResponded(int code)
Creates a MILStopProcessingReason instance named Auto Responded, having the following description: "StopProcessing Reason Auto Responded".

Parameters:
code - the reason code; can be application-specific.
Returns:
a MILStopProcessingReason instance for the Auto Responded reason.

createForwarded

public static MILStopProcessingReason createForwarded(int code)
Creates a MILStopProcessingReason instance named Forwarded, having the following description: "StopProcessing Reason Forwarded".

Parameters:
code - the reason code; can be application-specific.
Returns:
a MILStopProcessingReason instance for the Forwarded reason.

createNormal

public static MILStopProcessingReason createNormal(int code)
Creates a MILStopProcessingReason instance named Normal, having the following description: "StopProcessing Reason Auto Normal".

Parameters:
code - the reason code; can be application-specific.
Returns:
a MILStopProcessingReason instance for the Normal reason.

createRedirected

public static MILStopProcessingReason createRedirected(int code)
Creates a MILStopProcessingReason instance named Re-directed, having the following description: "StopProcessing Reason Re-directed".

Parameters:
code - the reason code; can be application-specific.
Returns:
a MILStopProcessingReason instance for the Re-directed reason.

createSent

public static MILStopProcessingReason createSent(int code)
Creates a MILStopProcessingReason instance named Sent, having the following description: "StopProcessing Reason Sent".

Parameters:
code - the reason code; can be application-specific.
Returns:
a MILStopProcessingReason instance for the Sent reason.

createTerminated

public static MILStopProcessingReason createTerminated(int code)
Creates a MILStopProcessingReason instance named Terminated, having the following description: "StopProcessing Reason Terminated".

Parameters:
code - the reason code; can be application-specific.
Returns:
a MILStopProcessingReason instance for the Terminated reason.

createAbandoned

public static MILStopProcessingReason createAbandoned(int code)
Creates a MILStopProcessingReason instance named Abandoned, having the following description: "StopProcessing Reason Abandoned".

Parameters:
code - the reason code; can be application-specific.
Returns:
a MILStopProcessingReason instance for the Abandoned reason.