Trigger (Cleo VersaLex Java API)

java.lang.Object
- com.cleo.lexicom.external.pojo.trigger.Trigger

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

FileTrigger, SessionTrigger
```
public abstract class Trigger
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Trigger.Protocol` Protocol represents the list of protocols which trigger supports FTP, SSHFTP, LCOPY, HSP, AS2
`static class`	`Trigger.Status` Status represents the status of the trigger
`static class`	`Trigger.TRIGGER_TYPE` ------------- Triggers to be added in this location ------------------

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.Map`	`context` User session context at the time of the trigger
`protected java.lang.String`	`errorMessage` Errors which come while uploading/writing source file
`protected java.lang.String`	`folder`
`protected java.lang.String`	`host` The host name of the server where trigger executes
`protected java.lang.String`	`sessionId` The id of the session under which trigger executes
`protected java.lang.String`	`sourceFile` The canonical path of the uploaded file By default this is a zero length to avoid null checks everywhere
`protected Trigger.Status`	`status` The status of the trigger type fileCreatedTrigger and sessionEndTrigger It is either SUCCESS if trigger type is FileCreatedSuccess or SessionEndSuccess or FAILURE if trigger type is FileCreatedFailure or SessionEndFailure
`protected java.lang.Long`	`triggerTimestamp` Time in milliseconds when trigger executes

Constructor Summary

Constructors
Constructor and Description

Trigger()

Constructors
Constructor and Description
`Trigger()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(java.lang.Object other)`
`java.lang.Object`	`clone()` Get the clone of the trigger object
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getActionId()` Return the Id of an action on which the trigger is scheduled
`java.util.Map`	`getContext()` Get user session context at the time of the trigger
`java.lang.String`	`getErrorMessage()` Get errors/exceptions came while uploading/writing source file
`Trigger.Status`	`getExecutionStatus()` Get the execution status of the trigger It is either SUCCESS if trigger is executed successfully or NOT_VALIDATED if trigger validation fails or FAILURE if trigger is not executed
`java.lang.String`	`getFolder()`
`java.lang.String`	`getHost()` Get the Host Name
`java.lang.String`	`getScheduledType()`
`java.lang.String`	`getSessionId()` Get the session id under which trigger executes
`java.lang.String`	`getSourceFile()` Get the canonical path of the uploaded file
`Trigger.Status`	`getStatus()` Get the status of the trigger type for e.g- For fileCreatedTrigger it is either SUCCESS or FAILURE same for the sessionEndTrigger
`java.lang.String`	`getStorageLocation()` Get the path of the persistor file which stores all triggers
`java.lang.String`	`getTriggerId()` Get the unique identifier of the trigger
`java.lang.Long`	`getTriggerTimestamp()` Get the timeStamp when trigger fires
`java.lang.String`	`getType()`
`java.lang.String`	`getValidationFailedMessage()` Get the validation failed message
`int`	`hashCode()`
`void`	`setActionId(java.lang.String actionId)` Set the Id of an action on which the trigger is scheduled
`void`	`setContext(java.util.Map context)` Set user session context at the time of the trigger
`void`	`setErrorMessage(java.lang.String errorMessage)` Set errors which came while uploading/writing source file
`void`	`setExecutionStatus(Trigger.Status executionStatus)` Set the execution status of the trigger It is either SUCCESS if trigger is executed successfully or NOT_VALIDATED if trigger validation fails or FAILURE if trigger is not executed
`void`	`setFolder(java.lang.String folder)`
`void`	`setHost(java.lang.String host)` Set the Host Name
`void`	`setScheduledType(java.lang.String scheduledType)`
`void`	`setSessionId(java.lang.String sessionId)` Set the session id under which trigger executes
`void`	`setSourceFile(java.lang.String sourceFile)` Set the canonical path of the uploaded file
`void`	`setStatus(Trigger.Status status)` Set the status of the trigger type for e.g- For fileCreatedTrigger set to SUCCESS or FAILURE same for the sessionEndTrigger
`void`	`setStorageLocation(java.lang.String storageLocation)` Set the path of the persistor file which stores all triggers
`void`	`setTriggerId(java.lang.String triggerId)` The unique identifier of the trigger
`void`	`setTriggerTimestamp(java.lang.Long triggerTimestamp)` Set the timeStamp when trigger fires
`void`	`setType(java.lang.String type)`
`void`	`setValidationFailedMessage(java.lang.String validationFailedMessage)` Set the proper message when any validation failed and trigger was not able to execute
`java.util.Map<java.lang.String,java.lang.String>`	`toMap()` Convert Trigger object to a Map representation
`java.lang.String`	`toString()` Convert trigger object to its string representation

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - sourceFile
```
protected java.lang.String sourceFile
```
    The canonical path of the uploaded file By default this is a zero length to avoid null checks everywhere
  - status
