com.cleo.lexicom.external

Interface ISchedule.Item

Enclosing interface:

ISchedule

public static interface ISchedule.Item

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ISchedule.Item.Calendar

Method Summary

Modifier and Type	Method and Description
ISchedule.Item.Calendar	addCalendar() Adds a new run calendar to the item
void	addTrigger(Trigger.TRIGGER_TYPE trigger) Adds the trigger to the item's schedule
void	addTriggers(java.util.Set<Trigger.TRIGGER_TYPE> trigger) Add the set of triggers to the item's schedule Currently 4 types of triggers are supported - New File Creation Success - New File Creation Failure - User Session End Success - User Session End Failure
void	clearCalendars() Clear all of the run calendars for this item
java.lang.String[]	getAction() Get the alias path of the scheduled action
com.cleo.lexicom.beans.IAction	getBean() Get the bean object associated with this item
java.util.Date	getNextScheduled() Get the next scheduled value for the action's schedule
java.lang.String	getPeriod() Get the scheduling period
java.util.Set<Trigger.TRIGGER_TYPE>	getScheduledTriggers() Get the scheduled triggers for the item.
java.lang.String	getTimezone() Get the timezone for the action's schedule
boolean	isContinous() Indicates if the item is scheduled to run continuously
boolean	isOnlyIfFile() Indicates if the item should run only if there is a file detected to send (or copy or check)
boolean	isValidAction() Return true if the action has at least one PUT/LCOPY present in the ccommad
java.util.List<ISchedule.Item.Calendar>	listCalendars() Get the list of run calendars for the item.
void	removeTriggers() Removes all the scheduled triggers for the item.
void	setActionState(boolean valid) Set the action state to true if at least one PUT/LCOPY is present in the command
void	setOnlyIfFile(boolean onlyIfFile, boolean continuous) Set whether the item should run only if there is a file detected to send (or copy or check)
void	setPeriod(java.lang.String period) Set the scheduling period
void	setTimezone(java.lang.String timezone) Set the timezone for the action's schedule

Method Detail

getAction

java.lang.String[] getAction()

Get the alias path of the scheduled action

Returns:

the alias path of the scheduled action

listCalendars

java.util.List<ISchedule.Item.Calendar> listCalendars()

Get the list of run calendars for the item. More than one run calendar can exist for an item as long as the run days in the calendars do not overlap

Returns:

the list of run calendars for the item

isOnlyIfFile

boolean isOnlyIfFile()

Indicates if the item should run only if there is a file detected to send (or copy or check)

Returns:

true if the item should run only if there is a file detected to send

isContinous

boolean isContinous()

Indicates if the item is scheduled to run continuously

Returns:

true if the item is scheduled to run continuously

getPeriod

java.lang.String getPeriod()

Get the scheduling period

Returns:

either WEEKLY, MONTHLY, or ONE_TIME

isValidAction

boolean isValidAction()

Return true if the action has at least one PUT/LCOPY present in the ccommad

Returns:

true or false

setOnlyIfFile

void setOnlyIfFile(boolean onlyIfFile,
                   boolean continuous)
            throws java.lang.Exception

Set whether the item should run only if there is a file detected to send (or copy or check)

Parameters:

onlyIfFile - true if the item should run if and only if there is a file to send

continuous - true if the item should be scheduled to look for a file to send continously

Throws:

java.lang.Exception

setPeriod

void setPeriod(java.lang.String period)

Set the scheduling period

Parameters:

period - either WEEKLY, MONTHLY, or ONE_TIME

setActionState

void setActionState(boolean valid)

Set the action state to true if at least one PUT/LCOPY is present in the command

Parameters:

valid - true or false

addCalendar

ISchedule.Item.Calendar addCalendar()

Adds a new run calendar to the item

Returns:

the new run calendar

clearCalendars

void clearCalendars()

Clear all of the run calendars for this item

setTimezone

void setTimezone(java.lang.String timezone)
          throws java.lang.Exception

Set the timezone for the action's schedule

Parameters:

timezone - the timezone for the action's schedule. Valid values correspond to Java 8 java.time.ZoneId (e.g. America/Chicago or Europe/Paris)

Throws:

java.lang.Exception - if the timezone value is invalid

getTimezone

java.lang.String getTimezone()

Get the timezone for the action's schedule

Returns:

the timezone for the action's schedule. Valid values correspond to Java 8 java.time.ZoneId (e.g. America/Chicago or Europe/Paris)

getNextScheduled

java.util.Date getNextScheduled()

Get the next scheduled value for the action's schedule

Returns:

the next scheduled value for the action's schedule.

getBean

com.cleo.lexicom.beans.IAction getBean()

Get the bean object associated with this item

Returns:

the bean object associated with this item.

addTriggers

void addTriggers(java.util.Set<Trigger.TRIGGER_TYPE> trigger)

Add the set of triggers to the item's schedule Currently 4 types of triggers are supported - New File Creation Success - New File Creation Failure - User Session End Success - User Session End Failure

Parameters:

trigger - the set of triggers to add

addTrigger

void addTrigger(Trigger.TRIGGER_TYPE trigger)

Adds the trigger to the item's schedule

Parameters:

trigger - the trigger to add

getScheduledTriggers

java.util.Set<Trigger.TRIGGER_TYPE> getScheduledTriggers()

Get the scheduled triggers for the item.

Returns:

the set of scheduled triggers

removeTriggers

void removeTriggers()

Removes all the scheduled triggers for the item.