public interface Project
extends javax.ejb.EJBLocalObject
ProjectHome
Attribute Name | Attribute Value |
---|---|
atg.repository.query.SupportedQueries | and, comparison, constant, inFolders, includesAny, includes, includesItem, isNull, matchId, not, or, patternMatch, property, propertyOf, unconstrained, patternMatch, textSearch |
categoryAdvancedPriority | 60 |
categoryAssetsPriority | 30 |
categoryBasicsPriority | 10 |
categoryDeploymentPriority | 40 |
categoryHistoryPriority | 50 |
categoryInfoPriority | 70 |
categoryStatusPriority | 20 |
references | [:process.project] |
resourceBundle | atg.epub.PublishingRepositoryResources |
Property assets ("Assets"): Set
getAssets()
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property checkedIn ("Checked in"): boolean
isCheckedIn()
setCheckedIn(boolean)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property checkedInAssets ("Checked in assets"): Set
getCheckedInAssets()
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property checkinDate ("Checkin date"): Timestamp
getCheckinDate()
setCheckinDate(java.sql.Timestamp)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property completionDate ("Completion date"): Timestamp
getCompletionDate()
setCompletionDate(java.sql.Timestamp)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property creationDate ("Creation date"): Timestamp
getCreationDate()
setCreationDate(java.sql.Timestamp)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property creator ("Creator"): RepositoryItem
getCreator()
setCreator(atg.repository.RepositoryItem)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property deploymentApprovalTimes ("Deployment approval times"): Map
getDeploymentApprovalTimes()
setDeploymentApprovalTimes(java.util.Map)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property deploymentIds ("Deployment ids"): Map
getDeploymentIds()
setDeploymentIds(java.util.Map)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property deploymentSnapshots ("Deployment target snapshots"): Map
getDeploymentSnapshots()
setDeploymentSnapshots(java.util.Map)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property deploymentStatuses ("Deployment target statuses"): Map
getDeploymentStatuses()
setDeploymentStatuses(java.util.Map)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property deploymentTimes ("Deployment times"): Map
getDeploymentTimes()
setDeploymentTimes(java.util.Map)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property description ("Description"): String
getDescription()
setDescription(java.lang.String)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property displayName ("Name"): String
getDisplayName()
setDisplayName(java.lang.String)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property editable ("Editable"): boolean
isEditable()
setEditable(boolean)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property history ("History"): List
of History
getHistory()
setHistory(java.util.List)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property id ("Project id"): String
getId()
setId(java.lang.String)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property locked ("Locked"): boolean
isLocked()
setLocked(boolean)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property status ("Status"): ProjectEnumStatus
getStatus()
setStatus(atg.epub.project.ProjectEnumStatus)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property statusDetail ("Status detail"): String
getStatusDetail()
setStatusDetail(java.lang.String)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property version ("Version"): int
getVersion()
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property workflow ("Workflow"): RepositoryItem
getWorkflow()
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property workflowId ("Workflow id"): String
getWorkflowId()
setWorkflowId(java.lang.String)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property workspace ("Workspace"): String
getWorkspace()
setWorkspace(java.lang.String)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Modifier and Type | Method and Description |
---|---|
boolean |
_isMutable()
Returns true if the item is mutable.
|
void |
abandon()
This method will abandon the project so it can never be deployed
|
void |
acquireAssetLocks()
Acquires asset locks for all assets in the Project.
|
void |
addAsset(java.lang.String[] pAssetURIs)
Adds an asset to this project
|
History |
addHistory(java.lang.String pAction,
java.lang.String pActionType,
java.lang.String pDescription,
java.util.Collection pParams)
Adds a history element/note to this project
|
void |
approveDeployment()
Flags the project as approved for deployment to all known
deployment targets.
|
void |
approveDeployment(Target pTarget)
Flags the project as approved for deployment to the specified
deployment target.
|
boolean |
assetInProject(VersionManagerURI pAssetURI)
Returns true if the specified asset already exists in this project
|
void |
checkin(java.lang.String pUsername,
java.lang.String pComment)
Checks in the assets in the workspace associated with this project
|
void |
cloneAssets(Project pSourceProject)
Checks out all the assets that are in the source project, into this project
|
void |
complete()
This method will complete a project by setting its completionDate, editable flag to false, and status flag to completed
|
void |
complete(boolean pFireCompleteMessage)
This method will complete a project by setting its completionDate, editable flag to false, and status flag to completed
|
void |
copyTo(Project destination)
Copies the property values of this instance to another instance of the same data type.
|
void |
delete(int pMessageStatus,
java.lang.String pInitiatorID)
This method will delete a project, its associated workflow, and associated workspace.
|
void |
delete(java.lang.String pInitiatorID)
This method will delete a project, its associated workflow, and associated workspace.
|
void |
discardAsset(java.lang.String[] pAssetURIs)
Removes an asset from the project completely.
|
java.util.Collection |
findCrossProjectDeleteDependencies(java.util.Collection pCandidateProjects)
This method is only valid for Projects that are not checked-in,
thus only valid in the late check-in work-flow model.
|
java.util.Set |
getAssets()
Getter for property assets ("Assets")
|
boolean |
getAssetsUpToDate()
Checks for asset conflicts
|
java.util.Set |
getCheckedInAssets()
Getter for property checkedInAssets ("Checked in assets")
|
java.sql.Timestamp |
getCheckinDate()
Getter for property checkinDate ("Checkin date")
|
java.sql.Timestamp |
getCompletionDate()
Getter for property completionDate ("Completion date")
|
java.sql.Timestamp |
getCreationDate()
Getter for property creationDate ("Creation date")
|
RepositoryItem |
getCreator()
Getter for property creator ("Creator")
|
java.util.Map |
getDeploymentApprovalTimes()
Getter for property deploymentApprovalTimes ("Deployment approval times")
|
java.util.Map |
getDeploymentIds()
Getter for property deploymentIds ("Deployment ids")
|
java.util.Map |
getDeploymentSnapshots()
Getter for property deploymentSnapshots ("Deployment target snapshots")
|
java.util.Map |
getDeploymentStatuses()
Getter for property deploymentStatuses ("Deployment target statuses")
|
java.util.Map |
getDeploymentTimes()
Getter for property deploymentTimes ("Deployment times")
|
java.lang.String |
getDescription()
Getter for property description ("Description")
|
java.lang.String |
getDisplayName()
Getter for property displayName ("Name")
|
boolean |
getHasCheckedIn()
Returns true if the value of property checkedIn is null.
|
boolean |
getHasEditable()
Returns true if the value of property editable is null.
|
boolean |
getHasLocked()
Returns true if the value of property locked is null.
|
boolean |
getHasVersion()
Returns true if the value of property version is null.
|
java.util.List |
getHistory()
Getter for property history ("History")
|
java.lang.String |
getId()
Getter for property id ("Project id")
|
ProjectEnumStatus |
getStatus()
Getter for property status ("Status")
|
java.lang.String |
getStatusDetail()
Getter for property statusDetail ("Status detail")
|
int |
getVersion()
Getter for property version ("Version")
|
RepositoryItem |
getWorkflow()
Getter for property workflow ("Workflow")
|
java.lang.String |
getWorkflowId()
Getter for property workflowId ("Workflow id")
|
java.lang.String |
getWorkspace()
Getter for property workspace ("Workspace")
|
boolean |
isAssetsUpToDate()
Checks for asset conflicts
|
boolean |
isCheckedIn()
Getter for property checkedIn ("Checked in")
|
boolean |
isEditable()
Getter for property editable ("Editable")
|
boolean |
isLocked()
Getter for property locked ("Locked")
|
boolean |
isRemoved()
Returns true if the underlying object has been removed.
|
void |
prepareInstanceForWrite()
This must be called if the application intends to both read and write the instance in the same transaction, and it intends to do a read before doing a write.
|
void |
releaseAssetLocks()
If the project has any locked assets and is in a state where
those asset locks are no longer necessary, then this method will
release those asset locks.
|
void |
renounce(java.lang.String pComment)
Flags the project as renounced for all known
deployment targets.
|
void |
renounce(Target pTarget,
java.lang.String pComment)
Flags the project as renounced for the specified
deployment target.
|
void |
reopen()
This method is only valid for Projects that are not checked-in,
thus only valid in the late check-in work-flow model.
|
Workspace |
resolveWorkspace()
A convenience method for resolving the Workspace named in
getWorkspace().
|
void |
revertAsset(VersionManagerURI pAssetURI,
java.lang.String pVersion)
Reverts an asset in the project to the version which was originally checked out.
|
void |
revertDeployment(Target pTarget,
java.lang.String pInitiatorID,
java.util.Calendar pDeployTime)
This method is only valid for Projects that are not checked-in,
thus only valid in the late check-in work-flow model.
|
void |
revertDeployments(java.lang.String pInitiatorID,
java.util.Calendar pDeployTime)
This method is only valid for Projects that are not checked-in,
thus only valid in the late check-in work-flow model.
|
void |
revokeDeploymentApproval(Target pTarget)
Revokes approval of the Project for deployment to the specified
deployment Target.
|
void |
setCheckedIn(boolean value)
Setter for property checkedIn ("Checked in").
|
void |
setCheckinDate(java.sql.Timestamp value)
Setter for property checkinDate ("Checkin date").
|
void |
setCompletionDate(java.sql.Timestamp value)
Setter for property completionDate ("Completion date").
|
void |
setCreationDate(java.sql.Timestamp value)
Setter for property creationDate ("Creation date").
|
void |
setCreator(RepositoryItem value)
Setter for property creator ("Creator").
|
void |
setDeploymentApprovalTimes(java.util.Map value)
Setter for property deploymentApprovalTimes ("Deployment approval times").
|
void |
setDeploymentIds(java.util.Map value)
Setter for property deploymentIds ("Deployment ids").
|
void |
setDeploymentSnapshots(java.util.Map value)
Setter for property deploymentSnapshots ("Deployment target snapshots").
|
void |
setDeploymentStatuses(java.util.Map value)
Setter for property deploymentStatuses ("Deployment target statuses").
|
void |
setDeploymentTimes(java.util.Map value)
Setter for property deploymentTimes ("Deployment times").
|
void |
setDescription(java.lang.String value)
Setter for property description ("Description").
|
void |
setDisplayName(java.lang.String value)
Setter for property displayName ("Name").
|
void |
setEditable(boolean value)
Setter for property editable ("Editable").
|
void |
setHasCheckedIn(boolean value)
If this is set to false, then the underlying value of property checkedIn is set to null.
|
void |
setHasEditable(boolean value)
If this is set to false, then the underlying value of property editable is set to null.
|
void |
setHasLocked(boolean value)
If this is set to false, then the underlying value of property locked is set to null.
|
void |
setHistory(java.util.List value)
Setter for property history ("History").
|
void |
setId(java.lang.String value)
Setter for property id ("Project id").
|
void |
setLocked(boolean value)
Setter for property locked ("Locked").
|
void |
setStatus(ProjectEnumStatus value)
Setter for property status ("Status").
|
void |
setStatusDetail(java.lang.String value)
Setter for property statusDetail ("Status detail").
|
void |
setWorkflowId(java.lang.String value)
Setter for property workflowId ("Workflow id").
|
void |
setWorkspace(java.lang.String value)
Setter for property workspace ("Workspace").
|
void |
updateDeploymentIds(java.lang.String pTargetID,
java.lang.String pDeploymentId)
Updates the deploymentIds Map properties with the given value.
|
void |
updateDeploymentSnapshots(java.lang.String pTargetID,
java.lang.String pSnapshotID)
Updates the deploymentSnapshots Map properties with the given value.
|
void |
updateDeploymentStatuses(java.lang.String pTargetID,
java.lang.Integer pApprovalFlag)
Updates the deploymentStatuses Map property with the given value.
|
void |
updateDeploymentTimes(java.lang.String pTargetID,
java.sql.Timestamp pDeploymentTime)
Updates the deploymentTimes Map properties with the given value.
|
void |
writeInstance()
This must be called after modifying an instance with a persistent implementation to guarantee that all changes are made persistent and visible to queries.
|
java.util.Set getAssets() throws javax.ejb.EJBException
Set
javax.ejb.EJBException
boolean isCheckedIn() throws javax.ejb.EJBException
javax.ejb.EJBException
boolean getHasCheckedIn() throws javax.ejb.EJBException
javax.ejb.EJBException
void setCheckedIn(boolean value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- booleanjavax.ejb.EJBException
void setHasCheckedIn(boolean value) throws javax.ejb.EJBException
javax.ejb.EJBException
java.util.Set getCheckedInAssets() throws javax.ejb.EJBException
Set
javax.ejb.EJBException
java.sql.Timestamp getCheckinDate() throws javax.ejb.EJBException
Timestamp
javax.ejb.EJBException
void setCheckinDate(java.sql.Timestamp value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- Timestamp
javax.ejb.EJBException
java.sql.Timestamp getCompletionDate() throws javax.ejb.EJBException
Timestamp
javax.ejb.EJBException
void setCompletionDate(java.sql.Timestamp value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- Timestamp
javax.ejb.EJBException
java.sql.Timestamp getCreationDate() throws javax.ejb.EJBException
Timestamp
javax.ejb.EJBException
void setCreationDate(java.sql.Timestamp value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- Timestamp
javax.ejb.EJBException
RepositoryItem getCreator() throws javax.ejb.EJBException
RepositoryItem
javax.ejb.EJBException
void setCreator(RepositoryItem value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- RepositoryItem
javax.ejb.EJBException
java.util.Map getDeploymentApprovalTimes() throws javax.ejb.EJBException
Map
javax.ejb.EJBException
void setDeploymentApprovalTimes(java.util.Map value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- Map
javax.ejb.EJBException
java.util.Map getDeploymentIds() throws javax.ejb.EJBException
Map
javax.ejb.EJBException
void setDeploymentIds(java.util.Map value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- Map
javax.ejb.EJBException
java.util.Map getDeploymentSnapshots() throws javax.ejb.EJBException
Map
javax.ejb.EJBException
void setDeploymentSnapshots(java.util.Map value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- Map
javax.ejb.EJBException
java.util.Map getDeploymentStatuses() throws javax.ejb.EJBException
Map
javax.ejb.EJBException
void setDeploymentStatuses(java.util.Map value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- Map
javax.ejb.EJBException
java.util.Map getDeploymentTimes() throws javax.ejb.EJBException
Map
javax.ejb.EJBException
void setDeploymentTimes(java.util.Map value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- Map
javax.ejb.EJBException
java.lang.String getDescription() throws javax.ejb.EJBException
String
javax.ejb.EJBException
void setDescription(java.lang.String value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- String
javax.ejb.EJBException
java.lang.String getDisplayName() throws javax.ejb.EJBException
String
javax.ejb.EJBException
void setDisplayName(java.lang.String value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- String
javax.ejb.EJBException
boolean isEditable() throws javax.ejb.EJBException
javax.ejb.EJBException
boolean getHasEditable() throws javax.ejb.EJBException
javax.ejb.EJBException
void setEditable(boolean value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- booleanjavax.ejb.EJBException
void setHasEditable(boolean value) throws javax.ejb.EJBException
javax.ejb.EJBException
java.util.List getHistory() throws javax.ejb.EJBException
List
of History
javax.ejb.EJBException
void setHistory(java.util.List value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- List
of History
javax.ejb.EJBException
java.lang.String getId() throws javax.ejb.EJBException
String
javax.ejb.EJBException
void setId(java.lang.String value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- String
javax.ejb.EJBException
boolean isLocked() throws javax.ejb.EJBException
javax.ejb.EJBException
boolean getHasLocked() throws javax.ejb.EJBException
javax.ejb.EJBException
void setLocked(boolean value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- booleanjavax.ejb.EJBException
void setHasLocked(boolean value) throws javax.ejb.EJBException
javax.ejb.EJBException
ProjectEnumStatus getStatus() throws javax.ejb.EJBException
ProjectEnumStatus
javax.ejb.EJBException
void setStatus(ProjectEnumStatus value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- ProjectEnumStatus
javax.ejb.EJBException
java.lang.String getStatusDetail() throws javax.ejb.EJBException
String
javax.ejb.EJBException
void setStatusDetail(java.lang.String value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- String
javax.ejb.EJBException
int getVersion() throws javax.ejb.EJBException
javax.ejb.EJBException
boolean getHasVersion() throws javax.ejb.EJBException
javax.ejb.EJBException
RepositoryItem getWorkflow() throws javax.ejb.EJBException
RepositoryItem
javax.ejb.EJBException
java.lang.String getWorkflowId() throws javax.ejb.EJBException
String
javax.ejb.EJBException
void setWorkflowId(java.lang.String value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- String
javax.ejb.EJBException
java.lang.String getWorkspace() throws javax.ejb.EJBException
String
javax.ejb.EJBException
void setWorkspace(java.lang.String value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- String
javax.ejb.EJBException
boolean isRemoved() throws javax.ejb.EJBException
javax.ejb.EJBException
void copyTo(Project destination) throws javax.ejb.EJBException
javax.ejb.EJBException
void writeInstance() throws javax.ejb.EJBException
javax.ejb.EJBException
void prepareInstanceForWrite() throws javax.ejb.EJBException
javax.ejb.EJBException
boolean _isMutable()
void checkin(java.lang.String pUsername, java.lang.String pComment) throws LockManagerException, VersionException, atg.workflow.process.action.VersionConflictException, TransactionDemarcationException, PublishingException, atg.epub.project.AssetLockException, javax.ejb.EJBException
pUsername
- A username to use for logging the checkinpComment
- An optional checkin commentLockManagerException
- If a lock could not be acquired from the lock managerVersionException
- If an error occurs in the version manageratg.workflow.process.action.VersionConflictException
- If there is an asset conflict in any of the assets being checked inTransactionDemarcationException
- If a transaction error occursPublishingException
- If there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not beatg.epub.project.AssetLockException
- If assets were already locked by another Projectjavax.ejb.EJBException
- A system-level error occurredboolean isAssetsUpToDate() throws VersionException, javax.ejb.EJBException
VersionException
- If there is an error in the version managerjavax.ejb.EJBException
- A system-level error occurredboolean getAssetsUpToDate() throws VersionException, javax.ejb.EJBException
VersionException
- If there is an error in the version managerjavax.ejb.EJBException
- A system-level error occurredvoid complete(boolean pFireCompleteMessage) throws TransactionDemarcationException, WorkflowException, javax.ejb.FinderException, javax.jms.JMSException, javax.ejb.EJBException
pFireCompleteMessage
- true to fire the completed message, false to notTransactionDemarcationException
- If a transaction error occursWorkflowException
- If a workflow error occurs while completingjavax.ejb.FinderException
- If the associated process cannot be foundjavax.jms.JMSException
- If the project complete message cannot be sentjavax.ejb.EJBException
- A system-level error occurredvoid complete() throws TransactionDemarcationException, WorkflowException, javax.ejb.FinderException, javax.jms.JMSException, javax.ejb.EJBException
TransactionDemarcationException
- If a transaction error occursWorkflowException
- If a workflow error occurs while completingjavax.ejb.FinderException
- If the associated process cannot be foundjavax.jms.JMSException
- If the project complete message cannot be sentjavax.ejb.EJBException
- A system-level error occurredvoid abandon() throws TransactionDemarcationException, WorkflowException, javax.ejb.FinderException, javax.jms.JMSException, javax.ejb.EJBException
TransactionDemarcationException
- If a transaction error occursWorkflowException
- If a workflow error occurs while completingjavax.ejb.FinderException
- If the associated process cannot be foundjavax.jms.JMSException
- If the project complete message cannot be sentjavax.ejb.EJBException
- A system-level error occurredvoid cloneAssets(Project pSourceProject) throws RepositoryException, InvalidAssetException, VersionException, TransactionDemarcationException, LockManagerException, PublishingException, javax.ejb.EJBException
pSourceProject
- The source project which contains the assets that should be checked out in this projectRepositoryException
- If a repository exception occursInvalidAssetException
- If any of the asset URIs generated from the source project cannot be resolvedVersionException
- If a version manager error occursTransactionDemarcationException
- If a transaction error occursLockManagerException
- If an asset lock cannot be acquiredPublishingException
- If an error occurs in publishingjavax.ejb.EJBException
- A system-level error occurredHistory addHistory(java.lang.String pAction, java.lang.String pActionType, java.lang.String pDescription, java.util.Collection pParams) throws javax.ejb.CreateException, TransactionDemarcationException, javax.ejb.EJBException
pAction
- The action which is referenced for this elementpActionType
- The type of actionpDescription
- The description/note for this elementpParams
- Parameter for the history message eg. if revoking a projects from a target this could be the target IDjavax.ejb.CreateException
- If the history element cannot be createdTransactionDemarcationException
- If a transaction error occursjavax.ejb.EJBException
- A system-level error occurredvoid delete(java.lang.String pInitiatorID) throws javax.ejb.RemoveException, VersionException, atg.deployment.common.DeploymentException, PublishingException, TransactionDemarcationException, javax.jms.JMSException, javax.ejb.EJBException
pInitiatorID
- Some identifier (typically Profile login) of who is issuing this calljavax.ejb.RemoveException
- If the project cannot be deleted from the repositoryVersionException
- thrown if the VersionManager encounters errors with the associated workspaceatg.deployment.common.DeploymentException
- if there are errors confirming there are no pending deployments for the projectPublishingException
- if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not beTransactionDemarcationException
javax.jms.JMSException
javax.ejb.EJBException
- A system-level error occurredvoid delete(int pMessageStatus, java.lang.String pInitiatorID) throws javax.ejb.RemoveException, VersionException, atg.deployment.common.DeploymentException, PublishingException, TransactionDemarcationException, javax.jms.JMSException, javax.ejb.EJBException
pMessageStatus
- The status to set into the delete project messagepInitiatorID
- Some identifier (typically Profile login) of who is issuing this calljavax.ejb.RemoveException
- If the project cannot be deleted from the repositoryVersionException
- thrown if the VersionManager encounters errors with the associated workspaceatg.deployment.common.DeploymentException
- if there are errors confirming there are no pending deployments for the projectPublishingException
- if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not beTransactionDemarcationException
javax.jms.JMSException
javax.ejb.EJBException
- A system-level error occurredvoid addAsset(java.lang.String[] pAssetURIs) throws InvalidAssetException, RepositoryException, VersionException, TransactionDemarcationException, LockManagerException, PublishingException, javax.ejb.EJBException
pAssetURIs
- An array of asset URIs to add to the projectInvalidAssetException
- If a URI specifies an invalid assetRepositoryException
- If a repository error occursVersionException
- If a version manager error occursTransactionDemarcationException
- If a transaction error occursLockManagerException
- If an asset lock cannot be acquiredPublishingException
- If an error occurs in publishingjavax.ejb.EJBException
- A system-level error occurredboolean assetInProject(VersionManagerURI pAssetURI) throws InvalidAssetException, javax.ejb.EJBException
pAssetURI
- The URI of the asset to check if it is in this projectInvalidAssetException
- If the URI specifies an invalid assetjavax.ejb.EJBException
- A system-level error occurredvoid revertAsset(VersionManagerURI pAssetURI, java.lang.String pVersion) throws InvalidAssetException, VersionException, TransactionDemarcationException, RepositoryException, javax.ejb.EJBException
pAssetURI
- The URI of the asset to revertpVersion
- The version to revert to or null for latest versionInvalidAssetException
- If the supplied asset URI is invalid and cannot be resolvedVersionException
- If a version manager error occursTransactionDemarcationException
- If a transaction error occursRepositoryException
- If a repository error occursjavax.ejb.EJBException
- A system-level error occurredvoid discardAsset(java.lang.String[] pAssetURIs) throws InvalidAssetException, PublishingException, VersionException, TransactionDemarcationException, javax.ejb.EJBException
pAssetURIs
- An array of asset URIs to be discardedInvalidAssetException
- If the supplied asset URI is invalid and cannot be resolvedPublishingException
- If an asset cannot be discarded for some reason.VersionException
- If a version manager error occursTransactionDemarcationException
- If a transaction error occursjavax.ejb.EJBException
- A system-level error occurredvoid updateDeploymentStatuses(java.lang.String pTargetID, java.lang.Integer pApprovalFlag) throws javax.ejb.EJBException
pTargetID
- Target.getID() for the target to set a value forpApprovalFlag
- the value deployment status to set for the given targetjavax.ejb.EJBException
- A system-level error occurredvoid updateDeploymentSnapshots(java.lang.String pTargetID, java.lang.String pSnapshotID) throws javax.ejb.EJBException
pTargetID
- Target.getID() for the target to set a value forpSnapshotID
- the value Snapshot ID to set for the given targetjavax.ejb.EJBException
- A system-level error occurredvoid updateDeploymentTimes(java.lang.String pTargetID, java.sql.Timestamp pDeploymentTime) throws javax.ejb.EJBException
pTargetID
- Target.getID() for the target to set a value forpDeploymentTime
- when this project should be considered to be deployed.javax.ejb.EJBException
- A system-level error occurredvoid updateDeploymentIds(java.lang.String pTargetID, java.lang.String pDeploymentId) throws javax.ejb.EJBException
pTargetID
- Target.getID() for the target to set a value forpDeploymentId
- the deployment id.javax.ejb.EJBException
- A system-level error occurredWorkspace resolveWorkspace() throws PublishingException, VersionException, javax.ejb.EJBException
PublishingException
- if there is no associated workspace or the workspace could not be foundVersionException
- if the VersionManager encounters errors with the associated workspacejavax.ejb.EJBException
- A system-level error occurredvoid approveDeployment(Target pTarget) throws PublishingException, VersionException, atg.epub.project.AssetLockException, javax.ejb.EJBException
pTarget
- the deployment target to approve deployment of the Project toPublishingException
- if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not beVersionException
- when there are technical errors locking assets for the late-checkin modelatg.epub.project.AssetLockException
- if assets were already locked by another Projectjavax.ejb.EJBException
- A system-level error occurredvoid approveDeployment() throws PublishingException, VersionException, atg.epub.project.AssetLockException, javax.ejb.EJBException
PublishingException
- if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not beVersionException
- when there are technical errors locking assets for the late-checkin modelatg.epub.project.AssetLockException
- if assets were already locked by another Projectjavax.ejb.EJBException
- A system-level error occurredvoid renounce(Target pTarget, java.lang.String pComment) throws PublishingException, javax.ejb.EJBException, javax.jms.JMSException
pTarget
- the deployment target to approve deployment of the Project topComment
- An optional commentPublishingException
- if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not bejavax.ejb.EJBException
- when there are technical errors.javax.jms.JMSException
- when there are error sending JMS message about this operationvoid renounce(java.lang.String pComment) throws PublishingException, javax.ejb.EJBException, javax.jms.JMSException
pComment
- An optional checkin commentPublishingException
- if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not bejavax.ejb.EJBException
- when there are technical errors.javax.jms.JMSException
- when there are error sending JMS message about this operationvoid acquireAssetLocks() throws PublishingException, VersionException, atg.epub.project.AssetLockException, javax.ejb.EJBException
PublishingException
- if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not beVersionException
- when there are technical errors locking assets for the late-checkin modelatg.epub.project.AssetLockException
- if assets were already locked by another Projectjavax.ejb.EJBException
- A system-level error occurredvoid releaseAssetLocks() throws PublishingException, VersionException, javax.ejb.EJBException
PublishingException
- if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not beVersionException
- when there are technical errors unlocking assets for the late-checkin modeljavax.ejb.EJBException
- A system-level error occurredvoid revokeDeploymentApproval(Target pTarget) throws PublishingException, javax.jms.JMSException, TransactionDemarcationException, javax.ejb.EJBException
pTarget
- the Target to revoke deployment approval forPublishingException
- if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not bejavax.jms.JMSException
- if there were errors advancing any work-flows waiting an approved deploymentTransactionDemarcationException
- if there are system level transaction errorsjavax.ejb.EJBException
- A system-level error occurredvoid reopen() throws PublishingException, VersionException, javax.ejb.EJBException
PublishingException
- if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not beVersionException
- if the VersionManager encounters errors with the associated workspacejavax.ejb.EJBException
- A system-level error occurredvoid revertDeployment(Target pTarget, java.lang.String pInitiatorID, java.util.Calendar pDeployTime) throws PublishingException, VersionException, atg.deployment.common.DeploymentException, javax.ejb.EJBException
pTarget
- the deployment target to revert this Project frompInitiatorID
- some identifier (typically Profile login) of who is issuing this callpDeployTime
- a specific time to run the deployment, or NULL if run as soon as possiblePublishingException
- if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not beVersionException
- if there are errors performing the revert properatg.deployment.common.DeploymentException
- if there are errors confirming there are no pending deployments for the projectjavax.ejb.EJBException
- A system-level error occurredvoid revertDeployments(java.lang.String pInitiatorID, java.util.Calendar pDeployTime) throws PublishingException, VersionException, atg.deployment.common.DeploymentException, javax.ejb.EJBException
pInitiatorID
- some identifier (typically Profile login) of who is issuing this callpDeployTime
- a specific time to run the deployment, or NULL if run as soon as possiblePublishingException
- if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not beVersionException
- if there are errors performing the revert properatg.deployment.common.DeploymentException
- if there are errors confirming there are no pending deployments for the projectjavax.ejb.EJBException
- A system-level error occurredjava.util.Collection findCrossProjectDeleteDependencies(java.util.Collection pCandidateProjects) throws VersionException, TransactionDemarcationException, javax.ejb.EJBException
pCandidateProjects
- A collection of candidate projects to check against.VersionException
- if there are errors performing the revert properTransactionDemarcationException
- If a transaction error occursjavax.ejb.EJBException
- A system-level error occurred