| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ProjectHome
| Finder Name | Finder Description | Returns | 
|---|---|---|
| findByPrimaryKey | one | |
| findActiveAndLocked | Returns all the active (non checked in) projects which are locked. | many | 
| findAllProjects | Returns all the projects in the system | many | 
| findById | Returns the project with the given id | one | 
| findCheckedInPriorToInclusive | Returns all the checked in projects | many | 
| findCheckedInProjects | Returns all the checked in projects | many | 
| findEditableProjectsSort | Returns all the editable projects, sorted by the specified properties | many | 
| countOfAllCompletedProjects | Returns the count of all the completed projects in the system | count | 
| countOfAllProjects | Returns the count of all the projects in the system | count | 
| countOfCheckedInProjects | Returns the count of checked in projects in the system | count | 
| findProjectByDeploymentSnapshot | Returns a project in the given snapshot | one | 
| findProjectByWorkspaceName | Returns a project with the given workspace name | one | 
| findProjectsByStatus | Returns all the projects with the given status | many | 
| countProjectsByStatus | Returns the count of all projects with the given status | count | 
| findProjectsByStatusSort | Returns all the projects with the given status, sorted by the specified properties | many | 
| findProjectsCheckedInLaterThan | Returns all the checked in projects which have been checked in after the given date (exclusive) | many | 
| Method Summary | |
|---|---|
|  int | countOfAllCompletedProjects()Returns the count of all the completed projects in the system | 
|  int | countOfAllProjects()Returns the count of all the projects in the system | 
|  int | countOfCheckedInProjects()Returns the count of checked in projects in the system | 
|  int | countProjectsByStatus(java.lang.String pStatus)Returns the count of all projects with the given status | 
|  Project | create()Returns a new instance. | 
|  Project | create(java.lang.String pId)Returns a new instance with the repository id set to the given id. | 
|  Project | createProject(Process pProcess,
              java.lang.String pProjectName,
              java.lang.String pWorkflowName) | 
|  Project | createProject(Process pProcess,
              java.lang.String pProjectName,
              java.lang.String pWorkflowName,
              java.lang.String pSegmentName) | 
|  Project | createProjectForImport(Process pProcess,
                       java.lang.String pProjectName,
                       java.lang.String pWorkflowName,
                       java.lang.String pUser) | 
|  java.util.Collection | findActive(int pStartIndex,
           int pCount) | 
|  java.util.Collection | findActiveAndLocked(int pStartIndex,
                    int pCount)Returns all the active (non checked in) projects which are locked. | 
|  java.util.Collection | findActiveDeployedToTarget(java.lang.String pTargetID,
                           int pStartIndex,
                           int pCount) | 
|  java.util.Collection | findAllProjects(int pStartIndex,
                int pCount)Returns all the projects in the system | 
|  Project | findByDeploymentSnapshot(java.lang.String pTargetID,
                         java.lang.String pSnapshotID) | 
|  java.util.Collection | findByDeploymentStatus(java.lang.String pTargetID,
                       java.lang.Integer pDeploymentStatus,
                       int pStartIndex,
                       int pCount) | 
|  Project | findById(java.lang.String pId)Returns the project with the given id | 
|  Project | findByPrimaryKey(java.lang.String primaryKey)Returns the instance with the given primary key, throws ObjectNotFoundExceptionif the instance is not found. | 
|  java.util.Collection | findCheckedInDeployedToTarget(java.lang.String pTargetID,
                              int pStartIndex,
                              int pCount) | 
|  java.util.Collection | findCheckedInNotDeployedToTarget(java.lang.String pTargetID,
                                 int pStartIndex,
                                 int pCount) | 
|  java.util.Collection | findCheckedInPriorToInclusive(java.sql.Timestamp pTimestamp,
                              int pStartIndex,
                              int pCount)Returns all the checked in projects | 
|  java.util.Collection | findCheckedInProjects(int pStartIndex,
                      int pCount)Returns all the checked in projects | 
|  int | findCountOfActiveDeployedToTarget(java.lang.String pTargetID) | 
|  int | findCountOfCheckedinDeployedToTarget(java.lang.String pTargetID) | 
|  int | findCountOfDeployedToTarget(java.lang.String pTargetID) | 
|  java.util.Collection | findDeployedToTarget(java.lang.String pTargetID,
                     int pStartIndex,
                     int pCount) | 
|  Project[] | findDeploymentPrerequisites(java.lang.String pTargetID,
                            Project[] pDeploymentProjects,
                            boolean pFullDeployment) | 
