atg.svc.repository.beans
Interface SegmentHome

All Superinterfaces:

javax.ejb.EJBLocalHome

All Known Implementing Classes:

_SegmentHome_BeanImpl, _SegmentHome_ReposImpl

public interface SegmentHome
extends javax.ejb.EJBLocalHome

Finder Summaries

Finder Name	Finder Description	Returns
findByPrimaryKey		one
findAll	Find all Segments	many
findAllExternal	Finds all external segments	many
findAllField	Finds all external segments	many
findAllInternal	Finds all internal segments	many
findAllValue	Finds all external segments	many
findByNameAndIsInternal	Finds a segment by name and if its internal	one

Method Summary

Segment	create() Returns a new instance.
Segment	create(java.lang.String pId) Returns a new instance with the repository id set to the given id.
java.util.Collection	findAll() Find all Segments
java.util.Collection	findAllExternal() Finds all external segments
java.util.Collection	findAllField() Finds all external segments
java.util.Collection	findAllInternal() Finds all internal segments
java.util.Collection	findAllValue() Finds all external segments
Segment	findByNameAndIsInternal(java.lang.String name, boolean internal) Finds a segment by name and if its internal
Segment	findByPrimaryKey(java.lang.String primaryKey) Returns the instance with the given primary key, throws ObjectNotFoundException if the instance is not found.
Segment	wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)
java.util.Collection	wrapRepositoryItems(java.util.Collection pRepositoryItems)

Methods inherited from interface javax.ejb.EJBLocalHome

remove

Method Detail

create

Segment create()
               throws javax.ejb.CreateException,
                      javax.ejb.EJBException

Returns a new instance. The properties are set to default values, and may be changed by using the appropriate setter methods. The instance may be a repository or bean implementation depending on how this home's factory was obtained. If the instance is backed by a persistent implementation, it may not actually be persisted until Segment.writeInstance() is called on the instance (and the transaction is committed, if the implementation is transaction-aware).

Throws:

javax.ejb.CreateException

javax.ejb.EJBException

create

Segment create(java.lang.String pId)
               throws javax.ejb.CreateException,
                      javax.ejb.EJBException

Returns a new instance with the repository id set to the given id. The properties are set to default values, and may be changed by using the appropriate setter methods. The instance may be a repository or bean implementation depending on how this home's factory was obtained. If the instance is backed by a persistent implementation, it may not actually be persisted until Segment.writeInstance() is called on the instance (and the transaction is committed, if the implementation is transaction-aware).

Throws:

javax.ejb.CreateException

javax.ejb.EJBException

findByPrimaryKey

Segment findByPrimaryKey(java.lang.String primaryKey)
                         throws javax.ejb.FinderException,
                                javax.ejb.EJBException

Returns the instance with the given primary key, throws ObjectNotFoundException if the instance is not found.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findAll

java.util.Collection findAll()
                             throws javax.ejb.FinderException,
                                    javax.ejb.EJBException

Find all Segments

Returns:

a Collection of Segment instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findAllExternal

java.util.Collection findAllExternal()
                                     throws javax.ejb.FinderException,
                                            javax.ejb.EJBException

Finds all external segments

Returns:

a Collection of Segment instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findAllField

java.util.Collection findAllField()
                                  throws javax.ejb.FinderException,
                                         javax.ejb.EJBException

Finds all external segments

Returns:

a Collection of Segment instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findAllInternal

java.util.Collection findAllInternal()
                                     throws javax.ejb.FinderException,
                                            javax.ejb.EJBException

Finds all internal segments

Returns:

a Collection of Segment instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findAllValue

java.util.Collection findAllValue()
                                  throws javax.ejb.FinderException,
                                         javax.ejb.EJBException

Finds all external segments

Returns:

a Collection of Segment instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findByNameAndIsInternal

Segment findByNameAndIsInternal(java.lang.String name,
                                boolean internal)
                                throws javax.ejb.FinderException,
                                       javax.ejb.EJBException

Finds a segment by name and if its internal

Parameters:

name - Segment name

internal - True if the segment is internal, false if the segment is external

Returns:

an instance matching the query criteria, or throws ObjectNotFoundException if no such instance is found.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

wrapRepositoryItems

java.util.Collection wrapRepositoryItems(java.util.Collection pRepositoryItems)

wrapRepositoryItem

Segment wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)