oracle.apps.fnd.applcore.flex.runtime
Class ModelerTaskGroup

java.lang.Object
  oracle.apps.fnd.applcore.flex.runtime.ModelerTaskGroup

Direct Known Subclasses:

BCModelerTaskGroup, EffModelerTaskGroup

public class ModelerTaskGroup
extends java.lang.Object

A task group that contains multiple modeler tasks. By using a task group, the performance of multiple modeler tasks is optimized.

Nested Class Summary

static class

ModelerTaskGroup.ExecutionContext The context for the execution of all tasks in a group.

Field Summary

protected ModelerTaskGroupListener	_listener The listener.
protected java.util.List<ModelerTask>	_taskList The task list.

Constructor Summary

	ModelerTaskGroup(java.util.List<ModelerTask> taskList) Constructs a task group.
protected	ModelerTaskGroup(java.util.List<ModelerTask> taskList, boolean useSandbox) Constructs a task group with the option of creating a sandbox, if the sandbox feature is supported.
	ModelerTaskGroup(java.util.List<ModelerTask> taskList, ModelerSandbox sandbox) Constructs a task group with the use of a sandbox.

Method Summary

protected java.util.List<java.lang.String>	getObjectPackages() Gets the list of packages of objects to be updated or created by this task group.
static ModelerSandbox	getPreferredApplCoreSandbox(java.lang.String flexfieldType, long appId, java.lang.String flexfieldCode, java.lang.String description) Gets the preferred ApplCore sandbox for a flexfield.
static java.lang.String	getPreferredSandboxName(java.lang.String flexfieldType, long appId, java.lang.String flexfieldCode) Gets the preferred sandbox name for a flexfield.
protected java.util.List<java.lang.String>	getServicePackages() Gets the list of packages of the XSD files.
protected ModelerTaskGroup.ExecutionContext	newExecutionContext() Creates a new execution context.
java.util.List<ModelerTask.State>	perform() Performs the modeler tasks in this group.
void	resetListener() Resets the listener back to the default listener.
void	setListener(ModelerTaskGroupListener listener) Sets the listener.

Methods inherited from class java.lang.Object

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

Field Detail

_taskList

protected final java.util.List<ModelerTask> _taskList

The task list.

_listener

protected ModelerTaskGroupListener _listener

The listener. Unless reset by a subclass, the value is never null.

Constructor Detail

ModelerTaskGroup

public ModelerTaskGroup(java.util.List<ModelerTask> taskList)

Constructs a task group.

Parameters:

taskList - the list of tasks to perform

Throws:

java.lang.IllegalArgumentException - if the given task list is null or empty

ModelerTaskGroup

protected ModelerTaskGroup(java.util.List<ModelerTask> taskList,
                           boolean useSandbox)

Constructs a task group with the option of creating a sandbox, if the sandbox feature is supported.

Parameters:

taskList - the list of tasks to perform

useSandbox - true if a sandbox should be created and used

Throws:

java.lang.IllegalArgumentException - if the given task list is null or empty

ModelerTaskGroup

public ModelerTaskGroup(java.util.List<ModelerTask> taskList,
                        ModelerSandbox sandbox)

Constructs a task group with the use of a sandbox. Note that if sandbox feature is not supported, an exception may be thrown later when perform is called. This constructor does not verify whether the sandbox feature is supported or not

Parameters:

taskList - the task list

sandbox - the sandbox

Throws:

java.lang.IllegalArgumentException - if the task list is null, empty or if the sandbox is null

Method Detail

setListener

public final void setListener(ModelerTaskGroupListener listener)

Sets the listener.

Parameters:

listener - the listener

resetListener

public final void resetListener()

Resets the listener back to the default listener.

getObjectPackages

protected java.util.List<java.lang.String> getObjectPackages()

Gets the list of packages of objects to be updated or created by this task group.

Returns:

the list of packages of objects to be updated or created by this task group

getServicePackages

protected java.util.List<java.lang.String> getServicePackages()

Gets the list of packages of the XSD files. By default this method returns the same list returned by getObjectPackages().

Returns:

the list of packages of the XSD files

newExecutionContext

protected ModelerTaskGroup.ExecutionContext newExecutionContext()

Creates a new execution context. This method is invoked in the beginning of perform().

Returns:

a new execution context

See Also:

perform()

getPreferredSandboxName

public static java.lang.String getPreferredSandboxName(java.lang.String flexfieldType,
                                                       long appId,
                                                       java.lang.String flexfieldCode)

Gets the preferred sandbox name for a flexfield.

Parameters:

flexfieldType - the flexfield type, e.g. "DFF", "KFF" or "EFF".

appId - the application ID

flexfieldCode - the flexfield code

Returns:

the preferred sandbox name

Throws:

java.lang.IllegalArgumentException - if the given flexfield type, application short name or flexfield code is null

getPreferredApplCoreSandbox

public static ModelerSandbox getPreferredApplCoreSandbox(java.lang.String flexfieldType,
                                                         long appId,
                                                         java.lang.String flexfieldCode,
                                                         java.lang.String description)

Gets the preferred ApplCore sandbox for a flexfield. An ApplCore sandbox can be managed through ApplCore's sandbox administration UI.

Parameters:

flexfieldType - the flexfield type, e.g. "DFF", "KFF" or "EFF".

appId - the application ID

flexfieldCode - the flexfield code

description - the description; null if not available. The description is usually the display name of the flexfield

Returns:

the preferred sandbox

Throws:

java.lang.IllegalArgumentException - if the given flexfield type, application short name or flexfield code is null

perform

public final java.util.List<ModelerTask.State> perform()

Performs the modeler tasks in this group.

Returns:

the states of the tasks