Detailed Description

BatchDisplayController is used to load a tree of Node instances recursivly and return them in lists of a given size.

The reconstruction of the tree must be handled by the client.

The controller supports the following actions:

Action default

Load the Nodes.

Parameter	Description
in / out `oid`	The object id of the Node to start loading from
in `translateValues`	Boolean whether list values should be translated to their display values (optional, default: true)
in `nodesPerCall`	The number of Node instances to load in one call (default: 50)
out `list`	Array of Node instances

For additional actions and parameters see BatchController actions.

Definition at line 48 of file BatchDisplayController.php.

Inheritance diagram for BatchDisplayController:

Public Member Functions
	initialize (Request $request, Response $response)

Public Member Functions inherited from BatchController
	initialize (Request $request, Response $response)

Public Member Functions inherited from Controller
	__construct (Session $session, PersistenceFacade $persistenceFacade, PermissionManager $permissionManager, ActionMapper $actionMapper, Localization $localization, Message $message, Configuration $configuration)

	initialize (Request $request, Response $response)

	execute ($method=null)

	getRequest ()

	getResponse ()

Protected Member Functions
	validate ()

	getWorkPackage ($number)

	startProcess ($oids)

	loadNodes ($oids)

	endProcess ()

	loadNode (ObjectId $oid)

	register (ObjectId $oid)

	isRegistered (ObjectId $oid)

	addNodeToResponse (Node $node)

Protected Member Functions inherited from BatchController
	doExecute ()

	getStepNumber ()

	addWorkPackage ($name, $size, $oids, $callback, $args=null)

	processPart ()

	getNumberOfSteps ()

	getDisplayText ($step)

	getDownloadFile ()

	getWorkPackage ($number)

Protected Member Functions inherited from Controller
	validate ()

	executeSubAction ($action)

	getLogger ()

	getSession ()

	getPersistenceFacade ()

	getPermissionManager ()

	getActionMapper ()

	getLocalization ()

	getMessage ()

	getConfiguration ()

	assignResponseDefaults ()

	isLocalizedRequest ()

	checkLanguageParameter ()

Additional Inherited Members
Public Attributes inherited from BatchController
const	ONE_CALL_SESSION_VARNAME = 'BatchController.oneCall'

const	STEP_SESSION_VARNAME = 'BatchController.curStep'

const	NUM_STEPS_VARNAME = 'BatchController.numSteps'

const	DOWNLOAD_STEP = 'BatchController.downloadStep'

const	WORK_PACKAGES_VARNAME = 'BatchController.workPackages'