atg.epub.project

Interface Project

All Superinterfaces:

javax.ejb.EJBLocalObject

public interface Project
extends javax.ejb.EJBLocalObject

Class Project

• Home: ProjectHome
• Flags: expert
• Attributes:

  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 Summaries

Property Name	Property Type	Property Description	Flags
assets	Set	Assets	R, Cch, CoM, Hdn
checkedIn	boolean	Checked in	R, W, Cch, Qry
checkedInAssets	Set	Checked in assets	R, Cch, CoM, Hdn
checkinDate	Timestamp	Checkin date	R, W, Cch, Qry
completionDate	Timestamp	Completion date	R, W, Cch, Qry
creationDate	Timestamp	Creation date	R, W, Cch, Qry
creator	RepositoryItem	Creator	R, W, Cch, Qry
deploymentApprovalTimes	Map	Deployment approval times	R, W, Cch, CoM, Mv, Qry, Exp
deploymentIds	Map	Deployment ids	R, W, Cch, CoM, Mv, Qry, Exp
deploymentSnapshots	Map	Deployment target snapshots	R, W, Cch, CoM, Mv, Qry, Exp
deploymentStatuses	Map	Deployment target statuses	R, W, Cch, CoM, Mv, Qry, Exp
deploymentTimes	Map	Deployment times	R, W, Cch, CoM, Mv, Qry, Exp
description	String	Description	R, W, Cch, Qry
displayName	String	Name	R, W, Cch, Qry
editable	boolean	Editable	R, W, Cch, Qry
history	List of History	History	R, W, CsD, CsU, Cch, CoM, Mv, Qry
id	String	Project id	R, W, Cch, Id, Qry, Exp
locked	boolean	Locked	R, W, Cch, Qry
status	ProjectEnumStatus	Status	R, W, Cch, Qry
statusDetail	String	Status detail	R, W, Cch, Qry
version	int	Version	R, Cch, Qry, Exp
workflow	RepositoryItem	Workflow	R, Cch
workflowId	String	Workflow id	R, W, Cch, Qry
workspace	String	Workspace	R, W, Cch, Qry, Req

Flags Key:R=readable, W=writable, CsD=cascadeDelete, CsI=cascadeInsert, CsU=cascadeUpdate, Cch=cacheable, CoM=collectionOrMap, Drv=derived, Id=idProperty, Mv=multivalued, Qry=queryable, Req=required, Exp=expert, Hdn=hidden, Prf=preferred

Property Details

Property assets ("Assets"): Set

• Getter: getAssets()
• Flags: readable, cacheable, collectionOrMap, hidden
• Type Name: assets
• Sort String: assets
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property checkedIn ("Checked in"): boolean

• Getter: isCheckedIn()
• Setter: setCheckedIn(boolean)
• Flags: readable, writable, cacheable, queryable
• Default Value: false
• Type Name: boolean
• Sort String: checkedin ("checked in")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property checkedInAssets ("Checked in assets"): Set

• Getter: getCheckedInAssets()
• Flags: readable, cacheable, collectionOrMap, hidden
• Type Name: checkedInAssets
• Sort String: checkedinassets ("checked in assets")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property checkinDate ("Checkin date"): Timestamp

• Getter: getCheckinDate()
• Setter: setCheckinDate(java.sql.Timestamp)
• Flags: readable, writable, cacheable, queryable
• Type Name: timestamp
• Sort String: checkindate ("checkin date")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property completionDate ("Completion date"): Timestamp

• Getter: getCompletionDate()
• Setter: setCompletionDate(java.sql.Timestamp)
• Flags: readable, writable, cacheable, queryable
• Type Name: timestamp
• Sort String: completiondate ("completion date")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property creationDate ("Creation date"): Timestamp

• Getter: getCreationDate()
• Setter: setCreationDate(java.sql.Timestamp)
• Flags: readable, writable, cacheable, queryable
• Type Name: timestamp
• Sort String: creationdate ("creation date")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property creator ("Creator"): RepositoryItem

• Getter: getCreator()
• Setter: setCreator(atg.repository.RepositoryItem)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: creator
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property deploymentApprovalTimes ("Deployment approval times"): Map

• Getter: getDeploymentApprovalTimes()
• Setter: setDeploymentApprovalTimes(java.util.Map)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable, expert
• Default Value: {}
• Type Name: map
• Sort String: deploymentapprovaltimes ("deployment approval times")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property deploymentIds ("Deployment ids"): Map

• Getter: getDeploymentIds()
• Setter: setDeploymentIds(java.util.Map)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable, expert
• Default Value: {}
• Type Name: map
• Sort String: deploymentids ("deployment ids")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property deploymentSnapshots ("Deployment target snapshots"): Map

• Getter: getDeploymentSnapshots()
• Setter: setDeploymentSnapshots(java.util.Map)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable, expert
• Default Value: {}
• Type Name: map
• Sort String: deploymentsnapshots ("deployment target snapshots")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property deploymentStatuses ("Deployment target statuses"): Map

