com.basis.api.admin

Interface BBjAdminReplicationTaskGroup

All Superinterfaces:

BBjAdminPropertyReader, BBjAdminPropertyWriter, java.rmi.Remote

public interface BBjAdminReplicationTaskGroup
extends BBjAdminPropertyWriter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATE
static java.lang.String	DAY_OF_MONTH
static java.lang.String	DAY_OF_WEEK
static java.lang.String	NAME
static java.lang.String	REPLICATION_JOB_ID
static java.lang.String	TIME

Method Summary

Modifier and Type	Method and Description
boolean	executeIfAppropriate() Call this method to execute the scheduled task and its items if it is the appropriate time according to its configuration.
BBjAdminReplicationJob	getJob() Returns the replication job associated with this task group.
java.lang.String	getSchedulingDescription() Returns a human readable description of the scheduling for this group.
BBjAdminList<BBjAdminReplicationTask>	getTasks() Returns a list of tasks within this group.
BBjAdminReplicationTask	newTask(BBjAdminReplicationTask.TaskType p_type) Creates a new instance of a task but does NOT add it to the list of tasks.
void	setJob(BBjAdminReplicationJob p_job) Sets the replication job associated with this task group.
void	setTasks(BBjAdminList<BBjAdminReplicationTask> p_tasks)

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyWriter

addType, canAddNewProperties, canClear, clear, clearProperties, clearProperty, getReadOnly, hasChanged, isReadOnly, setBoolean, setDouble, setInt, setList, setLong, setProperties, setString, setValue

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyReader

checkValueEqual, contains, contains, getBoolean, getDouble, getInt, getList, getLong, getProperties, getString, getType, getTypes, getValue

Field Detail

REPLICATION_JOB_ID

static final java.lang.String REPLICATION_JOB_ID

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

DAY_OF_WEEK

static final java.lang.String DAY_OF_WEEK

See Also:

Constant Field Values

TIME

static final java.lang.String TIME

See Also:

Constant Field Values

DATE

static final java.lang.String DATE

See Also:

Constant Field Values

DAY_OF_MONTH

static final java.lang.String DAY_OF_MONTH

See Also:

Constant Field Values

Method Detail

executeIfAppropriate

boolean executeIfAppropriate()
                      throws BBjAdminException

Call this method to execute the scheduled task and its items if it is the appropriate time according to its configuration. If it was time and it executed it returns true. Otherwise returns false.

Throws:

BBjAdminException

getTasks

BBjAdminList<BBjAdminReplicationTask> getTasks()

Returns a list of tasks within this group. When you execute the group, all of its tasks will be executed in the order they appear in the group.

Returns:

List of the tasks in this group.

setTasks

void setTasks(BBjAdminList<BBjAdminReplicationTask> p_tasks)

getSchedulingDescription

java.lang.String getSchedulingDescription()
                                   throws BBjAdminException

Returns a human readable description of the scheduling for this group. If it is a date, it will show the date and time. If a day of the week, the name of the day of the week. Etc.....

Throws:

BBjAdminException

newTask

BBjAdminReplicationTask newTask(BBjAdminReplicationTask.TaskType p_type)
                         throws BBjAdminException

Creates a new instance of a task but does NOT add it to the list of tasks.

Throws:

BBjAdminException

getJob

BBjAdminReplicationJob getJob()

Returns the replication job associated with this task group.

setJob

void setJob(BBjAdminReplicationJob p_job)
     throws BBjAdminException

Sets the replication job associated with this task group.

Parameters:

p_job -

Throws:

BBjAdminException