atg.svc.repository.beans
Interface UserOptionHome

All Superinterfaces:

javax.ejb.EJBLocalHome

public interface UserOptionHome
extends javax.ejb.EJBLocalHome

Finder Summaries

Finder Name	Finder Description	Returns
findByPrimaryKey		one
findByUserId	Gets the collection of user options for a given user id	many
findByUserIdAndName	Finds a single user option by userId and key	one

Method Summary

UserOption	create() Returns a new instance.
UserOption	create(java.lang.String pId) Returns a new instance with the repository id set to the given id.
UserOption	findByPrimaryKey(java.lang.String primaryKey) Returns the instance with the given primary key, throws ObjectNotFoundException if the instance is not found.
java.util.Collection	findByUserId(java.lang.String userId) Gets the collection of user options for a given user id
UserOption	findByUserIdAndName(java.lang.String userId, java.lang.String name) Finds a single user option by userId and key
UserOption	wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)
java.util.Collection	wrapRepositoryItems(java.util.Collection pRepositoryItems)

Methods inherited from interface javax.ejb.EJBLocalHome

remove

Method Detail

create

UserOption 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 UserOptionHomes factory was obtained. If the instance is backed by a persistent implementation, it may not actually be persisted until UserOption.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

UserOption 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 UserOptionHomes factory was obtained. If the instance is backed by a persistent implementation, it may not actually be persisted until UserOption.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

UserOption 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

findByUserId

java.util.Collection findByUserId(java.lang.String userId)
                                  throws javax.ejb.FinderException,
                                         javax.ejb.EJBException

Gets the collection of user options for a given user id

Parameters:

userId - User Id

Returns:

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

findByUserIdAndName

UserOption findByUserIdAndName(java.lang.String userId,
                               java.lang.String name)
                               throws javax.ejb.FinderException,
                                      javax.ejb.EJBException

Finds a single user option by userId and key

Parameters:

userId - User Id

name - Option name

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

UserOption wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)