atg.epub.project

Interface PendingDeployment

All Superinterfaces:

javax.ejb.EJBLocalObject

public interface PendingDeployment
extends javax.ejb.EJBLocalObject

Class PendingDeployment ("Pending deployment")

• Home: PendingDeploymentHome
• Flags:
• 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
  categoryBasicsPriority	10
  categoryInfoPriority	20
  references	[:pendingDeployment.next, :pendingDeployment.previous]
  resourceBundle	atg.epub.PublishingRepositoryResources

Property Summaries

Property Name	Property Type	Property Description	Flags
URI	String		R, W, Cch, Qry
creationTime	Timestamp	Creation time	R, W, Cch, Qry
creator	String	Creator	R, W, Cch, Qry
deployTime	Timestamp	Deploy time	R, W, Cch, Qry
errorParams	List	Error parameters	R, W, Cch, CoM, Mv, Qry
forceFull	boolean	Force full deployment	R, W, Cch, Qry
id	String	Deployment Id	R, W, Cch, Id, Qry, Exp
messageCode	String	Message code	R, W, Cch, Qry, Exp
next	PendingDeployment	Next deplolyment job in line	R, W, Cch, Qry
previous	PendingDeployment	Previous deployment in line	R, W, Cch, Qry
projectIDs	String[]	Project IDs	R, W, Cch, Mv, Qry
status	int	Status	R, W, Cch, Qry
strictFileOps	int	Strict repository update operations	R, W, Cch, Qry
strictRepoOps	int	Strict file update operations	R, W, Cch, Qry
targetID	String	Target ID	R, W, Cch, Qry
type	PendingDeploymentType	Deployment Type	R, W, Cch, Qry
version	int	Version	R, Cch, Qry, Exp

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 URI: String

