org.mobicents.slee

Interface ChildRelationExt

All Superinterfaces:

javax.slee.ChildRelation, Collection, Iterable

public interface ChildRelationExt
extends javax.slee.ChildRelation

Extension for ChildRelation. Adds the concept that childs are mapped to names.

Author:

martins

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CHILD_NAME the proposed default name for a child sbb, useful when using this extension to handle a single child.

Method Summary

Methods

Modifier and Type	Method and Description
SbbLocalObjectExt	create(String name) Create a new SBB entity of the SBB type associated with the relation, with the specified name.
SbbLocalObjectExt	get(String name) Retrieves the sbb entity associated with the child relation, with the specified name.

Methods inherited from interface javax.slee.ChildRelation

create

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Field Detail

DEFAULT_CHILD_NAME

static final String DEFAULT_CHILD_NAME

the proposed default name for a child sbb, useful when using this extension to handle a single child.

See Also:

Constant Field Values

Method Detail

create

SbbLocalObjectExt create(String name)
                         throws javax.slee.CreateException,
                                IllegalArgumentException,
                                NullPointerException,
                                javax.slee.TransactionRequiredLocalException,
                                javax.slee.SLEEException

Create a new SBB entity of the SBB type associated with the relation, with the specified name. The new SBB entity is automatically added to the relationship collection. The returned object may be cast to the required local interface type using the normal Java typecast mechanism.

This method is a mandatory transactional method.

Parameters:

name - the name to apply to the object created.

Returns:

a local object reference to the created SBB entity.

Throws:

javax.slee.CreateException - if an SBB entity could not be created. This exception may have propagated from the SBB object's Sbb.sbbCreate() or Sbb.sbbPostCreate(), or may have been thrown by the SLEE.

IllegalArgumentException - if the specified name is the empty string.

NullPointerException - if the specified name is null.

javax.slee.TransactionRequiredLocalException - if this method is invoked without a valid transaction context.

javax.slee.SLEEException - if the child SBB could not be created due to a system-level failure.

get

SbbLocalObjectExt get(String name)
                      throws IllegalArgumentException,
                             NullPointerException,
                             javax.slee.TransactionRequiredLocalException,
                             javax.slee.SLEEException

Retrieves the sbb entity associated with the child relation, with the specified name.

This method is a mandatory transactional method.

Parameters:

name - the name of the object's sbb entity to retrieve.

Returns:

null if there is no such sbb entity.

Throws:

IllegalArgumentException - if the specified name is the empty string.

NullPointerException - if the specified name is null.

javax.slee.TransactionRequiredLocalException - if this method is invoked without a valid transaction context.

javax.slee.SLEEException - if the child SBB could not be retrieved due to a system-level failure.