atg.svc.repository.beans
Interface TabDefinitionHome

All Superinterfaces:

javax.ejb.EJBLocalHome

All Known Implementing Classes:

_TabDefinitionHome_BeanImpl, _TabDefinitionHome_ReposImpl

public interface TabDefinitionHome
extends javax.ejb.EJBLocalHome

Finder Summaries

Finder Name	Finder Description	Returns
findByPrimaryKey		one
findByAppId	Finds all tabs by application.	many
findBySegmentAndTabId	Finds a tab definition by application, segment and logical ID.	one
findBySegmentName	Finds all tab definitions by application and segment.	many
findByTabId	Finds a tab definition by application and logical ID.	one

Method Summary

TabDefinition	create() Returns a new instance.
TabDefinition	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 tabs by application.
TabDefinition	findByPrimaryKey(java.lang.String primaryKey) Returns the instance with the given primary key, throws ObjectNotFoundException if the instance is not found.
TabDefinition	findBySegmentAndTabId(java.lang.String appId, java.lang.String segmentName, java.lang.String tabId) Finds a tab definition by application, segment and logical ID.
java.util.Collection	findBySegmentName(java.lang.String appId, java.lang.String segmentName) Finds all tab definitions by application and segment.
TabDefinition	findByTabId(java.lang.String appId, java.lang.String tabId) Finds a tab definition by application and logical ID.
TabDefinition	findByUserSegmentAndTabId(java.lang.String appId, java.lang.String tabId)
TabDefinition	wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)
java.util.Collection	wrapRepositoryItems(java.util.Collection pRepositoryItems)

Methods inherited from interface javax.ejb.EJBLocalHome

remove

Method Detail

create

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

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

TabDefinition 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 tabs by application.

Returns:

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

findBySegmentAndTabId

TabDefinition findBySegmentAndTabId(java.lang.String appId,
                                    java.lang.String segmentName,
                                    java.lang.String tabId)
                                    throws javax.ejb.FinderException,
                                           javax.ejb.EJBException

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

Returns:

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

findByTabId

TabDefinition findByTabId(java.lang.String appId,
                          java.lang.String tabId)
                          throws javax.ejb.FinderException,
                                 javax.ejb.EJBException

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

wrapRepositoryItems

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

wrapRepositoryItem

TabDefinition wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)

findByUserSegmentAndTabId

TabDefinition findByUserSegmentAndTabId(java.lang.String appId,
                                        java.lang.String tabId)
                                        throws ObjectNotFoundException,
                                               javax.ejb.FinderException,
                                               javax.ejb.EJBException

Parameters:

appId - Application identifier

tabId - Tab identifier

Returns:

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

Throws:

ObjectNotFoundException

javax.ejb.FinderException

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