atg.svc.repository.beans
Interface PanelDefinitionHome

All Superinterfaces:

javax.ejb.EJBLocalHome

All Known Implementing Classes:

_PanelDefinitionHome_BeanImpl, _PanelDefinitionHome_ReposImpl

public interface PanelDefinitionHome
extends javax.ejb.EJBLocalHome

Finder Summaries

Finder Name	Finder Description	Returns
findByPrimaryKey		one
findByAppId	Finds all panels by application.	many
findByPanelId	Finds a panel definition by application and logical ID.	one
findBySegmentAndPanelId	Finds a panel definition by application, segment and logical ID.	one
findBySegmentName	Finds all panel definitions by application and segment.	many
findSlotPanels	Finds all panel definitions with slots.	many
findSlotPanelsByName	Finds all panel definitions with slots, ordered by name.	many

Method Summary

PanelDefinition	create() Returns a new instance.
PanelDefinition	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 panels by application.
PanelDefinition	findByPanelId(java.lang.String appId, java.lang.String panelId) Finds a panel definition by application and logical ID.
PanelDefinition	findByPrimaryKey(java.lang.String primaryKey) Returns the instance with the given primary key, throws ObjectNotFoundException if the instance is not found.
PanelDefinition	findBySegmentAndPanelId(java.lang.String appId, java.lang.String segmentName, java.lang.String panelId) Finds a panel definition by application, segment and logical ID.
java.util.Collection	findBySegmentName(java.lang.String appId, java.lang.String segmentName) Finds all panel definitions by application and segment.
PanelDefinition	findByUserSegmentAndPanelId(java.lang.String appId, java.lang.String panelId)
java.util.Collection	findSlotPanels(java.lang.String appId) Finds all panel definitions with slots.
java.util.Collection	findSlotPanelsByName(java.lang.String appId) Finds all panel definitions with slots, ordered by name.
PanelDefinition	wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)
java.util.Collection	wrapRepositoryItems(java.util.Collection pRepositoryItems)

Methods inherited from interface javax.ejb.EJBLocalHome

remove

Method Detail

create

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

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

PanelDefinition 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 panels by application.

Returns:

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

findByPanelId

PanelDefinition findByPanelId(java.lang.String appId,
                              java.lang.String panelId)
                              throws javax.ejb.FinderException,
                                     javax.ejb.EJBException

Finds a panel 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

findBySegmentAndPanelId

PanelDefinition findBySegmentAndPanelId(java.lang.String appId,
                                        java.lang.String segmentName,
                                        java.lang.String panelId)
                                        throws javax.ejb.FinderException,
                                               javax.ejb.EJBException

Finds a panel 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 definitions by application and segment.

Returns:

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

findSlotPanels

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

Finds all panel definitions with slots.

Returns:

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

findSlotPanelsByName

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

Finds all panel definitions with slots, ordered by name.

Returns:

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

PanelDefinition wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)

findByUserSegmentAndPanelId

PanelDefinition findByUserSegmentAndPanelId(java.lang.String appId,
                                            java.lang.String panelId)
                                            throws ObjectNotFoundException,
                                                   javax.ejb.FinderException,
                                                   javax.ejb.EJBException

Parameters:

appId - Application identifier

panelId - Panel identifier

Returns:

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

Throws:

ObjectNotFoundException

javax.ejb.FinderException

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