|  java.util.Collection | findEditableProjectsSort(boolean pEditable,
                         int pStartIndex,
                         int pCount,
                         java.lang.String pSortProperties)Returns all the editable projects, sorted by the specified properties | 
|  Project | findLastestCheckedIn() | 
|  Project | findLatestCheckedInDeployedToTarget(java.lang.String pTargetID) | 
|  java.util.Collection | findOrphanedForTarget(java.lang.String pTargetID,
                      int pStartIndex,
                      int pCount) | 
|  Project | findProjectByDeploymentSnapshot(java.lang.String pSnapshotId)Returns a project in the given snapshot | 
|  Project | findProjectByWorkspaceId(java.lang.String pWorkspaceId)Returns the project with the given workspace id | 
|  Project | findProjectByWorkspaceName(java.lang.String pWorkspaceName)Returns a project with the given workspace name | 
|  java.util.Collection | findProjectsByStatus(java.lang.String pStatus,
                     int pStartIndex,
                     int pCount)Returns all the projects with the given status | 
|  java.util.Collection | findProjectsByStatusSort(java.lang.String pStatus,
                         int pStartIndex,
                         int pCount,
                         java.lang.String pSortProperties)Returns all the projects with the given status, sorted by the specified properties | 
|  java.util.Collection | findProjectsCheckedInLaterThan(java.sql.Timestamp pTime,
                               int pStartIndex,
                               int pCount)Returns all the checked in projects which have been checked in after the given date (exclusive) | 
|  Project | initializeProject(Process pProcess,
                  Project pBeanProject,
                  java.lang.String pWorkflowName) | 
|  Project | initializeProject(Process pProcess,
                  Project pBeanProject,
                  java.lang.String pWorkflowName,
                  java.lang.String pSegmentName) | 
|  Project | initializeProjectWithGlobalWorkflow(Process pProcess,
                                    Project pBeanProject,
                                    java.lang.String pWorkflowName) | 
|  Project | initializeProjectWithoutWorkflow(Process pProcess,
                                 Project pBeanProject) | 
|  Project | wrapRepositoryItem(RepositoryItem pRepositoryItem) | 
|  java.util.Collection | wrapRepositoryItems(java.util.Collection pRepositoryItems) | 
| Methods inherited from interface javax.ejb.EJBLocalHome | 
|---|
| remove | 
| Method Detail | 
|---|
Project create()
               throws javax.ejb.CreateException,
                      javax.ejb.EJBException
EPubHomes factory was obtained. If the instance is backed by a persistent implementation, it may not actually be persisted until Project.writeInstance() is called on the instance (and the transaction is committed, if the implementation is transaction-aware).
javax.ejb.CreateException
javax.ejb.EJBException
Project create(java.lang.String pId)
               throws javax.ejb.CreateException,
                      javax.ejb.EJBException
EPubHomes factory was obtained. If the instance is backed by a persistent implementation, it may not actually be persisted until Project.writeInstance() is called on the instance (and the transaction is committed, if the implementation is transaction-aware).
javax.ejb.CreateException
javax.ejb.EJBException
Project findByPrimaryKey(java.lang.String primaryKey)
                         throws javax.ejb.FinderException,
                                javax.ejb.EJBException
ObjectNotFoundException if the instance is not found.
javax.ejb.FinderException
javax.ejb.EJBException
java.util.Collection findActiveAndLocked(int pStartIndex,
                                         int pCount)
                                         throws javax.ejb.FinderException,
                                                javax.ejb.EJBException
pStartIndex - The starting index within the result set to return the items frompCount - The number of items within the result set to return starting at pStartIndex
Collection of Project 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.
javax.ejb.FinderException
javax.ejb.EJBException
java.util.Collection findAllProjects(int pStartIndex,
                                     int pCount)
                                     throws javax.ejb.FinderException,
                                            javax.ejb.EJBException
pStartIndex - The starting index within the result set to return the items frompCount - The number of items within the result set to return starting at pStartIndex
Collection of Project 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.
javax.ejb.FinderException
javax.ejb.EJBException
Project findById(java.lang.String pId)
                 throws javax.ejb.FinderException,
                        javax.ejb.EJBException
pId - The project id to return
ObjectNotFoundException if no such instance is found.
javax.ejb.FinderException
javax.ejb.EJBException
java.util.Collection findCheckedInPriorToInclusive(java.sql.Timestamp pTimestamp,
                                                   int pStartIndex,
                                                   int pCount)
                                                   throws javax.ejb.FinderException,
                                                          javax.ejb.EJBException
