atg.svc.repository.beans
Interface FrameworkDefinitionHome

All Superinterfaces:

javax.ejb.EJBLocalHome

All Known Implementing Classes:

_FrameworkDefinitionHome_BeanImpl, _FrameworkDefinitionHome_ReposImpl

public interface FrameworkDefinitionHome
extends javax.ejb.EJBLocalHome

Finder Summaries

Finder Name	Finder Description	Returns
findByPrimaryKey		one
findByAppId	Get framework by application identifier, e.	many
findByFrameworkId	Finds a framework definition by application and logical ID.	one
findBySegmentAndFrameworkId	Finds a framework definition by application, segment and logical ID.	one
findBySegmentName	Finds all framework definitions by application and segment.	many

Method Summary

FrameworkDefinition	create() Returns a new instance.
FrameworkDefinition	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) Get framework by application identifier, e.g.
FrameworkDefinition	findByFrameworkId(java.lang.String appId, java.lang.String frameworkId) Finds a framework definition by application and logical ID.
FrameworkDefinition	findByPrimaryKey(java.lang.String primaryKey) Returns the instance with the given primary key, throws ObjectNotFoundException if the instance is not found.
FrameworkDefinition	findBySegmentAndFrameworkId(java.lang.String appId, java.lang.String segmentName, java.lang.String frameworkId) Finds a framework definition by application, segment and logical ID.
java.util.Collection	findBySegmentName(java.lang.String appId, java.lang.String segmentName) Finds all framework definitions by application and segment.
FrameworkDefinition	wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)
java.util.Collection	wrapRepositoryItems(java.util.Collection pRepositoryItems)

Methods inherited from interface javax.ejb.EJBLocalHome

remove

Method Detail

create

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

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

FrameworkDefinition 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

Get framework by application identifier, e.g. "workspace".

Returns:

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

findByFrameworkId

FrameworkDefinition findByFrameworkId(java.lang.String appId,
                                      java.lang.String frameworkId)
                                      throws javax.ejb.FinderException,
                                             javax.ejb.EJBException

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

findBySegmentAndFrameworkId

FrameworkDefinition findBySegmentAndFrameworkId(java.lang.String appId,
                                                java.lang.String segmentName,
                                                java.lang.String frameworkId)
                                                throws javax.ejb.FinderException,
                                                       javax.ejb.EJBException

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

Returns:

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

FrameworkDefinition wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)