atg.svc.repository.beans
Interface RecommendedReadingHome

All Superinterfaces:
javax.ejb.EJBLocalHome
All Known Implementing Classes:
_RecommendedReadingHome_BeanImpl, _RecommendedReadingHome_ReposImpl

public interface RecommendedReadingHome
extends javax.ejb.EJBLocalHome

Finder Summaries

Finder Name Finder Description Returns
findByPrimaryKey one
findBySolutionIdFind all by the solution idmany
findByUserFind all Recommended Reading for a given user profile idmany
findByUserAndDocumentFind all Recommended Reading of specified typemany
findByUserAndSolutionFind all Recommended Reading of specified typemany
findByUserAndTypeFind all Recommended Reading of specified typemany


Method Summary
 RecommendedReading create()
          Returns a new instance.
 RecommendedReading create(java.lang.String pId)
          Returns a new instance with the repository id set to the given id.
 RecommendedReading findByPrimaryKey(java.lang.String primaryKey)
          Returns the instance with the given primary key, throws ObjectNotFoundException if the instance is not found.
 java.util.Collection findBySolutionId(java.lang.String solutionId)
          Find all by the solution id
 java.util.Collection findByUser(java.lang.String userId)
          Find all Recommended Reading for a given user profile id
 java.util.Collection findByUserAndDocument(java.lang.String userId, java.lang.String contextId, java.lang.String URL)
          Find all Recommended Reading of specified type
 java.util.Collection findByUserAndSolution(java.lang.String userId, java.lang.String solutionId)
          Find all Recommended Reading of specified type
 java.util.Collection findByUserAndType(java.lang.String userId, java.lang.String type)
          Find all Recommended Reading of specified type
 RecommendedReading wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)
           
 java.util.Collection wrapRepositoryItems(java.util.Collection pRepositoryItems)
           
 
Methods inherited from interface javax.ejb.EJBLocalHome
remove
 

Method Detail

create

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

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

RecommendedReading 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

findBySolutionId

java.util.Collection findBySolutionId(java.lang.String solutionId)
                                      throws javax.ejb.FinderException,
                                             javax.ejb.EJBException
Find all by the solution id

Parameters:
solutionId - Solution repository Id
Returns:
a Collection of RecommendedReading 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

findByUser

java.util.Collection findByUser(java.lang.String userId)
                                throws javax.ejb.FinderException,
                                       javax.ejb.EJBException
Find all Recommended Reading for a given user profile id

Parameters:
userId - User Profile ID
Returns:
a Collection of RecommendedReading 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

findByUserAndDocument

java.util.Collection findByUserAndDocument(java.lang.String userId,
                                           java.lang.String contextId,
                                           java.lang.String URL)
                                           throws javax.ejb.FinderException,
                                                  javax.ejb.EJBException
Find all Recommended Reading of specified type

Parameters:
userId - User Profile ID
contextId - Context ID
URL - document URL
Returns:
a Collection of RecommendedReading 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

findByUserAndSolution

java.util.Collection findByUserAndSolution(java.lang.String userId,
                                           java.lang.String solutionId)
                                           throws javax.ejb.FinderException,
                                                  javax.ejb.EJBException
Find all Recommended Reading of specified type

Parameters:
userId - User Profile ID
solutionId - Solution repository ID
Returns:
a Collection of RecommendedReading 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

findByUserAndType

java.util.Collection findByUserAndType(java.lang.String userId,
                                       java.lang.String type)
                                       throws javax.ejb.FinderException,
                                              javax.ejb.EJBException
Find all Recommended Reading of specified type

Parameters:
userId - User Profile ID
type - Is "solution" or "Document" or "PDFDocument"?
Returns:
a Collection of RecommendedReading 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

RecommendedReading wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)