pTimestamp - Checkin time to compare against.pStartIndex - The starting index within the result set to return the items frompCount - The number of items within the result set to return starting at pStartIndex
Collection of Project 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.
javax.ejb.FinderException
javax.ejb.EJBException
java.util.Collection findCheckedInProjects(int pStartIndex,
                                           int pCount)
                                           throws javax.ejb.FinderException,
                                                  javax.ejb.EJBException
pStartIndex - The starting index within the result set to return the items frompCount - The number of items within the result set to return starting at pStartIndex
Collection of Project 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.
javax.ejb.FinderException
javax.ejb.EJBException
java.util.Collection findEditableProjectsSort(boolean pEditable,
                                              int pStartIndex,
                                              int pCount,
                                              java.lang.String pSortProperties)
                                              throws javax.ejb.FinderException,
                                                     javax.ejb.EJBException
pEditable - Determines whether to return editable of noneditable projectspStartIndex - The starting index within the result set to return the items frompCount - The number of items within the result set to return starting at pStartIndexpSortProperties - A comma separated list of project properties to sort by
Collection of Project 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.
javax.ejb.FinderException
javax.ejb.EJBException
int countOfAllCompletedProjects()
                                throws javax.ejb.FinderException,
                                       javax.ejb.EJBException
javax.ejb.FinderException
javax.ejb.EJBException
int countOfAllProjects()
                       throws javax.ejb.FinderException,
                              javax.ejb.EJBException
javax.ejb.FinderException
javax.ejb.EJBException
int countOfCheckedInProjects()
                             throws javax.ejb.FinderException,
                                    javax.ejb.EJBException
javax.ejb.FinderException
javax.ejb.EJBException
Project findProjectByDeploymentSnapshot(java.lang.String pSnapshotId)
                                        throws javax.ejb.FinderException,
                                               javax.ejb.EJBException
pSnapshotId - The id of the snapshot
ObjectNotFoundException if no such instance is found.
javax.ejb.FinderException
javax.ejb.EJBException
Project findProjectByWorkspaceName(java.lang.String pWorkspaceName)
                                   throws javax.ejb.FinderException,
                                          javax.ejb.EJBException
pWorkspaceName - The name of the workspace to return the associated project for
ObjectNotFoundException if no such instance is found.
javax.ejb.FinderException
javax.ejb.EJBException
java.util.Collection findProjectsByStatus(java.lang.String pStatus,
                                          int pStartIndex,
                                          int pCount)
                                          throws javax.ejb.FinderException,
                                                 javax.ejb.EJBException
pStatus - The status of the desired projects. One of "Active", "Completed", "Suspended", "Error"pStartIndex - The starting index within the result set to return the items frompCount - The number of items within the result set to return starting at pStartIndex
Collection of Project 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.
javax.ejb.FinderException
javax.ejb.EJBException
int countProjectsByStatus(java.lang.String pStatus)
                          throws javax.ejb.FinderException,
                                 javax.ejb.EJBException
pStatus - The status of the desired projects. One of "Active", "Completed", "Suspended", "Error"
javax.ejb.FinderException
javax.ejb.EJBException
java.util.Collection findProjectsByStatusSort(java.lang.String pStatus,
                                              int pStartIndex,
                                              int pCount,
                                              java.lang.String pSortProperties)
                                              throws javax.ejb.FinderException,
                                                     javax.ejb.EJBException
pStatus - The status of the desired projects. One of "Active", "Completed", "Suspended", "Error"pStartIndex - The starting index within the result set to return the items frompCount - The number of items within the result set to return starting at pStartIndexpSortProperties - A comma separated list of project properties to sort by
Collection of Project 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.
javax.ejb.FinderException
javax.ejb.EJBException
java.util.Collection findProjectsCheckedInLaterThan(java.sql.Timestamp pTime,
                                                    int pStartIndex,
                                                    int pCount)
                                                    throws javax.ejb.FinderException,
                                                           javax.ejb.EJBException
pTime - Resultant projects will be checked in after this time.pStartIndex - The starting index within the result set to return the items frompCount - The number of items within the result set to return starting at pStartIndex
Collection of Project 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.
javax.ejb.FinderException
javax.ejb.EJBExceptionjava.util.Collection wrapRepositoryItems(java.util.Collection pRepositoryItems)
Project wrapRepositoryItem(RepositoryItem pRepositoryItem)
java.util.Collection findDeployedToTarget(java.lang.String pTargetID,
                                          int pStartIndex,
                                          int pCount)
                                          throws javax.ejb.FinderException,
                                                 javax.ejb.EJBException
