Package com.redwood.scheduler.api.model

Interface FileEvent

All Superinterfaces:

Detail, EventSource, Readable, SchedulerEntity, SchedulerEntityComp

public interface FileEvent
extends EventSource, Readable

Information about the file that triggered the parent Event. This class contains no reference to the FileEventDefinition which caused it to be created; instead the relevant information is copied across. (This prevents foreign-key violations and confusion when the FileEventDefinition is changed or deleted.)

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "FileEvent" objects.
static String	SEC_RANK_ALL	This rank is made of the following privileges:
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static QueryObjectType<FileEvent>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM

Method Summary

Modifier and Type	Method	Description
String	getDirectory()	Get the value for Directory.
String	getFinalPath()	Get the value for FinalPath.
String	getMoveDirectory()	Get the value for MoveDirectory.
String	getOriginalPath()	Get the value for OriginalPath.
String	getPattern()	Get the value for Pattern.
Long	getPollInterval()	Get the value for PollInterval.
ProcessServer	getProcessServer()	Get the ProcessServer.
boolean	isCheckLock()	Get the value for CheckLock.
void	setFinalPath(String newFinalPath)	Set the value for FinalPath.
void	setOriginalPath(String newOriginalPath)	Set the value for OriginalPath.
void	setProcessServer(ProcessServer newProcessServer)	Set the value for ProcessServer.

Methods inherited from interface com.redwood.scheduler.api.model.EventSource

getEvent

Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

canPerform, createSubjectObjectPrivilegeGrant, deleteObject, getAuditTrail, getAuditTrailSize, getBehavior, getEffectiveBehavior, getErrorNameEN, getErrorNameKey, getLLPVersion, getLOV, getLOVSupport, getObjectType, getParentSchedulerEntities, getRuntime, getSubjectObjectPrivilegeGrantBySubject, getSubjectObjectPrivilegeGrants, getUniqueId, getUrl, getUrl, isCreated, isDeletable, isDeleted, isModifiable, isModified, isSelectVersioned, processRelatedObjects, processRelatedObjects, processRelatedObjects, refreshObject, resetObject, resetObject, resetValuesToDefault, selectForRead

Field Detail

OBJECT_TYPE

static final String OBJECT_TYPE

String that will be returned from SchedulerEntity.getObjectType() for "FileEvent" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<FileEvent> TYPE

Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges:

See Also:

Constant Field Values

Method Detail

getDirectory

String getDirectory()

Get the value for Directory. (Original directory that contained the file for this FileEvent.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getFinalPath

String getFinalPath()

Get the value for FinalPath. (Path of the file after the file was detected.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getPattern

String getPattern()

Get the value for Pattern. (Pattern matched by the file for this FileEvent.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getMoveDirectory

String getMoveDirectory()

Get the value for MoveDirectory. (Directory where the file for this FileEvent.)

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getOriginalPath

String getOriginalPath()

Get the value for OriginalPath. (Original path of file that caused this FileEvent.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getPollInterval

Long getPollInterval()

Get the value for PollInterval. (Polling interval in use when the file for this FileEvent was detected.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

isCheckLock

boolean isCheckLock()

Get the value for CheckLock. ( Whether a check was made for if the file for this FileEvent was in use when the event was raised. )

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setFinalPath

void setFinalPath(String newFinalPath)

Set the value for FinalPath. (Path of the file after the file was detected.) This value is mandatory.

Parameters:

newFinalPath - the new value for FinalPath. If this is null, then the object cannot be persisted.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setOriginalPath

void setOriginalPath(String newOriginalPath)

Set the value for OriginalPath. (Original path of file that caused this FileEvent.) This value is mandatory.

Parameters:

newOriginalPath - the new value for OriginalPath. If this is null, then the object cannot be persisted.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getProcessServer

ProcessServer getProcessServer()

Get the ProcessServer.

Returns:

ProcessServer

Throws:

com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

setProcessServer

void setProcessServer(ProcessServer newProcessServer)

Set the value for ProcessServer. This value is mandatory.

Parameters:

newProcessServer - is the object to set ProcessServer to. Which process server generated this file event. If this is null, then the object cannot be persisted.