atg.svc.repository.beans
Interface KnowledgeSessionHome

All Superinterfaces:

javax.ejb.EJBLocalHome

All Known Implementing Classes:

_KnowledgeSessionHome_BeanImpl, _KnowledgeSessionHome_ReposImpl

public interface KnowledgeSessionHome
extends javax.ejb.EJBLocalHome

Finder Summaries

Finder Name	Finder Description	Returns
findByPrimaryKey		one
findByUser	Find all knowledge sessions for a given user profile id	many
findByUserWithPaging	Find all knowledge sessions for a given user profile id	many
findMostRecentSessionByUser	Find the current or most recent knowledge session for a given user profile id	one

Method Summary

KnowledgeSession	create() Returns a new instance.
KnowledgeSession	create(java.lang.String pId) Returns a new instance with the repository id set to the given id.
KnowledgeSession	findByPrimaryKey(java.lang.String primaryKey) Returns the instance with the given primary key, throws ObjectNotFoundException if the instance is not found.
java.util.Collection	findByUser(java.lang.String userId) Find all knowledge sessions for a given user profile id
java.util.Collection	findByUserWithPaging(java.lang.String userId, int startingIndex, int numItems) Find all knowledge sessions for a given user profile id
KnowledgeSession	findMostRecentSessionByUser(java.lang.String userId) Find the current or most recent knowledge session for a given user profile id
KnowledgeSession	wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)
java.util.Collection	wrapRepositoryItems(java.util.Collection pRepositoryItems)

Methods inherited from interface javax.ejb.EJBLocalHome

remove

Method Detail

create

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

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

KnowledgeSession 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

findByUser

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

Find all knowledge sessions for a given user profile id

Parameters:

userId - User Profile ID

Returns:

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

findByUserWithPaging

java.util.Collection findByUserWithPaging(java.lang.String userId,
                                          int startingIndex,
                                          int numItems)
                                          throws javax.ejb.FinderException,
                                                 javax.ejb.EJBException

Find all knowledge sessions for a given user profile id

Parameters:

userId - User Profile ID

startingIndex - Starting Index of items to be retreived.

numItems - # items to be retreived.

Returns:

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

findMostRecentSessionByUser

KnowledgeSession findMostRecentSessionByUser(java.lang.String userId)
                                             throws javax.ejb.FinderException,
                                                    javax.ejb.EJBException

Find the current or most recent knowledge session for a given user profile id

Parameters:

userId - User Profile 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

KnowledgeSession wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)