atg.svc.repository.beans
Interface PanelStackDefinitionHome

All Superinterfaces:

javax.ejb.EJBLocalHome

All Known Implementing Classes:

_PanelStackDefinitionHome_BeanImpl, _PanelStackDefinitionHome_ReposImpl

public interface PanelStackDefinitionHome
extends javax.ejb.EJBLocalHome

Finder Summaries

Finder Name	Finder Description	Returns
findByPrimaryKey		one
findByAppId	Finds all panel stacks by application.	many
findByPanelStackId	Finds a panel stack definition by application and logical ID.	one
findBySegmentAndPanelStackId	Finds a panel stack definition by application, segment and logical ID.	one
findBySegmentName	Finds all panel stack definitions by application and segment.	many

Method Summary

PanelStackDefinition	create() Returns a new instance.
PanelStackDefinition	create(java.lang.String pId) Returns a new instance with the repository id set to the given id.
java.util.Collection	findByAppId(java.lang.String appId) Finds all panel stacks by application.
PanelStackDefinition	findByPanelStackId(java.lang.String appId, java.lang.String panelStackId) Finds a panel stack definition by application and logical ID.
PanelStackDefinition	findByPrimaryKey(java.lang.String primaryKey) Returns the instance with the given primary key, throws ObjectNotFoundException if the instance is not found.
PanelStackDefinition	findBySegmentAndPanelStackId(java.lang.String appId, java.lang.String segmentName, java.lang.String panelStackId) Finds a panel stack definition by application, segment and logical ID.
java.util.Collection	findBySegmentName(java.lang.String appId, java.lang.String segmentName) Finds all panel stack definitions by application and segment.
PanelStackDefinition	findByUserSegmentAndPanelStackId(java.lang.String appId, java.lang.String panelStackId)
PanelStackDefinition	wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)
java.util.Collection	wrapRepositoryItems(java.util.Collection pRepositoryItems)

Methods inherited from interface javax.ejb.EJBLocalHome

remove

Method Detail

create

PanelStackDefinition 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 PanelStackDefinition.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

PanelStackDefinition 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 PanelStackDefinition.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

PanelStackDefinition 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

findByAppId

java.util.Collection findByAppId(java.lang.String appId)
                                 throws javax.ejb.FinderException,
                                        javax.ejb.EJBException

Finds all panel stacks by application.

Returns:

a Collection of PanelStackDefinition 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

findByPanelStackId

PanelStackDefinition findByPanelStackId(java.lang.String appId,
                                        java.lang.String panelStackId)
                                        throws javax.ejb.FinderException,
                                               javax.ejb.EJBException

Finds a panel stack definition by application and logical ID.

Returns:

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

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findBySegmentAndPanelStackId

PanelStackDefinition findBySegmentAndPanelStackId(java.lang.String appId,
                                                  java.lang.String segmentName,
                                                  java.lang.String panelStackId)
                                                  throws javax.ejb.FinderException,
                                                         javax.ejb.EJBException

Finds a panel stack definition by application, segment and logical ID.

Returns:

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

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findBySegmentName

java.util.Collection findBySegmentName(java.lang.String appId,
                                       java.lang.String segmentName)
                                       throws javax.ejb.FinderException,
                                              javax.ejb.EJBException

Finds all panel stack definitions by application and segment.

Returns:

a Collection of PanelStackDefinition 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

wrapRepositoryItems

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

wrapRepositoryItem

PanelStackDefinition wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)

findByUserSegmentAndPanelStackId

PanelStackDefinition findByUserSegmentAndPanelStackId(java.lang.String appId,
                                                      java.lang.String panelStackId)
                                                      throws ObjectNotFoundException,
                                                             javax.ejb.FinderException,
                                                             javax.ejb.EJBException

Parameters:

appId - Application identifier

panelStackId - Panel stack identifier

Returns:

Returns the specified panel stack by ID considering segment only if defined.

Throws:

ObjectNotFoundException

javax.ejb.FinderException

javax.ejb.EJBException - A system-level error occurred