atg.epub.project
Interface ProjectHome

All Superinterfaces:

javax.ejb.EJBLocalHome

public interface ProjectHome
extends javax.ejb.EJBLocalHome

Finder Summaries

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	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 ObjectNotFoundException if 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	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

create

Project 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 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).

Throws:

javax.ejb.CreateException

javax.ejb.EJBException

create

Project 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 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).

Throws:

javax.ejb.CreateException

javax.ejb.EJBException

findByPrimaryKey

Project 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

findActiveAndLocked

java.util.Collection findActiveAndLocked(int pStartIndex,
                                         int pCount)
                                         throws javax.ejb.FinderException,
                                                javax.ejb.EJBException

Returns all the active (non checked in) projects which are locked.

Parameters:

pStartIndex - The starting index within the result set to return the items from

pCount - The number of items within the result set to return starting at pStartIndex

Returns:

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

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findAllProjects

java.util.Collection findAllProjects(int pStartIndex,
                                     int pCount)
                                     throws javax.ejb.FinderException,
                                            javax.ejb.EJBException

Returns all the projects in the system

Parameters:

pStartIndex - The starting index within the result set to return the items from

pCount - The number of items within the result set to return starting at pStartIndex

Returns:

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

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findById

Project findById(java.lang.String pId)
                 throws javax.ejb.FinderException,
                        javax.ejb.EJBException

Returns the project with the given id

Parameters:

pId - The project id to return

Returns:

an instance matching the query criteria, or throws ObjectNotFoundException if no such instance is found.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findCheckedInPriorToInclusive

java.util.Collection findCheckedInPriorToInclusive(java.sql.Timestamp pTimestamp,
                                                   int pStartIndex,
                                                   int pCount)
                                                   throws javax.ejb.FinderException,
                                                          javax.ejb.EJBException

Returns all the checked in projects

Parameters:

pTimestamp - Checkin time to compare against.

pStartIndex - The starting index within the result set to return the items from

pCount - The number of items within the result set to return starting at pStartIndex

Returns:

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

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findCheckedInProjects

java.util.Collection findCheckedInProjects(int pStartIndex,
                                           int pCount)
                                           throws javax.ejb.FinderException,
                                                  javax.ejb.EJBException

Returns all the checked in projects

Parameters:

pStartIndex - The starting index within the result set to return the items from

pCount - The number of items within the result set to return starting at pStartIndex

Returns:

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

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findEditableProjectsSort

java.util.Collection findEditableProjectsSort(boolean pEditable,
                                              int pStartIndex,
                                              int pCount,
                                              java.lang.String pSortProperties)
                                              throws javax.ejb.FinderException,
                                                     javax.ejb.EJBException

Returns all the editable projects, sorted by the specified properties

Parameters:

pEditable - Determines whether to return editable of noneditable projects

pStartIndex - The starting index within the result set to return the items from

pCount - The number of items within the result set to return starting at pStartIndex

pSortProperties - A comma separated list of project properties to sort by

Returns:

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

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

countOfAllCompletedProjects

int countOfAllCompletedProjects()
                                throws javax.ejb.FinderException,
                                       javax.ejb.EJBException

Returns the count of all the completed projects in the system

Returns:

the number of instances matching the query criteria.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

countOfAllProjects

int countOfAllProjects()
                       throws javax.ejb.FinderException,
                              javax.ejb.EJBException

Returns the count of all the projects in the system

Returns:

the number of instances matching the query criteria.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

countOfCheckedInProjects

int countOfCheckedInProjects()
                             throws javax.ejb.FinderException,
                                    javax.ejb.EJBException

Returns the count of checked in projects in the system

Returns:

the number of instances matching the query criteria.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findProjectByDeploymentSnapshot

Project findProjectByDeploymentSnapshot(java.lang.String pSnapshotId)
                                        throws javax.ejb.FinderException,
                                               javax.ejb.EJBException

Returns a project in the given snapshot

Parameters:

pSnapshotId - The id of the snapshot

Returns:

an instance matching the query criteria, or throws ObjectNotFoundException if no such instance is found.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findProjectByWorkspaceName

Project findProjectByWorkspaceName(java.lang.String pWorkspaceName)
                                   throws javax.ejb.FinderException,
                                          javax.ejb.EJBException

Returns a project with the given workspace name

Parameters:

pWorkspaceName - The name of the workspace to return the associated project for

Returns:

an instance matching the query criteria, or throws ObjectNotFoundException if no such instance is found.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findProjectsByStatus

java.util.Collection findProjectsByStatus(java.lang.String pStatus,
                                          int pStartIndex,
                                          int pCount)
                                          throws javax.ejb.FinderException,
                                                 javax.ejb.EJBException

Returns all the projects with the given status

Parameters:

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 from

pCount - The number of items within the result set to return starting at pStartIndex

Returns:

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

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

countProjectsByStatus

int countProjectsByStatus(java.lang.String pStatus)
                          throws javax.ejb.FinderException,
                                 javax.ejb.EJBException

Returns the count of all projects with the given status

Parameters:

pStatus - The status of the desired projects. One of "Active", "Completed", "Suspended", "Error"

Returns:

the number of instances matching the query criteria.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findProjectsByStatusSort

java.util.Collection findProjectsByStatusSort(java.lang.String pStatus,
                                              int pStartIndex,
                                              int pCount,
                                              java.lang.String pSortProperties)
                                              throws javax.ejb.FinderException,
                                                     javax.ejb.EJBException

Returns all the projects with the given status, sorted by the specified properties

Parameters:

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 from

pCount - The number of items within the result set to return starting at pStartIndex

pSortProperties - A comma separated list of project properties to sort by

Returns:

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

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findProjectsCheckedInLaterThan

java.util.Collection findProjectsCheckedInLaterThan(java.sql.Timestamp pTime,
                                                    int pStartIndex,
                                                    int pCount)
                                                    throws javax.ejb.FinderException,
                                                           javax.ejb.EJBException

Returns all the checked in projects which have been checked in after the given date (exclusive)

Parameters:

pTime - Resultant projects will be checked in after this time.

pStartIndex - The starting index within the result set to return the items from

pCount - The number of items within the result set to return starting at pStartIndex

Returns:

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

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

wrapRepositoryItems

java.util.Collection wrapRepositoryItems(java.util.Collection pRepositoryItems)

wrapRepositoryItem

Project wrapRepositoryItem(RepositoryItem pRepositoryItem)

findDeployedToTarget

java.util.Collection findDeployedToTarget(java.lang.String pTargetID,
                                          int pStartIndex,
                                          int pCount)
                                          throws javax.ejb.FinderException,
                                                 javax.ejb.EJBException

Parameters:

pTargetID -

pStartIndex -

pCount -

Throws:

javax.ejb.FinderException

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

findCountOfDeployedToTarget

int findCountOfDeployedToTarget(java.lang.String pTargetID)
                                throws javax.ejb.EJBException,
                                       javax.ejb.FinderException

Parameters:

pTargetID -

Throws:

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

javax.ejb.FinderException - An application-level error occurred

findCountOfActiveDeployedToTarget

int findCountOfActiveDeployedToTarget(java.lang.String pTargetID)
                                      throws javax.ejb.EJBException,
                                             javax.ejb.FinderException

Parameters:

pTargetID -

Throws:

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

javax.ejb.FinderException - An application-level error occurred

findCountOfCheckedinDeployedToTarget

int findCountOfCheckedinDeployedToTarget(java.lang.String pTargetID)
                                         throws javax.ejb.EJBException,
                                                javax.ejb.FinderException

Parameters:

pTargetID -

Throws:

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

javax.ejb.FinderException - An application-level error occurred

findCheckedInDeployedToTarget

java.util.Collection findCheckedInDeployedToTarget(java.lang.String pTargetID,
                                                   int pStartIndex,
                                                   int pCount)
                                                   throws javax.ejb.FinderException,
                                                          javax.ejb.EJBException

Parameters:

pTargetID -

pStartIndex -

pCount -

Throws:

javax.ejb.FinderException

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

findLatestCheckedInDeployedToTarget

Project findLatestCheckedInDeployedToTarget(java.lang.String pTargetID)
                                            throws javax.ejb.FinderException,
                                                   javax.ejb.EJBException

Parameters:

pTargetID -

Returns:

The project deployed to given target and last checked in.

Throws:

javax.ejb.FinderException

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

findByDeploymentSnapshot

Project findByDeploymentSnapshot(java.lang.String pTargetID,
                                 java.lang.String pSnapshotID)
                                 throws javax.ejb.FinderException,
                                        javax.ejb.EJBException

Parameters:

pTargetID -

pSnapshotID -

Returns:

The project deployed to given target and last checked in.

Throws:

