wt.container.batch
Interface AttributedRoleBatchContainer

All Superinterfaces:

BatchContainer, RoleBatchContainer

All Known Implementing Classes:

AttributedRoleBatchContainerImpl

public interface AttributedRoleBatchContainer

extends RoleBatchContainer

Interface AttributedRoleBatchCotnainer is a RoleBatchContainer that supports attributes on an association.

Supported API: true

Extendable: false

Nested Class Summary

static interface

AttributedRoleBatchContainer.AssertionTarget

Field Summary

Fields inherited from interface wt.container.batch.RoleBatchContainer

ASSOCIATION_NAME, FROM_OBJECT, ROLE_NAME

Fields inherited from interface wt.container.batch.BatchContainer

ELEMENTS

Method Summary

boolean	add(Object element, Object attributeMap) Adds the specified object and attribute map pair to this AttributedRoleBatchContainer.
Enumeration	attributeMaps() Return an Enumeration over the attribute maps in this AttributedRoleBatchContainer.
boolean	contains(Object element, Object attributeMap) Determine if the object and attribute map pair is in this AttributedRoleBatchContainer.
boolean	populate(Enumeration a_Elements, Enumeration a_AttributeMaps) Operation to allow the pre-population of container elements.
boolean	populate(Object a_Element, Object a_AttributeMap) Operation to allow the pre-population of container elements.
boolean	remove(Object element, Object attributeMap) Removes the specified object and attribute map pair from this AttributedRoleBatchContainer.
boolean	replace(Object element, Object attributeMap) Used to indicate that an object and attribute map pair has changed.

Methods inherited from interface wt.container.batch.RoleBatchContainer

getAssociationName, getFromObject, getRoleName

Methods inherited from interface wt.container.batch.BatchContainer

add, contains, elements, populate, populate, remove, replace, size

Method Detail

add

public boolean add(Object element,
                   Object attributeMap)

Adds the specified object and attribute map pair to this AttributedRoleBatchContainer. Returns false if the container did not change based on the add (i.e., the pair was already in this container). If the pair is not already in this container, an AddAssertion is also added to the associated TransactionContainer.

Supported API: true

Parameters:

element - the "other side" object in the association

attributeMap - a map of the association attribute names to their respective values

Returns:

boolean

remove

public boolean remove(Object element,
                      Object attributeMap)

Removes the specified object and attribute map pair from this AttributedRoleBatchContainer. Returns false if the container is not changed by this operation (i.e., the pair is not in this container). Regardless of whether the pair is already in this container, a RemoveAssertion is created and added to the associated TransactionContainer.

Supported API: true

Parameters:

element - the "other side" object in the association

attributeMap - a map of the association attribute names to their respective values

Returns:

boolean

replace

public boolean replace(Object element,
                       Object attributeMap)

Used to indicate that an object and attribute map pair has changed. Returns true if the specified object and attribute map pair is in the container. Regardless of whether the pair is already in this container, a ReplaceAsssertion will be created and added to the associated TransactionContainer.

Supported API: true

Parameters:

element - the "other side" object in the association

attributeMap - a map of the association attribute names to their respective values

Returns:

boolean

attributeMaps

public Enumeration attributeMaps()

Return an Enumeration over the attribute maps in this AttributedRoleBatchContainer. The returned enumeration contains the same number and ordering of elements as that returned by elements() (i.e., the nth map returned by the enumeration corresponds to the nth object returned by the enumeration returned by elements()).

Supported API: true

Returns:

Enumeration

contains

public boolean contains(Object element,
                        Object attributeMap)

Determine if the object and attribute map pair is in this AttributedRoleBatchContainer. Pairs for which a remove assertion has been applied will not be returned.

Supported API: true

Parameters:

element - the "other side" object in the association

attributeMap - a map of the association attribute names to their respective values

Returns:

boolean

populate

public boolean populate(Object a_Element,
                        Object a_AttributeMap)

Operation to allow the pre-population of container elements. This allows object and attribute map pairs to be added to the container without creating a corresponding Assertion. Returns true if this AttributeRoleBatchContainer changed due to this operation.

Supported API: true

Parameters:

a_Element - the "other side" object in the association

a_AttributeMap - a map of the association attribute names to their respective values

Returns:

boolean

populate

public boolean populate(Enumeration a_Elements,
                        Enumeration a_AttributeMaps)

Operation to allow the pre-population of container elements. The container must be empty when populate is called. The argument enumerations must correspond in both size and ordering (i.e., the nth object of the first argument enumeration must correspond to the nth map of the second argument enumeration). Returns true if the AttributedRoleBatchContainer changed due to this operation.

Supported API: true

Parameters:

a_Elements - the "other side" objects in the association

a_AttributeMaps - maps of the association attribute names (Strings) to their respective values

Returns:

boolean