atg.svc.repository.beans
Interface SkinDefinitionHome

All Superinterfaces:

javax.ejb.EJBLocalHome

All Known Implementing Classes:

_SkinDefinitionHome_BeanImpl, _SkinDefinitionHome_ReposImpl

public interface SkinDefinitionHome
extends javax.ejb.EJBLocalHome

Finder Summaries

Finder Name	Finder Description	Returns
findByPrimaryKey		one
findByAppId	Finds all skins by application.	many
findByAppIdAndEnabled	Finds all skins by application and enabled status.	many
findBySegmentAndSkinId	Finds a skin definition by application, segment and logical ID.	one
findBySegmentName	Finds all skin definitions by application and segment.	many
findBySkinId	Finds a skin definition by application and logical ID.	one

Method Summary

SkinDefinition	create() Returns a new instance.
SkinDefinition	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 skins by application.
java.util.Collection	findByAppIdAndEnabled(java.lang.String appId, boolean enabledYn) Finds all skins by application and enabled status.
SkinDefinition	findByPrimaryKey(java.lang.String primaryKey) Returns the instance with the given primary key, throws ObjectNotFoundException if the instance is not found.
SkinDefinition	findBySegmentAndSkinId(java.lang.String appId, java.lang.String segmentName, java.lang.String skinId) Finds a skin definition by application, segment and logical ID.
java.util.Collection	findBySegmentName(java.lang.String appId, java.lang.String segmentName) Finds all skin definitions by application and segment.
SkinDefinition	findBySkinId(java.lang.String appId, java.lang.String skinId) Finds a skin definition by application and logical ID.
SkinDefinition	findByUserSegmentAndSkinId(java.lang.String appId, java.lang.String skinId)
SkinDefinition	wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)
java.util.Collection	wrapRepositoryItems(java.util.Collection pRepositoryItems)

Methods inherited from interface javax.ejb.EJBLocalHome

remove

Method Detail

create

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

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

SkinDefinition 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 skins by application.

Returns:

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

findByAppIdAndEnabled

java.util.Collection findByAppIdAndEnabled(java.lang.String appId,
                                           boolean enabledYn)
                                           throws javax.ejb.FinderException,
                                                  javax.ejb.EJBException

Finds all skins by application and enabled status.

Returns:

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

findBySegmentAndSkinId

SkinDefinition findBySegmentAndSkinId(java.lang.String appId,
                                      java.lang.String segmentName,
                                      java.lang.String skinId)
                                      throws javax.ejb.FinderException,
                                             javax.ejb.EJBException

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

Returns:

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

findBySkinId

SkinDefinition findBySkinId(java.lang.String appId,
                            java.lang.String skinId)
                            throws javax.ejb.FinderException,
                                   javax.ejb.EJBException

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

SkinDefinition wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)

findByUserSegmentAndSkinId

SkinDefinition findByUserSegmentAndSkinId(java.lang.String appId,
                                          java.lang.String skinId)
                                          throws ObjectNotFoundException,
                                                 javax.ejb.FinderException,
                                                 javax.ejb.EJBException

Parameters:

appId - Application identifier

skinId - Skin identifier

Returns:

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

Throws:

ObjectNotFoundException

javax.ejb.FinderException

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