pTargetID - pStartIndex - pCount - 
javax.ejb.FinderException
javax.ejb.EJBException - A system-level error occurred
int findCountOfDeployedToTarget(java.lang.String pTargetID)
                                throws javax.ejb.EJBException,
                                       javax.ejb.FinderException
pTargetID - 
javax.ejb.EJBException - A system-level error occurred
javax.ejb.FinderException - An application-level error occurred
int findCountOfActiveDeployedToTarget(java.lang.String pTargetID)
                                      throws javax.ejb.EJBException,
                                             javax.ejb.FinderException
pTargetID - 
javax.ejb.EJBException - A system-level error occurred
javax.ejb.FinderException - An application-level error occurred
int findCountOfCheckedinDeployedToTarget(java.lang.String pTargetID)
                                         throws javax.ejb.EJBException,
                                                javax.ejb.FinderException
pTargetID - 
javax.ejb.EJBException - A system-level error occurred
javax.ejb.FinderException - An application-level error occurred
java.util.Collection findCheckedInDeployedToTarget(java.lang.String pTargetID,
                                                   int pStartIndex,
                                                   int pCount)
                                                   throws javax.ejb.FinderException,
                                                          javax.ejb.EJBException
pTargetID - pStartIndex - pCount - 
javax.ejb.FinderException
javax.ejb.EJBException - A system-level error occurred
Project findLatestCheckedInDeployedToTarget(java.lang.String pTargetID)
                                            throws javax.ejb.FinderException,
                                                   javax.ejb.EJBException
pTargetID - 
javax.ejb.FinderException
javax.ejb.EJBException - A system-level error occurred
Project findByDeploymentSnapshot(java.lang.String pTargetID,
                                 java.lang.String pSnapshotID)
                                 throws javax.ejb.FinderException,
                                        javax.ejb.EJBException
pTargetID - pSnapshotID - 
javax.ejb.FinderException
javax.ejb.EJBException - A system-level error occurred
java.util.Collection findActiveDeployedToTarget(java.lang.String pTargetID,
                                                int pStartIndex,
                                                int pCount)
                                                throws javax.ejb.FinderException,
                                                       javax.ejb.EJBException
pTargetID - pStartIndex - pCount - 
javax.ejb.FinderException
javax.ejb.EJBException - A system-level error occurred
java.util.Collection findActive(int pStartIndex,
                                int pCount)
                                throws javax.ejb.FinderException,
                                       javax.ejb.EJBException
pStartIndex - pCount - 
javax.ejb.FinderException
javax.ejb.EJBException - A system-level error occurred
java.util.Collection findOrphanedForTarget(java.lang.String pTargetID,
                                           int pStartIndex,
                                           int pCount)
                                           throws javax.ejb.FinderException,
                                                  javax.ejb.EJBException
pTargetID - pStartIndex - pCount - 
javax.ejb.FinderException
javax.ejb.EJBException - A system-level error occurred
java.util.Collection findCheckedInNotDeployedToTarget(java.lang.String pTargetID,
                                                      int pStartIndex,
                                                      int pCount)
                                                      throws javax.ejb.FinderException,
                                                             javax.ejb.EJBException
pTargetID - pStartIndex - pCount - 
javax.ejb.FinderException
javax.ejb.EJBException - A system-level error occurred
java.util.Collection findByDeploymentStatus(java.lang.String pTargetID,
                                            java.lang.Integer pDeploymentStatus,
                                            int pStartIndex,
                                            int pCount)
                                            throws javax.ejb.FinderException,
                                                   javax.ejb.EJBException
pTargetID - pDeploymentStatus - pStartIndex - pCount - 
javax.ejb.FinderException
javax.ejb.EJBException - A system-level error occurred
Project findLastestCheckedIn()
                             throws javax.ejb.FinderException,
                                    javax.ejb.EJBException
javax.ejb.FinderException
javax.ejb.EJBException - A system-level error occurred
Project findProjectByWorkspaceId(java.lang.String pWorkspaceId)
                                 throws javax.ejb.FinderException,
                                        VersionException,
                                        javax.ejb.EJBException
pWorkspaceId - The workspace id to find the project for
javax.ejb.FinderException - If the project could not be found
VersionException - If a version manager exception occurs
javax.ejb.EJBException - A system-level error occurred
Project createProject(Process pProcess,
                      java.lang.String pProjectName,
                      java.lang.String pWorkflowName)
                      throws ActionException,
                             WorkflowException,
                             javax.ejb.CreateException,
                             atg.epub.project.InvalidStateException,
                             VersionException,
                             TransactionDemarcationException,
                             javax.ejb.EJBException
