atg.svc.repository.beans
Interface TemplateDefinitionHome

All Superinterfaces:

javax.ejb.EJBLocalHome

All Known Implementing Classes:

_TemplateDefinitionHome_BeanImpl, _TemplateDefinitionHome_ReposImpl

public interface TemplateDefinitionHome
extends javax.ejb.EJBLocalHome

Finder Summaries

Finder Name	Finder Description	Returns
findByPrimaryKey		one
findByAppId	Finds all templates by application.	many
findBySegmentAndTemplateId	Finds a template definition by application, segment and logical ID.	one
findBySegmentName	Finds all template definitions by application and segment.	many
findByTemplateId	Finds a template definition by application and logical ID.	one

Method Summary

TemplateDefinition	create() Returns a new instance.
TemplateDefinition	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 templates by application.
TemplateDefinition	findByPrimaryKey(java.lang.String primaryKey) Returns the instance with the given primary key, throws ObjectNotFoundException if the instance is not found.
TemplateDefinition	findBySegmentAndTemplateId(java.lang.String appId, java.lang.String segmentName, java.lang.String templateId) Finds a template definition by application, segment and logical ID.
java.util.Collection	findBySegmentName(java.lang.String appId, java.lang.String segmentName) Finds all template definitions by application and segment.
TemplateDefinition	findByTemplateId(java.lang.String appId, java.lang.String templateId) Finds a template definition by application and logical ID.
TemplateDefinition	findByUserSegmentAndTemplateId(java.lang.String appId, java.lang.String templateId)
TemplateDefinition	wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)
java.util.Collection	wrapRepositoryItems(java.util.Collection pRepositoryItems)

Methods inherited from interface javax.ejb.EJBLocalHome

remove

Method Detail

create

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

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

TemplateDefinition 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 templates by application.

Returns:

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

findBySegmentAndTemplateId

TemplateDefinition findBySegmentAndTemplateId(java.lang.String appId,
                                              java.lang.String segmentName,
                                              java.lang.String templateId)
                                              throws javax.ejb.FinderException,
                                                     javax.ejb.EJBException

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

Returns:

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

findByTemplateId

TemplateDefinition findByTemplateId(java.lang.String appId,
                                    java.lang.String templateId)
                                    throws javax.ejb.FinderException,
                                           javax.ejb.EJBException

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

TemplateDefinition wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)

findByUserSegmentAndTemplateId

TemplateDefinition findByUserSegmentAndTemplateId(java.lang.String appId,
                                                  java.lang.String templateId)
                                                  throws ObjectNotFoundException,
                                                         javax.ejb.FinderException,
                                                         javax.ejb.EJBException

Parameters:

appId - Application identifier

templateId - Template identifier

Returns:

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

Throws:

ObjectNotFoundException

javax.ejb.FinderException

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