Package com.basis.api.admin.client

Class BBjAdminClientTaskGroup

java.lang.Object

com.basis.api.admin.internal.BBjAdminSimplePropReader

com.basis.api.admin.internal.BBjAdminSimplePropWriter

com.basis.api.admin.client.BBjAdminClientTaskGroup

All Implemented Interfaces:

BBjAdminPropertyReader, BBjAdminPropertyWriter, BBjAdminTaskGroup, Serializable, Remote

public class BBjAdminClientTaskGroup
extends BBjAdminSimplePropWriter
implements BBjAdminTaskGroup

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.basis.api.admin.internal.BBjAdminSimplePropWriter

m_hasChanged

Fields inherited from class com.basis.api.admin.internal.BBjAdminSimplePropReader

m_properties, m_types

Fields inherited from interface com.basis.api.admin.BBjAdminTaskGroup

AUTORUN, DAILY, END_DATE, FRIDAY, HOURLY, ID, LAST_RUN, LAST_STATUS, MONDAY, MONTHLY, NAME, NEXT_RUN, NONE, REPEAT_DAYS, REPEAT_FREQUENCY, REPEAT_TYPE, SATURDAY, SCHEUDULING_PREFIX, START_DATE, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY, WEEKLY, YEARLY

Constructor Summary

Constructors

Constructor	Description
BBjAdminClientTaskGroup()

Method Summary

Modifier and Type	Method	Description
void	commit()	Stores any changes made, to the task definition file.
boolean	equals(Object p_obj)
boolean	executeIfAppropriate()	Call this method to execute the scheduled task and its items if it is the appropriate time according to its configuration.
void	executeIfAutorun()	Executes the task group only if it is configured as autorun.
String	getSchedulingDescription()	Returns a human readable description of the scheduling for this group.
BBjAdminList<BBjAdminTask>	getTasks()	Returns a list of tasks within this group.
Element	getXML(Document p_xmlDoc)	Internal use only.
boolean	isEnabled()	Returns true if the group is currently enabled and scheduled run.
BBjAdminTask	newTask(BBjAdminTask.TaskType p_type)	Creates a new instance of a task but does NOT add it to the list of tasks.
void	setEnabled(boolean p_enabled)	Enables or disables the task group.
void	setTasks(BBjAdminList<BBjAdminTask> p_tasks)

Methods inherited from class com.basis.api.admin.internal.BBjAdminSimplePropWriter

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

Methods inherited from class com.basis.api.admin.internal.BBjAdminSimplePropReader

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

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

Constructor Details

BBjAdminClientTaskGroup

public BBjAdminClientTaskGroup()
                        throws BBjAdminException

Throws:

BBjAdminException

Method Details

executeIfAppropriate

public boolean executeIfAppropriate()
                             throws BBjAdminException

Description copied from interface: BBjAdminTaskGroup

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.

Specified by:

executeIfAppropriate in interface BBjAdminTaskGroup

Throws:

BBjAdminException

executeIfAutorun

public void executeIfAutorun()
                      throws BBjAdminException

Description copied from interface: BBjAdminTaskGroup

Executes the task group only if it is configured as autorun.

Specified by:

executeIfAutorun in interface BBjAdminTaskGroup

Throws:

BBjAdminException

getTasks

public BBjAdminList<BBjAdminTask> getTasks()

Description copied from interface: BBjAdminTaskGroup

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.

Specified by:

getTasks in interface BBjAdminTaskGroup

Returns:

List of the tasks in this group.

setTasks

public void setTasks(BBjAdminList<BBjAdminTask> p_tasks)

Specified by:

setTasks in interface BBjAdminTaskGroup

getSchedulingDescription

public String getSchedulingDescription()
                                throws BBjAdminException

Description copied from interface: BBjAdminTaskGroup

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.....

Specified by:

getSchedulingDescription in interface BBjAdminTaskGroup

Returns:

The description of how this task group is scheduled. Takes all the scheduling criteria and builds a human readable string.

Throws:

BBjAdminException

newTask

public BBjAdminTask newTask(BBjAdminTask.TaskType p_type)
                     throws BBjAdminException

Description copied from interface: BBjAdminTaskGroup

Creates a new instance of a task but does NOT add it to the list of tasks. Make sure to add the instance to the list of tasks returned by a call to BBjAdminTaskGroup.getTasks().

Specified by:

newTask in interface BBjAdminTaskGroup

Returns:

New instance of the specified type. Always use this method to create new task instances, never use the implementation classes of BBjAdminTask.

Throws:

BBjAdminException

getXML

public Element getXML(Document p_xmlDoc)
               throws BBjAdminException

Description copied from interface: BBjAdminTaskGroup

Internal use only.

Specified by:

getXML in interface BBjAdminTaskGroup

Throws:

BBjAdminException

commit

public void commit()
            throws BBjAdminException

Description copied from interface: BBjAdminTaskGroup

Stores any changes made, to the task definition file.

Specified by:

commit in interface BBjAdminTaskGroup

Throws:

BBjAdminException

equals

public boolean equals(Object p_obj)

Overrides:

equals in class Object

isEnabled

public boolean isEnabled()
                  throws BBjAdminException

Description copied from interface: BBjAdminTaskGroup

Returns true if the group is currently enabled and scheduled run.

Specified by:

isEnabled in interface BBjAdminTaskGroup

Returns:

True if the task group is enabled. False if not.

Throws:

BBjAdminException

setEnabled

public void setEnabled(boolean p_enabled)
                throws BBjAdminException

Description copied from interface: BBjAdminTaskGroup

Enables or disables the task group. A disabled task group will not run the next time it is scheduled to. NOTE: You must call commit() on the BBjAdminTaskGroup in order for the enabled state to be saved and updated.

Specified by:

setEnabled in interface BBjAdminTaskGroup

Throws:

BBjAdminException