• Getter: getURI()
• Setter: setURI(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: uri
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property creationTime ("Creation time"): Timestamp

• Getter: getCreationTime()
• Setter: setCreationTime(java.sql.Timestamp)
• Flags: readable, writable, cacheable, queryable
• Default Value: 2014-01-03 18:12:53.815
• Type Name: timestamp
• Sort String: creationtime ("creation time")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property creator ("Creator"): String

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

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property deployTime ("Deploy time"): Timestamp

• Getter: getDeployTime()
• Setter: setDeployTime(java.sql.Timestamp)
• Flags: readable, writable, cacheable, queryable
• Type Name: timestamp
• Sort String: deploytime ("deploy time")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property errorParams ("Error parameters"): List

• Getter: getErrorParams()
• Setter: setErrorParams(java.util.List)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: list
• Sort String: errorparams ("error parameters")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property forceFull ("Force full deployment"): boolean

• Getter: isForceFull()
• Setter: setForceFull(boolean)
• Flags: readable, writable, cacheable, queryable
• Type Name: boolean
• Sort String: forcefull ("force full deployment")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property id ("Deployment Id"): String

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

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property messageCode ("Message code"): String

• Getter: getMessageCode()
• Setter: setMessageCode(java.lang.String)
• Flags: readable, writable, cacheable, queryable, expert
• Type Name: string
• Sort String: messagecode ("message code")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property next ("Next deplolyment job in line"): PendingDeployment

• Getter: getNext()
• Setter: setNext(atg.epub.project.PendingDeployment)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: next ("next deplolyment job in line")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property previous ("Previous deployment in line"): PendingDeployment

• Getter: getPrevious()
• Setter: setPrevious(atg.epub.project.PendingDeployment)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: previous ("previous deployment in line")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property projectIDs ("Project IDs"): String[]

• Getter: getProjectIDs()
• Setter: setProjectIDs(java.lang.String[])
• Flags: readable, writable, cacheable, multivalued, queryable
• Default Value: [Ljava.lang.String;@dd0bd3
• Type Name: array
• Sort String: projectids ("project ids")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property status ("Status"): int

• Getter: getStatus()
• Setter: setStatus(int)
• Flags: readable, writable, cacheable, queryable
• Default Value: 152
• Type Name: int
• Sort String: status
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property strictFileOps ("Strict repository update operations"): int

• Getter: getStrictFileOps()
• Setter: setStrictFileOps(int)
• Flags: readable, writable, cacheable, queryable
• Type Name: int
• Sort String: strictfileops ("strict repository update operations")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property strictRepoOps ("Strict file update operations"): int

• Getter: getStrictRepoOps()
• Setter: setStrictRepoOps(int)
• Flags: readable, writable, cacheable, queryable
• Type Name: int
• Sort String: strictrepoops ("strict file update operations")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property targetID ("Target ID"): String

• Getter: getTargetID()
• Setter: setTargetID(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: targetid ("target id")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property type ("Deployment Type"): PendingDeploymentType

• Getter: getType()
• Setter: setType(atg.epub.project.PendingDeploymentType)
• Flags: readable, writable, cacheable, queryable
• Default Value: 2
• Type Name: enumerated
• Sort String: type ("deployment type")
• 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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(PendingDeployment destination) Copies the property values of this instance to another instance of the same data type.
java.sql.Timestamp	getCreationTime() Getter for property creationTime ("Creation time")
java.lang.String	getCreator() Getter for property creator ("Creator")
java.sql.Timestamp	getDeployTime() Getter for property deployTime ("Deploy time")
java.util.List	getErrorParams() Getter for property errorParams ("Error parameters")
boolean	getHasForceFull() Returns true if the value of property forceFull is null.
boolean	getHasStatus() Returns true if the value of property status is null.
boolean	getHasStrictFileOps() Returns true if the value of property strictFileOps is null.
boolean	getHasStrictRepoOps() Returns true if the value of property strictRepoOps is null.
boolean	getHasVersion() Returns true if the value of property version is null.
java.lang.String	getId() Getter for property id ("Deployment Id")
java.lang.String	getMessageCode() Getter for property messageCode ("Message code")
PendingDeployment	getNext() Getter for property next ("Next deplolyment job in line")
PendingDeployment	getPrevious() Getter for property previous ("Previous deployment in line")
java.lang.String[]	getProjectIDs() Getter for property projectIDs ("Project IDs")
int	getStatus() Getter for property status ("Status")
int	getStrictFileOps() Getter for property strictFileOps ("Strict repository update operations")
int	getStrictRepoOps() Getter for property strictRepoOps ("Strict file update operations")
java.lang.String	getTargetID() Getter for property targetID ("Target ID")
atg.epub.project.PendingDeploymentType	getType() Getter for property type ("Deployment Type")
java.lang.String	getURI() Getter for property URI
int	getVersion() Getter for property version ("Version")
boolean	isForceFull() Getter for property forceFull ("Force full deployment")
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	setCreationTime(java.sql.Timestamp value) Setter for property creationTime ("Creation time").
void	setCreator(java.lang.String value) Setter for property creator ("Creator").
void	setDeployTime(java.sql.Timestamp value) Setter for property deployTime ("Deploy time").
void	setErrorParams(java.util.List value) Setter for property errorParams ("Error parameters").
void	setForceFull(boolean value) Setter for property forceFull ("Force full deployment").
void	setHasForceFull(boolean value) If this is set to false, then the underlying value of property forceFull is set to null.
void	setHasStatus(boolean value) If this is set to false, then the underlying value of property status is set to null.
void	setHasStrictFileOps(boolean value) If this is set to false, then the underlying value of property strictFileOps is set to null.
void	setHasStrictRepoOps(boolean value) If this is set to false, then the underlying value of property strictRepoOps is set to null.
void	setId(java.lang.String value) Setter for property id ("Deployment Id").
void	setMessageCode(java.lang.String value) Setter for property messageCode ("Message code").
void	setNext(PendingDeployment value) Setter for property next ("Next deplolyment job in line").
void	setPrevious(PendingDeployment value) Setter for property previous ("Previous deployment in line").
void	setProjectIDs(java.lang.String[] value) Setter for property projectIDs ("Project IDs").
void	setStatus(int value) Setter for property status ("Status").
void	setStrictFileOps(int value) Setter for property strictFileOps ("Strict repository update operations").
void	setStrictRepoOps(int value) Setter for property strictRepoOps ("Strict file update operations").
void	setTargetID(java.lang.String value) Setter for property targetID ("Target ID").
void	setType(atg.epub.project.PendingDeploymentType value) Setter for property type ("Deployment Type").
void	setURI(java.lang.String value) Setter for property URI .
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

getURI

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

Getter for property URI

Returns:

String

Throws:

javax.ejb.EJBException

setURI

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

Setter for property URI . 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

getCreationTime

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

Getter for property creationTime ("Creation time")

Returns:

Timestamp

Throws:

javax.ejb.EJBException

setCreationTime

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

Setter for property creationTime ("Creation time"). 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

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

Getter for property creator ("Creator")

Returns:

String

Throws:

javax.ejb.EJBException

setCreator

void setCreator(java.lang.String 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 - String

Throws:

javax.ejb.EJBException

getDeployTime

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

Getter for property deployTime ("Deploy time")

Returns:

Timestamp

Throws:

javax.ejb.EJBException

setDeployTime

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

Setter for property deployTime ("Deploy time"). 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

getErrorParams

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

Getter for property errorParams ("Error parameters")

Returns:

List

Throws:

javax.ejb.EJBException

setErrorParams

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

Setter for property errorParams ("Error parameters"). 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

Throws:

javax.ejb.EJBException

isForceFull

boolean isForceFull()
                    throws javax.ejb.EJBException

Getter for property forceFull ("Force full deployment")

Returns:

boolean

Throws:

javax.ejb.EJBException

getHasForceFull

boolean getHasForceFull()
                        throws javax.ejb.EJBException

Returns true if the value of property forceFull is null.

Throws:

javax.ejb.EJBException

setForceFull

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

Setter for property forceFull ("Force full deployment"). 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

setHasForceFull

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

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

Throws:

javax.ejb.EJBException

getId

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

Getter for property id ("Deployment Id")

Returns:

String

Throws:

javax.ejb.EJBException

setId

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

Setter for property id ("Deployment 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

getMessageCode

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

Getter for property messageCode ("Message code")

Returns:

String

Throws:

javax.ejb.EJBException

setMessageCode

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

Setter for property messageCode ("Message code"). 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

getNext

PendingDeployment getNext()
                          throws javax.ejb.EJBException

Getter for property next ("Next deplolyment job in line")

Returns:

PendingDeployment

Throws:

javax.ejb.EJBException

setNext

void setNext(PendingDeployment value)
             throws javax.ejb.EJBException

Setter for property next ("Next deplolyment job in line"). 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 - PendingDeployment

Throws:

javax.ejb.EJBException

getPrevious

PendingDeployment getPrevious()
                              throws javax.ejb.EJBException

Getter for property previous ("Previous deployment in line")

Returns:

PendingDeployment

Throws:

javax.ejb.EJBException

setPrevious

void setPrevious(PendingDeployment value)
                 throws javax.ejb.EJBException

Setter for property previous ("Previous deployment in line"). 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 - PendingDeployment

Throws:

javax.ejb.EJBException

getProjectIDs

java.lang.String[] getProjectIDs()
                                 throws javax.ejb.EJBException

Getter for property projectIDs ("Project IDs")

Returns:

String[]

Throws:

javax.ejb.EJBException

setProjectIDs

void setProjectIDs(java.lang.String[] value)
                   throws javax.ejb.EJBException

Setter for property projectIDs ("Project 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 - String[]

Throws:

javax.ejb.EJBException

getStatus

int getStatus()
              throws javax.ejb.EJBException

Getter for property status ("Status")

Returns:

int

Throws:

javax.ejb.EJBException

getHasStatus

boolean getHasStatus()
                     throws javax.ejb.EJBException

Returns true if the value of property status is null.

Throws:

javax.ejb.EJBException

setStatus

void setStatus(int 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 - int

Throws:

javax.ejb.EJBException

setHasStatus

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

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

Throws:

javax.ejb.EJBException

getStrictFileOps

int getStrictFileOps()
                     throws javax.ejb.EJBException

Getter for property strictFileOps ("Strict repository update operations")

Returns:

int

Throws:

javax.ejb.EJBException

getHasStrictFileOps

boolean getHasStrictFileOps()
                            throws javax.ejb.EJBException

Returns true if the value of property strictFileOps is null.

Throws:

javax.ejb.EJBException

setStrictFileOps

void setStrictFileOps(int value)
                      throws javax.ejb.EJBException

Setter for property strictFileOps ("Strict repository update operations"). 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 - int

Throws:

javax.ejb.EJBException

setHasStrictFileOps

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

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

Throws:

javax.ejb.EJBException

getStrictRepoOps

int getStrictRepoOps()
                     throws javax.ejb.EJBException

Getter for property strictRepoOps ("Strict file update operations")

Returns:

int

Throws:

javax.ejb.EJBException

getHasStrictRepoOps

boolean getHasStrictRepoOps()
                            throws javax.ejb.EJBException

Returns true if the value of property strictRepoOps is null.

Throws:

javax.ejb.EJBException

setStrictRepoOps

void setStrictRepoOps(int value)
                      throws javax.ejb.EJBException

Setter for property strictRepoOps ("Strict file update operations"). 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 - int

Throws:

javax.ejb.EJBException

setHasStrictRepoOps

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

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

Throws:

javax.ejb.EJBException

getTargetID

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

Getter for property targetID ("Target ID")

Returns:

String

Throws:

javax.ejb.EJBException

setTargetID

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

Setter for property targetID ("Target 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

getType

atg.epub.project.PendingDeploymentType getType()
                                               throws javax.ejb.EJBException

Getter for property type ("Deployment Type")

Returns:

PendingDeploymentType

Throws:

javax.ejb.EJBException

setType

void setType(atg.epub.project.PendingDeploymentType value)
             throws javax.ejb.EJBException

Setter for property type ("Deployment Type"). 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 - PendingDeploymentType

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

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(PendingDeployment 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.