```
protected Trigger.Status status
```
    The status of the trigger type fileCreatedTrigger and sessionEndTrigger It is either SUCCESS if trigger type is FileCreatedSuccess or SessionEndSuccess or FAILURE if trigger type is FileCreatedFailure or SessionEndFailure
  - host
```
protected java.lang.String host
```
    The host name of the server where trigger executes
  - sessionId
```
protected java.lang.String sessionId
```
    The id of the session under which trigger executes
  - errorMessage
```
protected java.lang.String errorMessage
```
    Errors which come while uploading/writing source file
  - context
```
protected java.util.Map context
```
    User session context at the time of the trigger
  - triggerTimestamp
```
protected java.lang.Long triggerTimestamp
```
    Time in milliseconds when trigger executes
  - folder
```
protected java.lang.String folder
```
- Constructor Detail
  - Trigger
```
public Trigger()
```
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Convert trigger object to its string representation
    
    Overrides:
    
    toString in class java.lang.Object
  - toMap
```
public java.util.Map<java.lang.String,java.lang.String> toMap()
```
    Convert Trigger object to a Map representation
    
    Returns:
    
    Returns a Map representation of the trigger.
  - getTriggerId
```
public java.lang.String getTriggerId()
```
    Get the unique identifier of the trigger
    
    Returns:
    
    id of the Trigger
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Get the clone of the trigger object
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    clone of trigger object
    
    Throws:
    
    java.lang.CloneNotSupportedException
  - getType
```
public java.lang.String getType()
```
  - getTriggerTimestamp
```
public java.lang.Long getTriggerTimestamp()
```
    Get the timeStamp when trigger fires
    
    Returns:
    
    timeStamp in milliseconds
  - getScheduledType
```
public java.lang.String getScheduledType()
```
  - setTriggerId
```
public void setTriggerId(java.lang.String triggerId)
```
    The unique identifier of the trigger
  - setTriggerTimestamp
```
public void setTriggerTimestamp(java.lang.Long triggerTimestamp)
```
    Set the timeStamp when trigger fires
    
    Parameters:
    
    triggerTimestamp - timeStamp in milliseconds
  - setType
```
public void setType(java.lang.String type)
```
  - setScheduledType
