com.basis.api.admin

Interface BBjAdminTaskQueue

All Superinterfaces:

BBjAdminPropertyReader, BBjAdminPropertyWriter, java.rmi.Remote

public interface BBjAdminTaskQueue
extends BBjAdminPropertyWriter

The task queue is the manager containing all the currently configured task groups on the server. Use the BBjAdminTaskQueue instance to get a list of the task groups. Please see BBjAdminTaskGroup for sample code for using the BBjAdminTaskQueue.

Method Summary

Modifier and Type	Method and Description
void	commit() Called to re-write the task queue configurations.
BBjAdminTaskGroup	getTaskGroup(java.lang.String p_idOrName) Returns the task group with the specified ID or name.
BBjAdminList<BBjAdminTaskGroup>	getTaskGroups() Returns a list of the task groups on the server.
void	load() Called to re-load the task group configurations from the configuration file.

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

Method Detail

getTaskGroups

BBjAdminList<BBjAdminTaskGroup> getTaskGroups()
                                       throws BBjAdminException

Returns a list of the task groups on the server.

Returns:

List of the task groups.

Throws:

BBjAdminException

load

void load()
   throws BBjAdminException

Called to re-load the task group configurations from the configuration file.

Throws:

BBjAdminException

commit

void commit()
     throws BBjAdminException

Called to re-write the task queue configurations.

Throws:

BBjAdminException

getTaskGroup

BBjAdminTaskGroup getTaskGroup(java.lang.String p_idOrName)
                        throws BBjAdminException

Returns the task group with the specified ID or name.

Parameters:

p_idOrName - ID or name of the BBjAdminTaskGroup to get.

Returns:

The matching task group or null if no match.

Throws:

BBjAdminException