• Getter: getDeploymentStatuses()
• Setter: setDeploymentStatuses(java.util.Map)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable, expert
• Default Value: {}
• Type Name: map
• Sort String: deploymentstatuses ("deployment target statuses")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property deploymentTimes ("Deployment times"): Map

• Getter: getDeploymentTimes()
• Setter: setDeploymentTimes(java.util.Map)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable, expert
• Default Value: {}
• Type Name: map
• Sort String: deploymenttimes ("deployment times")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property description ("Description"): String

• Getter: getDescription()
• Setter: setDescription(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: description
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property displayName ("Name"): String

• Getter: getDisplayName()
• Setter: setDisplayName(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: displayname ("name")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property editable ("Editable"): boolean

• Getter: isEditable()
• Setter: setEditable(boolean)
• Flags: readable, writable, cacheable, queryable
• Default Value: true
• Type Name: boolean
• Sort String: editable
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property history ("History"): List of History

• Getter: getHistory()
• Setter: setHistory(java.util.List)
• Flags: readable, writable, cascadeDelete, cascadeUpdate, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: list
• Sort String: history
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property id ("Project id"): String

• Getter: getId()
• Setter: setId(java.lang.String)
• Flags: readable, writable, cacheable, idProperty, queryable, expert
• Type Name: string
• Sort String: id ("project id")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property locked ("Locked"): boolean

• Getter: isLocked()
• Setter: setLocked(boolean)
• Flags: readable, writable, cacheable, queryable
• Default Value: false
• Type Name: boolean
• Sort String: locked
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property status ("Status"): ProjectEnumStatus

• Getter: getStatus()
• Setter: setStatus(atg.epub.project.ProjectEnumStatus)
• Flags: readable, writable, cacheable, queryable
• Type Name: enumerated
• Sort String: status
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property statusDetail ("Status detail"): String

• Getter: getStatusDetail()
• Setter: setStatusDetail(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: statusdetail ("status detail")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property version ("Version"): int

• Getter: getVersion()
• Flags: readable, cacheable, queryable, expert
• Type Name: int
• Sort String: version
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property workflow ("Workflow"): RepositoryItem

• Getter: getWorkflow()
• Flags: readable, cacheable
• Type Name: workflow
• Sort String: workflow
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property workflowId ("Workflow id"): String

• Getter: getWorkflowId()
• Setter: setWorkflowId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: workflowid ("workflow id")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property workspace ("Workspace"): String

• Getter: getWorkspace()
• Setter: setWorkspace(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: workspace
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Method Summary

Methods

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.

Methods inherited from interface javax.ejb.EJBLocalObject

getEJBLocalHome, getPrimaryKey, isIdentical, remove

Method Detail

getAssets

java.util.Set getAssets()
                        throws javax.ejb.EJBException

Getter for property assets ("Assets")

Returns:

Set

Throws:

javax.ejb.EJBException

isCheckedIn

boolean isCheckedIn()
                    throws javax.ejb.EJBException

Getter for property checkedIn ("Checked in")

Returns:

boolean

Throws:

javax.ejb.EJBException

getHasCheckedIn

boolean getHasCheckedIn()
                        throws javax.ejb.EJBException

Returns true if the value of property checkedIn is null.

Throws:

javax.ejb.EJBException

setCheckedIn

void setCheckedIn(boolean value)
                  throws javax.ejb.EJBException

Setter for property checkedIn ("Checked in"). The 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.

Parameters:

value - boolean

Throws:

javax.ejb.EJBException

setHasCheckedIn

void setHasCheckedIn(boolean value)
                     throws javax.ejb.EJBException

If this is set to false, then the underlying value of property checkedIn is set to null. If set to true, then nothing is done.

Throws:

javax.ejb.EJBException

getCheckedInAssets

java.util.Set getCheckedInAssets()
                                 throws javax.ejb.EJBException

Getter for property checkedInAssets ("Checked in assets")

Returns:

Set

Throws:

javax.ejb.EJBException

getCheckinDate

java.sql.Timestamp getCheckinDate()
                                  throws javax.ejb.EJBException

Getter for property checkinDate ("Checkin date")

Returns:

Timestamp

Throws:

javax.ejb.EJBException

setCheckinDate

void setCheckinDate(java.sql.Timestamp value)
                    throws javax.ejb.EJBException

Setter for property checkinDate ("Checkin date"). The 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.

Parameters:

value - Timestamp

Throws:

javax.ejb.EJBException

getCompletionDate

java.sql.Timestamp getCompletionDate()
                                     throws javax.ejb.EJBException

Getter for property completionDate ("Completion date")

Returns:

Timestamp

Throws:

javax.ejb.EJBException

setCompletionDate

void setCompletionDate(java.sql.Timestamp value)
                       throws javax.ejb.EJBException

Setter for property completionDate ("Completion date"). The 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.

Parameters:

value - Timestamp

Throws:

javax.ejb.EJBException

getCreationDate

java.sql.Timestamp getCreationDate()
                                   throws javax.ejb.EJBException

Getter for property creationDate ("Creation date")

Returns:

Timestamp

Throws:

javax.ejb.EJBException

setCreationDate

void setCreationDate(java.sql.Timestamp value)
                     throws javax.ejb.EJBException

Setter for property creationDate ("Creation date"). The 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.

Parameters:

value - Timestamp

Throws:

javax.ejb.EJBException

getCreator

RepositoryItem getCreator()
                          throws javax.ejb.EJBException

Getter for property creator ("Creator")

Returns:

RepositoryItem

Throws:

javax.ejb.EJBException

setCreator

void setCreator(RepositoryItem value)
                throws javax.ejb.EJBException

Setter for property creator ("Creator"). The 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.

Parameters:

value - RepositoryItem

Throws:

javax.ejb.EJBException

getDeploymentApprovalTimes

java.util.Map getDeploymentApprovalTimes()
                                         throws javax.ejb.EJBException

Getter for property deploymentApprovalTimes ("Deployment approval times")

Returns:

Map

Throws:

javax.ejb.EJBException

setDeploymentApprovalTimes

void setDeploymentApprovalTimes(java.util.Map value)
                                throws javax.ejb.EJBException

Setter for property deploymentApprovalTimes ("Deployment approval times"). The 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.

Parameters:

value - Map

Throws:

javax.ejb.EJBException

getDeploymentIds

java.util.Map getDeploymentIds()
                               throws javax.ejb.EJBException

Getter for property deploymentIds ("Deployment ids")

Returns:

Map

Throws:

javax.ejb.EJBException

setDeploymentIds

void setDeploymentIds(java.util.Map value)
                      throws javax.ejb.EJBException

Setter for property deploymentIds ("Deployment ids"). The 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.

Parameters:

value - Map

Throws:

javax.ejb.EJBException

getDeploymentSnapshots

java.util.Map getDeploymentSnapshots()
                                     throws javax.ejb.EJBException

Getter for property deploymentSnapshots ("Deployment target snapshots")

Returns:

Map

Throws:

javax.ejb.EJBException

setDeploymentSnapshots

void setDeploymentSnapshots(java.util.Map value)
                            throws javax.ejb.EJBException

Setter for property deploymentSnapshots ("Deployment target snapshots"). The 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.

Parameters:

value - Map

Throws:

javax.ejb.EJBException

getDeploymentStatuses

java.util.Map getDeploymentStatuses()
                                    throws javax.ejb.EJBException

Getter for property deploymentStatuses ("Deployment target statuses")

Returns:

Map

Throws:

javax.ejb.EJBException

setDeploymentStatuses

void setDeploymentStatuses(java.util.Map value)
                           throws javax.ejb.EJBException

Setter for property deploymentStatuses ("Deployment target statuses"). The 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.

Parameters:

value - Map

Throws:

javax.ejb.EJBException

getDeploymentTimes

java.util.Map getDeploymentTimes()
                                 throws javax.ejb.EJBException

Getter for property deploymentTimes ("Deployment times")

Returns:

Map

Throws:

javax.ejb.EJBException

setDeploymentTimes

void setDeploymentTimes(java.util.Map value)
                        throws javax.ejb.EJBException

Setter for property deploymentTimes ("Deployment times"). The 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.

Parameters:

value - Map

Throws:

javax.ejb.EJBException

getDescription

java.lang.String getDescription()
                                throws javax.ejb.EJBException

Getter for property description ("Description")

Returns:

String

Throws:

javax.ejb.EJBException

setDescription

void setDescription(java.lang.String value)
                    throws javax.ejb.EJBException

Setter for property description ("Description"). The 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.

Parameters:

value - String

Throws:

javax.ejb.EJBException

getDisplayName

java.lang.String getDisplayName()
                                throws javax.ejb.EJBException

Getter for property displayName ("Name")

Returns:

String

Throws:

javax.ejb.EJBException

setDisplayName

void setDisplayName(java.lang.String value)
                    throws javax.ejb.EJBException

Setter for property displayName ("Name"). The 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.

Parameters:

value - String

Throws:

javax.ejb.EJBException

isEditable

boolean isEditable()
                   throws javax.ejb.EJBException

Getter for property editable ("Editable")

Returns:

boolean

Throws:

javax.ejb.EJBException

getHasEditable

boolean getHasEditable()
                       throws javax.ejb.EJBException

Returns true if the value of property editable is null.

Throws:

javax.ejb.EJBException

setEditable

void setEditable(boolean value)
                 throws javax.ejb.EJBException

Setter for property editable ("Editable"). The 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.

Parameters:

value - boolean

Throws:

javax.ejb.EJBException

setHasEditable

void setHasEditable(boolean value)
                    throws javax.ejb.EJBException

If this is set to false, then the underlying value of property editable is set to null. If set to true, then nothing is done.

Throws:

javax.ejb.EJBException

getHistory

java.util.List getHistory()
                          throws javax.ejb.EJBException

Getter for property history ("History")

Returns:

List of History

Throws:

javax.ejb.EJBException

setHistory

void setHistory(java.util.List value)
                throws javax.ejb.EJBException

Setter for property history ("History"). The 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.

Parameters:

value - List of History

Throws:

javax.ejb.EJBException

getId

java.lang.String getId()
                       throws javax.ejb.EJBException

Getter for property id ("Project id")

Returns:

String

Throws:

javax.ejb.EJBException

setId

void setId(java.lang.String value)
           throws javax.ejb.EJBException

Setter for property id ("Project id"). The 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.

Parameters:

value - String

Throws:

javax.ejb.EJBException

isLocked

boolean isLocked()
                 throws javax.ejb.EJBException

Getter for property locked ("Locked")

Returns:

boolean

Throws:

javax.ejb.EJBException

getHasLocked

boolean getHasLocked()
                     throws javax.ejb.EJBException

Returns true if the value of property locked is null.

Throws:

javax.ejb.EJBException

setLocked

void setLocked(boolean value)
               throws javax.ejb.EJBException

Setter for property locked ("Locked"). The 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.

Parameters:

value - boolean

Throws:

javax.ejb.EJBException

setHasLocked

void setHasLocked(boolean value)
                  throws javax.ejb.EJBException

If this is set to false, then the underlying value of property locked is set to null. If set to true, then nothing is done.

Throws:

javax.ejb.EJBException

getStatus

ProjectEnumStatus getStatus()
                            throws javax.ejb.EJBException

Getter for property status ("Status")

Returns:

ProjectEnumStatus

Throws:

javax.ejb.EJBException

setStatus

void setStatus(ProjectEnumStatus value)
               throws javax.ejb.EJBException

Setter for property status ("Status"). The 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.

Parameters:

value - ProjectEnumStatus

Throws:

javax.ejb.EJBException

getStatusDetail

java.lang.String getStatusDetail()
                                 throws javax.ejb.EJBException

Getter for property statusDetail ("Status detail")

Returns:

String

Throws:

javax.ejb.EJBException

setStatusDetail

void setStatusDetail(java.lang.String value)
                     throws javax.ejb.EJBException

Setter for property statusDetail ("Status detail"). The 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.

Parameters:

value - String

Throws:

javax.ejb.EJBException

getVersion

int getVersion()
               throws javax.ejb.EJBException

Getter for property version ("Version")

Returns:

int

Throws:

javax.ejb.EJBException

getHasVersion

boolean getHasVersion()
                      throws javax.ejb.EJBException

Returns true if the value of property version is null.

Throws:

javax.ejb.EJBException

getWorkflow

RepositoryItem getWorkflow()
                           throws javax.ejb.EJBException

Getter for property workflow ("Workflow")

Returns:

RepositoryItem

Throws:

javax.ejb.EJBException

getWorkflowId

java.lang.String getWorkflowId()
                               throws javax.ejb.EJBException

Getter for property workflowId ("Workflow id")

Returns:

String

Throws:

javax.ejb.EJBException

setWorkflowId

void setWorkflowId(java.lang.String value)
                   throws javax.ejb.EJBException

Setter for property workflowId ("Workflow id"). The 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.

Parameters:

value - String

Throws:

javax.ejb.EJBException

getWorkspace

java.lang.String getWorkspace()
                              throws javax.ejb.EJBException

Getter for property workspace ("Workspace")

Returns:

String

Throws:

javax.ejb.EJBException

setWorkspace

void setWorkspace(java.lang.String value)
                  throws javax.ejb.EJBException

Setter for property workspace ("Workspace"). The 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.

Parameters:

value - String

Throws:

javax.ejb.EJBException

isRemoved

boolean isRemoved()
                  throws javax.ejb.EJBException

Returns true if the underlying object has been removed. False otherwise.

Throws:

javax.ejb.EJBException

copyTo

void copyTo(Project destination)
            throws javax.ejb.EJBException

Copies the property values of this instance to another instance of the same data type. Only properties that are both readable and writable are copied. Each property is copied by calling the getter method on the source instance and setting the result in the destination instance using the setter method.

Throws:

javax.ejb.EJBException

writeInstance

void writeInstance()
                   throws javax.ejb.EJBException

This must be called after modifying an instance with a persistent implementation to guarantee that all changes are made persistent and visible to queries. Changes might be made visible before calling this method, but this is not guaranteed until this method is called.

Throws:

javax.ejb.EJBException

prepareInstanceForWrite

void prepareInstanceForWrite()
                             throws javax.ejb.EJBException

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. This must be called before that first read.

Throws:

javax.ejb.EJBException

_isMutable

boolean _isMutable()

Returns true if the item is mutable. Items are only mutable after a setter method or prepareInstanceForWrite is called.

checkin

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

Checks in the assets in the workspace associated with this project

Parameters:

pUsername - A username to use for logging the checkin

pComment - An optional checkin comment

Throws:

LockManagerException - If a lock could not be acquired from the lock manager

VersionException - If an error occurs in the version manager

atg.workflow.process.action.VersionConflictException - If there is an asset conflict in any of the assets being checked in

TransactionDemarcationException - If a transaction error occurs

PublishingException - If there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not be

atg.epub.project.AssetLockException - If assets were already locked by another Project

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

isAssetsUpToDate

boolean isAssetsUpToDate()
                         throws VersionException,
                                javax.ejb.EJBException

Checks for asset conflicts

Returns:

Returns true if all the assets in the project are up to date and will not have version conflicts, false otherwise

Throws:

VersionException - If there is an error in the version manager

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

getAssetsUpToDate

boolean getAssetsUpToDate()
                          throws VersionException,
                                 javax.ejb.EJBException

Checks for asset conflicts

Returns:

Returns true if all the assets in the project are up to date and will not have version conflicts, false otherwise

Throws:

VersionException - If there is an error in the version manager

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

complete

void complete(boolean pFireCompleteMessage)
              throws TransactionDemarcationException,
                     WorkflowException,
                     javax.ejb.FinderException,
                     javax.jms.JMSException,
                     javax.ejb.EJBException

This method will complete a project by setting its completionDate, editable flag to false, and status flag to completed

Parameters:

pFireCompleteMessage - true to fire the completed message, false to not

Throws:

TransactionDemarcationException - If a transaction error occurs

WorkflowException - If a workflow error occurs while completing

javax.ejb.FinderException - If the associated process cannot be found

javax.jms.JMSException - If the project complete message cannot be sent

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

complete

void complete()
              throws TransactionDemarcationException,
                     WorkflowException,
                     javax.ejb.FinderException,
                     javax.jms.JMSException,
                     javax.ejb.EJBException

This method will complete a project by setting its completionDate, editable flag to false, and status flag to completed

Throws:

TransactionDemarcationException - If a transaction error occurs

WorkflowException - If a workflow error occurs while completing

javax.ejb.FinderException - If the associated process cannot be found

javax.jms.JMSException - If the project complete message cannot be sent

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

abandon

void abandon()
             throws TransactionDemarcationException,
                    WorkflowException,
                    javax.ejb.FinderException,
                    javax.jms.JMSException,
                    javax.ejb.EJBException

This method will abandon the project so it can never be deployed

Throws:

TransactionDemarcationException - If a transaction error occurs

WorkflowException - If a workflow error occurs while completing

javax.ejb.FinderException - If the associated process cannot be found

javax.jms.JMSException - If the project complete message cannot be sent

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

cloneAssets

void cloneAssets(Project pSourceProject)
                 throws RepositoryException,
                        InvalidAssetException,
                        VersionException,
                        TransactionDemarcationException,
                        LockManagerException,
                        PublishingException,
                        javax.ejb.EJBException

Checks out all the assets that are in the source project, into this project

Parameters:

pSourceProject - The source project which contains the assets that should be checked out in this project

Throws:

RepositoryException - If a repository exception occurs

InvalidAssetException - If any of the asset URIs generated from the source project cannot be resolved

VersionException - If a version manager error occurs

TransactionDemarcationException - If a transaction error occurs

LockManagerException - If an asset lock cannot be acquired

PublishingException - If an error occurs in publishing

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

addHistory

History 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

Adds a history element/note to this project

Parameters:

pAction - The action which is referenced for this element

pActionType - The type of action

pDescription - The description/note for this element

pParams - Parameter for the history message eg. if revoking a projects from a target this could be the target ID

Returns:

The created history element

Throws:

javax.ejb.CreateException - If the history element cannot be created

TransactionDemarcationException - If a transaction error occurs

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

delete

void delete(java.lang.String pInitiatorID)
            throws javax.ejb.RemoveException,
                   VersionException,
                   atg.deployment.common.DeploymentException,
                   PublishingException,
                   TransactionDemarcationException,
                   javax.jms.JMSException,
                   javax.ejb.EJBException

This method will delete a project, its associated workflow, and associated workspace.

Parameters:

pInitiatorID - Some identifier (typically Profile login) of who is issuing this call

Throws:

javax.ejb.RemoveException - If the project cannot be deleted from the repository

VersionException - thrown if the VersionManager encounters errors with the associated workspace

atg.deployment.common.DeploymentException - if there are errors confirming there are no pending deployments for the project

PublishingException - if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not be

TransactionDemarcationException

javax.jms.JMSException

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

delete

void delete(int pMessageStatus,
          java.lang.String pInitiatorID)
            throws javax.ejb.RemoveException,
                   VersionException,
                   atg.deployment.common.DeploymentException,
                   PublishingException,
                   TransactionDemarcationException,
                   javax.jms.JMSException,
                   javax.ejb.EJBException

This method will delete a project, its associated workflow, and associated workspace.

Parameters:

pMessageStatus - The status to set into the delete project message

pInitiatorID - Some identifier (typically Profile login) of who is issuing this call

Throws:

javax.ejb.RemoveException - If the project cannot be deleted from the repository

VersionException - thrown if the VersionManager encounters errors with the associated workspace

atg.deployment.common.DeploymentException - if there are errors confirming there are no pending deployments for the project

PublishingException - if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not be

TransactionDemarcationException

javax.jms.JMSException

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

addAsset

void addAsset(java.lang.String[] pAssetURIs)
              throws InvalidAssetException,
                     RepositoryException,
                     VersionException,
                     TransactionDemarcationException,
                     LockManagerException,
                     PublishingException,
                     javax.ejb.EJBException

Adds an asset to this project

Parameters:

pAssetURIs - An array of asset URIs to add to the project

Throws:

InvalidAssetException - If a URI specifies an invalid asset

RepositoryException - If a repository error occurs

VersionException - If a version manager error occurs

TransactionDemarcationException - If a transaction error occurs

LockManagerException - If an asset lock cannot be acquired

PublishingException - If an error occurs in publishing

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

assetInProject

boolean assetInProject(VersionManagerURI pAssetURI)
                       throws InvalidAssetException,
                              javax.ejb.EJBException

Returns true if the specified asset already exists in this project

Parameters:

pAssetURI - The URI of the asset to check if it is in this project

Returns:

true if the asset exists in the project, false otherwise

Throws:

InvalidAssetException - If the URI specifies an invalid asset

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

revertAsset

void revertAsset(VersionManagerURI pAssetURI,
               java.lang.String pVersion)
                 throws InvalidAssetException,
                        VersionException,
                        TransactionDemarcationException,
                        RepositoryException,
                        javax.ejb.EJBException

Reverts an asset in the project to the version which was originally checked out. Any changes in the project's workspace are completely reverted back to their original checked out state. If pVersion is not null, then the revert process will revert the asset to the version specified in pVersion.

Parameters:

pAssetURI - The URI of the asset to revert

pVersion - The version to revert to or null for latest version

Throws:

InvalidAssetException - If the supplied asset URI is invalid and cannot be resolved

VersionException - If a version manager error occurs

TransactionDemarcationException - If a transaction error occurs

RepositoryException - If a repository error occurs

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

discardAsset

void discardAsset(java.lang.String[] pAssetURIs)
                  throws InvalidAssetException,
                         PublishingException,
                         VersionException,
                         TransactionDemarcationException,
                         javax.ejb.EJBException

Removes an asset from the project completely. Any changes to the asset in the workspace are completely removed and the asset's version is the latest one on the branch.

Parameters:

pAssetURIs - An array of asset URIs to be discarded

Throws:

InvalidAssetException - If the supplied asset URI is invalid and cannot be resolved

PublishingException - If an asset cannot be discarded for some reason.

VersionException - If a version manager error occurs

TransactionDemarcationException - If a transaction error occurs

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

updateDeploymentStatuses

void updateDeploymentStatuses(java.lang.String pTargetID,
                            java.lang.Integer pApprovalFlag)
                              throws javax.ejb.EJBException

Updates the deploymentStatuses Map property with the given value. A null flag is considered a Map.remove(). This method catches ConcurrentUpdateExceptions and retries the update, thus attempting to insure the update occurs without over-writing the concurrent change.

Parameters:

pTargetID - Target.getID() for the target to set a value for

pApprovalFlag - the value deployment status to set for the given target

Throws:

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

updateDeploymentSnapshots

void updateDeploymentSnapshots(java.lang.String pTargetID,
                             java.lang.String pSnapshotID)
                               throws javax.ejb.EJBException

Updates the deploymentSnapshots Map properties with the given value. A null flag is considered a Map.remove(). This method catches ConcurrentUpdateExceptions and retries the update, thus attempting to insure the update occurs without over-writing the concurrent change.

Parameters:

pTargetID - Target.getID() for the target to set a value for

pSnapshotID - the value Snapshot ID to set for the given target

Throws:

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

updateDeploymentTimes

void updateDeploymentTimes(java.lang.String pTargetID,
                         java.sql.Timestamp pDeploymentTime)
                           throws javax.ejb.EJBException

Updates the deploymentTimes Map properties with the given value. A null flag is considered a Map.remove(). This method catches ConcurrentUpdateExceptions and retries the update, thus attempting to insure the update occurs without over-writing the concurrent change.

Parameters:

pTargetID - Target.getID() for the target to set a value for

pDeploymentTime - when this project should be considered to be deployed.

Throws:

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

updateDeploymentIds

void updateDeploymentIds(java.lang.String pTargetID,
                       java.lang.String pDeploymentId)
                         throws javax.ejb.EJBException

Updates the deploymentIds Map properties with the given value. A null flag is considered a Map.remove(). This method catches ConcurrentUpdateExceptions and retries the update, thus attempting to insure the update occurs without over-writing the concurrent change.

Parameters:

pTargetID - Target.getID() for the target to set a value for

pDeploymentId - the deployment id.

Throws:

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

resolveWorkspace

Workspace resolveWorkspace()
                           throws PublishingException,
                                  VersionException,
                                  javax.ejb.EJBException

A convenience method for resolving the Workspace named in getWorkspace(). If getWorkspace() is null or if the Workspace named in getWorkspace() cannot be found in the VersionManager, then an a PublishingException is thrown.

Throws:

PublishingException - if there is no associated workspace or the workspace could not be found

VersionException - if the VersionManager encounters errors with the associated workspace

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

approveDeployment

void approveDeployment(Target pTarget)
                       throws PublishingException,
                              VersionException,
                              atg.epub.project.AssetLockException,
                              javax.ejb.EJBException

Flags the project as approved for deployment to the specified deployment target. This flag allows for various deployment facilities, e.g. the UI or batch deployer, to identify this Project as ready for deployment. <P> If this method is called before Project.checkin(), then the late checkin model is assumed and an attempt is made to lock the assets modified in this Project. Once asset locks are obtained, no other Project can checkin or deploy those assets until either revertDeployments(), delete(), or checkin() is called releasing the asset locks. If asset locks cannot be acquired, then an exception is thrown.

Parameters:

pTarget - the deployment target to approve deployment of the Project to

Throws:

PublishingException - if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not be

VersionException - when there are technical errors locking assets for the late-checkin model

atg.epub.project.AssetLockException - if assets were already locked by another Project

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

approveDeployment

void approveDeployment()
                       throws PublishingException,
                              VersionException,
                              atg.epub.project.AssetLockException,
                              javax.ejb.EJBException

Flags the project as approved for deployment to all known deployment targets. This flag allows for various deployment facilities, e.g. the UI or batch deployer, to identify this Project as ready for deployment. <P> If this method is called before Project.checkin(), then the late checkin model is assumed and an attempt is made to lock the assets modified in this Project. Once asset locks are obtained, no other Project can checkin or deploy those assets until either revertDeployments(), delete(), or checkin() is called releasing the asset locks. If asset locks cannot be acquired, then an exception is thrown.

Throws:

PublishingException - if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not be

VersionException - when there are technical errors locking assets for the late-checkin model

atg.epub.project.AssetLockException - if assets were already locked by another Project

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

renounce

void renounce(Target pTarget,
            java.lang.String pComment)
              throws PublishingException,
                     javax.ejb.EJBException,
                     javax.jms.JMSException

Flags the project as renounced for the specified deployment target. This flag allows for various deployment facilities, e.g. the UI or asset dependency checker, to identify this Project as something to be ignored. <P> If this method is called before Project.checkin(), then an exception is thrown.

Parameters:

pTarget - the deployment target to approve deployment of the Project to

pComment - An optional comment

Throws:

PublishingException - if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not be

javax.ejb.EJBException - when there are technical errors.

javax.jms.JMSException - when there are error sending JMS message about this operation

renounce

void renounce(java.lang.String pComment)
              throws PublishingException,
                     javax.ejb.EJBException,
                     javax.jms.JMSException

Flags the project as renounced for all known deployment targets. This flag allows for various deployment facilities, e.g. the UI or asset dependency checker, to identify this Project as something to be ignored. <P> If this method is called before Project.checkin(), then an exception is thrown.

Parameters:

pComment - An optional checkin comment

Throws:

PublishingException - if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not be

javax.ejb.EJBException - when there are technical errors.

javax.jms.JMSException - when there are error sending JMS message about this operation

acquireAssetLocks

void acquireAssetLocks()
                       throws PublishingException,
                              VersionException,
                              atg.epub.project.AssetLockException,
                              javax.ejb.EJBException

Acquires asset locks for all assets in the Project. Only open projects can lock assets, not projects that have already checked in their assets.

Throws:

PublishingException - if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not be

VersionException - when there are technical errors locking assets for the late-checkin model

atg.epub.project.AssetLockException - if assets were already locked by another Project

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

releaseAssetLocks

void releaseAssetLocks()
                       throws PublishingException,
                              VersionException,
                              javax.ejb.EJBException

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. A PublishingException is thrown if locks cannot be and/or were not released. <P> Specifically, if a Project is checked-in OR is not deployed to, scheduled for deployment to, or approved for deployment to any deployment target, then asset locks can be released.

Throws:

PublishingException - if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not be

VersionException - when there are technical errors unlocking assets for the late-checkin model

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

revokeDeploymentApproval

void revokeDeploymentApproval(Target pTarget)
                              throws PublishingException,
                                     javax.jms.JMSException,
                                     TransactionDemarcationException,
                                     javax.ejb.EJBException

Revokes approval of the Project for deployment to the specified deployment Target. This method removes any approval flags set by approveDeployment() that have not been picked up by the DeploymentServer. <P> NOTE: calling this method will *NOT* release any asset locks even if approval to the revoked targets was the cause of the locks. To release locks, revertDeployment() or and explicit call to releaseAssetLocks() should be made. This is to insure that content approvers who think they have locked their assets will not loose their locks if an admin has to reject approval of a deployment for unrelated reasons. <P> A PublishingException is thrown if the deployment approval state is found to be irrevocable.

Parameters:

pTarget - the Target to revoke deployment approval for

Throws:

PublishingException - if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not be

javax.jms.JMSException - if there were errors advancing any work-flows waiting an approved deployment

TransactionDemarcationException - if there are system level transaction errors

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

reopen

void reopen()
            throws PublishingException,
                   VersionException,
                   javax.ejb.EJBException

This method is only valid for Projects that are not checked-in, thus only valid in the late check-in work-flow model. <P> Reopens the project for editing. If the project has been deployed to any deployment target, the project is left deployed to the target for continued viewing there. <P> When this method returns, the project should be in an editable state and any asset locks are unaffected. <P> Reopening a project instead of reverting may be desirable when asset locks want to be maintained, the project needs to be reviewed during revision on a deployed target, or re-authoring turn-around time will be short enough to leave the current project changes on deployment targets.

Throws:

PublishingException - if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not be

VersionException - if the VersionManager encounters errors with the associated workspace

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

revertDeployment

void revertDeployment(Target pTarget,
                    java.lang.String pInitiatorID,
                    java.util.Calendar pDeployTime)
                      throws PublishingException,
                             VersionException,
                             atg.deployment.common.DeploymentException,
                             javax.ejb.EJBException

This method is only valid for Projects that are not checked-in, thus only valid in the late check-in work-flow model. <P> Unassociates this project from the specified Target, assuming the project has been deployed to the target. Additionally, this method schedules a deployment for the unassociations (i.e. the revert). Essentially, calling this method is equivalent to calling Target.deployRevert() for this project against each target and Project.releaseAssetLocks(). <P> <B>Note: this method does not revert the assets in the project itself, only the deployment of those assets to a target.</B> <P> Why revert? Simply reopening a project for editing does not release asset locks. If another project needs to include and quickly deploy an asset changed and locked by this Project, a mechanism to release the lock without deleting this project is required. Reverting deployments is that mechanism.

Parameters:

pTarget - the deployment target to revert this Project from

pInitiatorID - some identifier (typically Profile login) of who is issuing this call

pDeployTime - a specific time to run the deployment, or NULL if run as soon as possible

Throws:

PublishingException - if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not be

VersionException - if there are errors performing the revert proper

atg.deployment.common.DeploymentException - if there are errors confirming there are no pending deployments for the project

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

revertDeployments

void revertDeployments(java.lang.String pInitiatorID,
                     java.util.Calendar pDeployTime)
                       throws PublishingException,
                              VersionException,
                              atg.deployment.common.DeploymentException,
                              javax.ejb.EJBException

This method is only valid for Projects that are not checked-in, thus only valid in the late check-in work-flow model. <P> Creates a deployment to unassociates this project from all Targets the project has been deployed to. Essentially, calling this method is equivalent to calling Target.deployRevert() for this project against each target. <P> <B>Note: this method does not revert the assets in the project itself, only the deployment of those assets to a target.</B> <P> Why revert? Simply reopening a project for editing does not release asset locks. If another project needs to include and quickly deploy an asset changed and locked by this Project, a mechanism to release the lock without deleting this project is required. Reverting deployments is that mechanism.

Parameters:

pInitiatorID - some identifier (typically Profile login) of who is issuing this call

pDeployTime - a specific time to run the deployment, or NULL if run as soon as possible

Throws:

PublishingException - if there are unexpected errors, e.g. no associated workspace or the Project is checked-in when it should not be

VersionException - if there are errors performing the revert proper

atg.deployment.common.DeploymentException - if there are errors confirming there are no pending deployments for the project

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

findCrossProjectDeleteDependencies

java.util.Collection findCrossProjectDeleteDependencies(java.util.Collection pCandidateProjects)
                                                        throws VersionException,
                                                               TransactionDemarcationException,
                                                               javax.ejb.EJBException

This method is only valid for Projects that are not checked-in, thus only valid in the late check-in work-flow model. <P> This method looks at all projects which are locked and active and finds out depenencies between asset deleted in this project and asset in other locked projects. This method also finds out if assets deleted in other projects have been referenced in this project. <P>@see atg.epub.project.VirtualCrossProjectReference

Parameters:

pCandidateProjects - A collection of candidate projects to check against.

Throws:

VersionException - if there are errors performing the revert proper

TransactionDemarcationException - If a transaction error occurs

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