com.mendix.systemwideinterfaces.core.IBatch Interface Reference

Inheritance diagram for com.mendix.systemwideinterfaces.core.IBatch:

List of all members.

Public Member Functions
abstract void	setMemberValue (String name, Object value) throws CoreException
abstract IMendixObjectMember<?>	getMember (String name) throws CoreException
abstract IMendixObject	getCurrentObject ()
abstract void	addAssociationValue (String associationName, IMendixIdentifier id) throws CoreException
abstract void	addBatchForAssociation (IBatch batchAssociation, String associationName) throws CoreException
abstract void	addAssociationInfo (IBatch parentBatch, String associationName, boolean isParent) throws CoreException
abstract List< IMendixIdentifier >	commit () throws CoreException
abstract Future< List < IMendixIdentifier > >	commitAsync () throws CoreException
abstract Object	clone () throws CloneNotSupportedException
IBatch	getParentBatch ()

---

Detailed Description

Generic interface for create and change batches.

---

Member Function Documentation

abstract void com.mendix.systemwideinterfaces.core.IBatch.addAssociationInfo	(	IBatch	parentBatch,
		String	associationName,
		boolean	isParent
	)		throws CoreException [pure virtual]

Set the given parentBatch as parent batch for this batch
and add all objects created till now to the association of the current active object of the parent batch.

Parameters:

parentBatch
associationName
isParent

Exceptions:

CoreException

abstract void com.mendix.systemwideinterfaces.core.IBatch.addAssociationValue	(	String	associationName,
		IMendixIdentifier	id
	)		throws CoreException [pure virtual]

Add the given id to the given associationName.
If the association is a MendixObjectReference the value will be 'id'.
If the association is a MendixObjectReferenceSet the value will be currentValue + 'id'.

Parameters:

associationName
id

Exceptions:

CoreException

abstract void com.mendix.systemwideinterfaces.core.IBatch.addBatchForAssociation	(	IBatch	batchAssociation,
		String	associationName
	)		throws CoreException [pure virtual]

Add child batch for the given association

• All elements created in this child batch will be added to the association of the current active object of this batch.
  
• addBatchForAssociation will be called on the child batch.
  

  Parameters:

  batchAssociation
  associationName

  Exceptions:

  CoreException

abstract Object com.mendix.systemwideinterfaces.core.IBatch.clone

(

)

throws CloneNotSupportedException [pure virtual]

Creates a clone of this batch, is used for committing the current batch asynchronous while this batch can be used at the same time for creating or changing a new set of objects.

Returns:

a clone of this batch

Exceptions:

CloneNotSupportedException

abstract List<IMendixIdentifier> com.mendix.systemwideinterfaces.core.IBatch.commit

(

)

throws CoreException [pure virtual]

Commit the current batch

Returns:

the list of created object with real id's

Exceptions:

CoreException

abstract Future<List<IMendixIdentifier> > com.mendix.systemwideinterfaces.core.IBatch.commitAsync

(

)

throws CoreException [pure virtual]

Commit the current batch in a separate thread

Returns:

a Future object for controlling the executor thread

Exceptions:

CoreException

abstract IMendixObject com.mendix.systemwideinterfaces.core.IBatch.getCurrentObject

(

)

[pure virtual]

Returns:

returns the current active object

abstract IMendixObjectMember<?> com.mendix.systemwideinterfaces.core.IBatch.getMember

(

String

name

)

throws CoreException [pure virtual]

Parameters:

name

Returns:

returns the member of the current active object for the given name

Exceptions:

CoreException

IBatch com.mendix.systemwideinterfaces.core.IBatch.getParentBatch

(

)

Returns:

the parent batch (when present, otherwise null)

abstract void com.mendix.systemwideinterfaces.core.IBatch.setMemberValue	(	String	name,
		Object	value
	)		throws CoreException [pure virtual]

Set a member value of the current object

Parameters:

name
value

Exceptions:

CoreException

---

The documentation for this interface was generated from the following file:

• IBatch.java