javax.ejb.FinderException

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

findActiveDeployedToTarget

java.util.Collection findActiveDeployedToTarget(java.lang.String pTargetID,
                                                int pStartIndex,
                                                int pCount)
                                                throws javax.ejb.FinderException,
                                                       javax.ejb.EJBException

Parameters:

pTargetID -

pStartIndex -

pCount -

Throws:

javax.ejb.FinderException

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

findActive

java.util.Collection findActive(int pStartIndex,
                                int pCount)
                                throws javax.ejb.FinderException,
                                       javax.ejb.EJBException

Parameters:

pStartIndex -

pCount -

Throws:

javax.ejb.FinderException

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

findOrphanedForTarget

java.util.Collection findOrphanedForTarget(java.lang.String pTargetID,
                                           int pStartIndex,
                                           int pCount)
                                           throws javax.ejb.FinderException,
                                                  javax.ejb.EJBException

Parameters:

pTargetID -

pStartIndex -

pCount -

Throws:

javax.ejb.FinderException

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

findCheckedInNotDeployedToTarget

java.util.Collection findCheckedInNotDeployedToTarget(java.lang.String pTargetID,
                                                      int pStartIndex,
                                                      int pCount)
                                                      throws javax.ejb.FinderException,
                                                             javax.ejb.EJBException

Parameters:

pTargetID -

pStartIndex -

pCount -

Throws:

javax.ejb.FinderException

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

findByDeploymentStatus

java.util.Collection findByDeploymentStatus(java.lang.String pTargetID,
                                            java.lang.Integer pDeploymentStatus,
                                            int pStartIndex,
                                            int pCount)
                                            throws javax.ejb.FinderException,
                                                   javax.ejb.EJBException

Parameters:

pTargetID -

pDeploymentStatus -

pStartIndex -

pCount -

Throws:

javax.ejb.FinderException

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

findLastestCheckedIn

Project findLastestCheckedIn()
                             throws javax.ejb.FinderException,
                                    javax.ejb.EJBException

Returns:

A checked in project that is the lastest to be deployed to target

Throws:

javax.ejb.FinderException

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

findProjectByWorkspaceId

Project findProjectByWorkspaceId(java.lang.String pWorkspaceId)
                                 throws javax.ejb.FinderException,
                                        VersionException,
                                        javax.ejb.EJBException

Returns the project with the given workspace id

Parameters:

pWorkspaceId - The workspace id to find the project for

Returns:

The project associated with the given workspace id

Throws:

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

createProject

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

Parameters:

pProcess -

pProjectName -

pWorkflowName -

Throws:

ActionException

WorkflowException

javax.ejb.CreateException

atg.epub.project.InvalidStateException

VersionException

TransactionDemarcationException

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

createProjectForImport

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

Parameters:

pProcess -

pProjectName -

pWorkflowName -

pUser -

Throws:

javax.ejb.CreateException

javax.ejb.RemoveException

javax.ejb.FinderException

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

initializeProject

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

Parameters:

pProcess -

pBeanProject -

pWorkflowName -

Throws:

ActionException

WorkflowException

javax.ejb.CreateException

atg.epub.project.InvalidStateException

VersionException

TransactionDemarcationException

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

initializeProjectWithoutWorkflow

Project initializeProjectWithoutWorkflow(Process pProcess,
                                         Project pBeanProject)
                                         throws javax.ejb.CreateException,
                                                atg.epub.project.InvalidStateException,
                                                VersionException,
                                                TransactionDemarcationException,
                                                javax.ejb.EJBException

Parameters:

pProcess -

pBeanProject -

Throws:

javax.ejb.CreateException

atg.epub.project.InvalidStateException

VersionException

TransactionDemarcationException

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

initializeProjectWithGlobalWorkflow

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

Parameters:

pProcess -

pBeanProject -

pWorkflowName -

Throws:

ActionException

WorkflowException

javax.ejb.CreateException

atg.epub.project.InvalidStateException

VersionException

TransactionDemarcationException

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

findDeploymentPrerequisites

Project[] findDeploymentPrerequisites(java.lang.String pTargetID,
                                      Project[] pDeploymentProjects,
                                      boolean pFullDeployment)
                                      throws javax.ejb.EJBException,
                                             javax.ejb.FinderException

Parameters:

pTargetID -

pDeploymentProjects -

pFullDeployment -

Throws:

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

javax.ejb.FinderException - An application-level error occurred