```
public void setScheduledType(java.lang.String scheduledType)
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getStorageLocation
```
public java.lang.String getStorageLocation()
```
    Get the path of the persistor file which stores all triggers
    
    Returns:
    
    path of persistor file
  - setStorageLocation
```
public void setStorageLocation(java.lang.String storageLocation)
```
    Set the path of the persistor file which stores all triggers
    
    Parameters:
    
    storageLocation - path of the file
  - getActionId
```
public java.lang.String getActionId()
```
    Return the Id of an action on which the trigger is scheduled
    
    Returns:
    
    the Id of an action on which the trigger is scheduled
  - setActionId
```
public void setActionId(java.lang.String actionId)
```
    Set the Id of an action on which the trigger is scheduled
    
    Parameters:
    
    actionId - Id of an action on which the trigger is scheduled
  - getExecutionStatus
```
public Trigger.Status getExecutionStatus()
```
    Get the execution status of the trigger It is either SUCCESS if trigger is executed successfully or NOT_VALIDATED if trigger validation fails or FAILURE if trigger is not executed
    
    Returns:
    
    Execution status of the trigger
  - setExecutionStatus
```
public void setExecutionStatus(Trigger.Status executionStatus)
```
    Set the execution status of the trigger It is either SUCCESS if trigger is executed successfully or NOT_VALIDATED if trigger validation fails or FAILURE if trigger is not executed
    
    Parameters:
    
    executionStatus - either SUCCESS, FAILURE or NOT_VALIDATED
  - getValidationFailedMessage
```
public java.lang.String getValidationFailedMessage()
```
    Get the validation failed message
    
    Returns:
    
    validation failed message
  - setValidationFailedMessage
```
public void setValidationFailedMessage(java.lang.String validationFailedMessage)
```
    Set the proper message when any validation failed and trigger was not able to execute
    
    Parameters:
    
    validationFailedMessage - validation failed message
  - getSourceFile
```
public java.lang.String getSourceFile()
```
    Get the canonical path of the uploaded file
    
    Returns:
    
    path of the source file
  - setSourceFile
```
public void setSourceFile(java.lang.String sourceFile)
```
    Set the canonical path of the uploaded file
    
    Parameters:
    
    sourceFile - location of the source file
  - getStatus
```
public Trigger.Status getStatus()
```
    Get the status of the trigger type for e.g- For fileCreatedTrigger it is either SUCCESS or FAILURE same for the sessionEndTrigger
    
    Returns:
    
    status of the trigger type
  - setStatus
```
public void setStatus(Trigger.Status status)
```
    Set the status of the trigger type for e.g- For fileCreatedTrigger set to SUCCESS or FAILURE same for the sessionEndTrigger
    
    Parameters:
    
    status - either SUCCESS or FAILURE
  - getHost
```
public java.lang.String getHost()
```
    Get the Host Name
    
    Returns:
    
    Host Name of the server
  - setHost
```
public void setHost(java.lang.String host)
```
    Set the Host Name
    
    Parameters:
    
    host - Name of the server
  - getSessionId
```
public java.lang.String getSessionId()
```
    Get the session id under which trigger executes
    
    Returns:
    
    session ID
  - setSessionId
```
public void setSessionId(java.lang.String sessionId)
```
    Set the session id under which trigger executes
    
    Parameters:
    
    sessionId - session ID
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
    Get errors/exceptions came while uploading/writing source file
    
    Returns:
    
    errors or exceptions
  - setErrorMessage
```
public void setErrorMessage(java.lang.String errorMessage)
```
    Set errors which came while uploading/writing source file
    
    Parameters:
    
    errorMessage - errors or exceptions
  - getContext
```
public java.util.Map getContext()
```
    Get user session context at the time of the trigger
    
    Returns:
    
    user session context
  - setContext
```
public void setContext(java.util.Map context)
```
    Set user session context at the time of the trigger
    
    Parameters:
    
    sessionContext - user session context
  - getFolder
```
public java.lang.String getFolder()
```
  - setFolder
```
public void setFolder(java.lang.String folder)
```

Class Trigger

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sourceFile

status

host

sessionId

errorMessage

context

triggerTimestamp

folder

Constructor Detail

Trigger

Method Detail

toString

toMap

getTriggerId

clone

getType

getTriggerTimestamp

getScheduledType

setTriggerId

setTriggerTimestamp

setType

setScheduledType

equals

canEqual

hashCode

getStorageLocation

setStorageLocation

getActionId

setActionId

getExecutionStatus

setExecutionStatus

getValidationFailedMessage

setValidationFailedMessage

getSourceFile

setSourceFile

getStatus

setStatus

getHost

setHost

getSessionId

setSessionId

getErrorMessage

setErrorMessage

getContext

setContext

getFolder

setFolder