pProcess - pProjectName - pWorkflowName - 
ActionException
WorkflowException
javax.ejb.CreateException
atg.epub.project.InvalidStateException
VersionException
TransactionDemarcationException
javax.ejb.EJBException - A system-level error occurred
Project createProject(Process pProcess,
                      java.lang.String pProjectName,
                      java.lang.String pWorkflowName,
                      java.lang.String pSegmentName)
                      throws ActionException,
                             WorkflowException,
                             javax.ejb.CreateException,
                             atg.epub.project.InvalidStateException,
                             VersionException,
                             TransactionDemarcationException,
                             javax.ejb.EJBException
pProcess - pProjectName - pWorkflowName - pSegmentName - 
ActionException
WorkflowException
javax.ejb.CreateException
atg.epub.project.InvalidStateException
VersionException
TransactionDemarcationException
javax.ejb.EJBException - A system-level error occurred
Project createProjectForImport(Process pProcess,
                               java.lang.String pProjectName,
                               java.lang.String pWorkflowName,
                               java.lang.String pUser)
                               throws javax.ejb.CreateException,
                                      javax.ejb.RemoveException,
                                      javax.ejb.FinderException,
                                      javax.ejb.EJBException
pProcess - pProjectName - pWorkflowName - pUser - 
javax.ejb.CreateException
javax.ejb.RemoveException
javax.ejb.FinderException
javax.ejb.EJBException - A system-level error occurred
Project initializeProject(Process pProcess,
                          Project pBeanProject,
                          java.lang.String pWorkflowName)
                          throws ActionException,
                                 WorkflowException,
                                 javax.ejb.CreateException,
                                 atg.epub.project.InvalidStateException,
                                 VersionException,
                                 TransactionDemarcationException,
                                 javax.ejb.EJBException
pProcess - pBeanProject - pWorkflowName - 
ActionException
WorkflowException
javax.ejb.CreateException
atg.epub.project.InvalidStateException
VersionException
TransactionDemarcationException
javax.ejb.EJBException - A system-level error occurred
Project initializeProject(Process pProcess,
                          Project pBeanProject,
                          java.lang.String pWorkflowName,
                          java.lang.String pSegmentName)
                          throws ActionException,
                                 WorkflowException,
                                 javax.ejb.CreateException,
                                 atg.epub.project.InvalidStateException,
                                 VersionException,
                                 TransactionDemarcationException,
                                 javax.ejb.EJBException
pProcess - pBeanProject - pWorkflowName - pSegmentName - 
ActionException
WorkflowException
javax.ejb.CreateException
atg.epub.project.InvalidStateException
VersionException
TransactionDemarcationException
javax.ejb.EJBException - A system-level error occurred
Project initializeProjectWithoutWorkflow(Process pProcess,
                                         Project pBeanProject)
                                         throws javax.ejb.CreateException,
                                                atg.epub.project.InvalidStateException,
                                                VersionException,
                                                TransactionDemarcationException,
                                                javax.ejb.EJBException
pProcess - pBeanProject - 
javax.ejb.CreateException
atg.epub.project.InvalidStateException
VersionException
TransactionDemarcationException
javax.ejb.EJBException - A system-level error occurred
Project initializeProjectWithGlobalWorkflow(Process pProcess,
                                            Project pBeanProject,
                                            java.lang.String pWorkflowName)
                                            throws ActionException,
                                                   WorkflowException,
                                                   javax.ejb.CreateException,
                                                   atg.epub.project.InvalidStateException,
                                                   VersionException,
                                                   TransactionDemarcationException,
                                                   javax.ejb.EJBException
pProcess - pBeanProject - pWorkflowName - 
ActionException
WorkflowException
javax.ejb.CreateException
atg.epub.project.InvalidStateException
VersionException
TransactionDemarcationException
javax.ejb.EJBException - A system-level error occurred
Project[] findDeploymentPrerequisites(java.lang.String pTargetID,
                                      Project[] pDeploymentProjects,
                                      boolean pFullDeployment)
                                      throws javax.ejb.EJBException,
                                             javax.ejb.FinderException
pTargetID - pDeploymentProjects - pFullDeployment - 
javax.ejb.EJBException - A system-level error occurred
javax.ejb.FinderException - An application-level error occurred| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||