DeploymentLog (ATG Java API)

All Superinterfaces:: javax.ejb.EJBLocalObject

public interface DeploymentLog
extends javax.ejb.EJBLocalObject

Class DeploymentLog ("Deployment log")

Home: DeploymentLogHome
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
resourceBundle	atg.epub.PublishingRepositoryResources

Property Summaries

Property Name	Property Type	Property Description	Flags
actor	`RepositoryItem`	Actor	R, W, Cch, Qry
beginTime	`Timestamp`	Deployment begin	R, W, Cch, Qry
delimitedProjectIds	`String`	Delimited project IDs	R, W, Cch, Qry, Exp
delimiter	`String`	Delimiter	R, W, Cch, Qry, Exp
deploymentId	`String`	Deployment Id	R, W, Cch, Qry, Exp
deploymentMode	`DeploymentLogEnumDeploymentMode`		R, W, Cch, Qry
deploymentType	`DeploymentLogEnumDeploymentType`	Deployment Type	R, W, Cch, Qry
endTime	`Timestamp`	Deployment end	R, W, Cch, Qry
id	`String`	Log id	R, W, Cch, Id, Qry, Exp
logTime	`Timestamp`	Deployment log time	R, W, Cch, Qry
status	`DeploymentLogEnumStatus`	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
targetName	`String`		R, W, Cch, Qry

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 actor ("Actor"): RepositoryItem

Getter: getActor()
Setter: setActor(atg.repository.RepositoryItem)
Flags: readable, writable, cacheable, queryable
Type Name: string
Sort String: actor
Attributes:

Attribute Name	Attribute Value
resourceBundle	atg.epub.PublishingRepositoryResources

Property beginTime ("Deployment begin"): Timestamp

Getter: getBeginTime()
Setter: setBeginTime(java.sql.Timestamp)
Flags: readable, writable, cacheable, queryable
Type Name: timestamp
Sort String: begintime ("deployment begin")
Attributes:

Attribute Name	Attribute Value
resourceBundle	atg.epub.PublishingRepositoryResources

Property delimitedProjectIds ("Delimited project IDs"): String

Getter: getDelimitedProjectIds()
Setter: setDelimitedProjectIds(java.lang.String)
Flags: readable, writable, cacheable, queryable, expert
Type Name: string
Sort String: delimitedprojectids ("delimited project ids")
Attributes:

Attribute Name	Attribute Value
resourceBundle	atg.epub.PublishingRepositoryResources

Property delimiter ("Delimiter"): String

Getter: getDelimiter()
Setter: setDelimiter(java.lang.String)
Flags: readable, writable, cacheable, queryable, expert
Type Name: string
Sort String: delimiter
Attributes:

Attribute Name	Attribute Value
resourceBundle	atg.epub.PublishingRepositoryResources

Property deploymentId ("Deployment Id"): String

Getter: getDeploymentId()
Setter: setDeploymentId(java.lang.String)
Flags: readable, writable, cacheable, queryable, expert
Type Name: string
Sort String: deploymentid ("deployment id")
Attributes:

Attribute Name	Attribute Value
resourceBundle	atg.epub.PublishingRepositoryResources

Property deploymentMode: DeploymentLogEnumDeploymentMode

Getter: getDeploymentMode()
Setter: setDeploymentMode(atg.epub.project.DeploymentLogEnumDeploymentMode)
Flags: readable, writable, cacheable, queryable
Type Name: enumerated
Sort String: deploymentmode
Attributes:

Attribute Name	Attribute Value
resourceBundle	atg.epub.PublishingRepositoryResources

Property deploymentType ("Deployment Type"): DeploymentLogEnumDeploymentType

Getter: getDeploymentType()
Setter: setDeploymentType(atg.epub.project.DeploymentLogEnumDeploymentType)
Flags: readable, writable, cacheable, queryable
Type Name: enumerated
Sort String: deploymenttype ("deployment type")
Attributes:

Attribute Name	Attribute Value
resourceBundle	atg.epub.PublishingRepositoryResources

Property endTime ("Deployment end"): Timestamp

Getter: getEndTime()
Setter: setEndTime(java.sql.Timestamp)
Flags: readable, writable, cacheable, queryable
Type Name: timestamp
Sort String: endtime ("deployment end")
Attributes:

Attribute Name	Attribute Value
resourceBundle	atg.epub.PublishingRepositoryResources

Property id ("Log id"): String

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

Attribute Name	Attribute Value
resourceBundle	atg.epub.PublishingRepositoryResources

Property logTime ("Deployment log time"): Timestamp

Getter: getLogTime()
Setter: setLogTime(java.sql.Timestamp)
Flags: readable, writable, cacheable, queryable
Type Name: timestamp
Sort String: logtime ("deployment log time")
Attributes:

Attribute Name	Attribute Value
resourceBundle	atg.epub.PublishingRepositoryResources

Property status ("Status"): DeploymentLogEnumStatus

Getter: getStatus()
Setter: setStatus(atg.epub.project.DeploymentLogEnumStatus)
Flags: readable, writable, cacheable, queryable
Type Name: enumerated
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 targetName: String

Getter: getTargetName()
Setter: setTargetName(java.lang.String)
Flags: readable, writable, cacheable, queryable
Type Name: string
Sort String: targetname
Attributes:

Attribute Name	Attribute Value
resourceBundle	atg.epub.PublishingRepositoryResources

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`_isMutable()` Returns true if the item is mutable.
`void`	`copyTo(DeploymentLog destination)` Copies the property values of this instance to another instance of the same data type.
`RepositoryItem`	`getActor()` Getter for property actor ("Actor")
`java.sql.Timestamp`	`getBeginTime()` Getter for property beginTime ("Deployment begin")
`java.lang.String`	`getDelimitedProjectIds()` Getter for property delimitedProjectIds ("Delimited project IDs")
`java.lang.String`	`getDelimiter()` Getter for property delimiter ("Delimiter")
`java.lang.String`	`getDeploymentId()` Getter for property deploymentId ("Deployment Id")
`DeploymentLogEnumDeploymentMode`	`getDeploymentMode()` Getter for property deploymentMode
`DeploymentLogEnumDeploymentType`	`getDeploymentType()` Getter for property deploymentType ("Deployment Type")
`java.sql.Timestamp`	`getEndTime()` Getter for property endTime ("Deployment end")
`boolean`	`getHasStrictFileOps()` Returns true if the value of property strictFileOps is null.
`boolean`	`getHasStrictRepoOps()` Returns true if the value of property strictRepoOps is null.
`java.lang.String`	`getId()` Getter for property id ("Log id")
`java.sql.Timestamp`	`getLogTime()` Getter for property logTime ("Deployment log time")
`DeploymentLogEnumStatus`	`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`	`getTargetName()` Getter for property targetName
`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`	`setActor(RepositoryItem value)` Setter for property actor ("Actor").
`void`	`setBeginTime(java.sql.Timestamp value)` Setter for property beginTime ("Deployment begin").
`void`	`setDelimitedProjectIds(java.lang.String value)` Setter for property delimitedProjectIds ("Delimited project IDs").
`void`	`setDelimiter(java.lang.String value)` Setter for property delimiter ("Delimiter").
`void`	`setDeploymentId(java.lang.String value)` Setter for property deploymentId ("Deployment Id").
`void`	`setDeploymentMode(DeploymentLogEnumDeploymentMode value)` Setter for property deploymentMode .
`void`	`setDeploymentType(DeploymentLogEnumDeploymentType value)` Setter for property deploymentType ("Deployment Type").
`void`	`setEndTime(java.sql.Timestamp value)` Setter for property endTime ("Deployment end").
`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 ("Log id").
`void`	`setLogTime(java.sql.Timestamp value)` Setter for property logTime ("Deployment log time").
`void`	`setStatus(DeploymentLogEnumStatus 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`	`setTargetName(java.lang.String value)` Setter for property targetName .
`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
  - getActor
```
RepositoryItem getActor()
                 throws javax.ejb.EJBException
```
    Getter for property actor ("Actor")
    
    Returns:
    
    RepositoryItem
    
    Throws:
    
    javax.ejb.EJBException
  - setActor
```
void setActor(RepositoryItem value)
       throws javax.ejb.EJBException
```
    Setter for property actor ("Actor"). 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
  - getBeginTime
```
java.sql.Timestamp getBeginTime()
                         throws javax.ejb.EJBException
```
    Getter for property beginTime ("Deployment begin")
    
    Returns:
    
    Timestamp
    
    Throws:
    
    javax.ejb.EJBException
  - setBeginTime
```
void setBeginTime(java.sql.Timestamp value)
           throws javax.ejb.EJBException
```
    Setter for property beginTime ("Deployment begin"). 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
  - getDelimitedProjectIds
```
java.lang.String getDelimitedProjectIds()
                                 throws javax.ejb.EJBException
```
    Getter for property delimitedProjectIds ("Delimited project IDs")
    
    Returns:
    
    String
    
    Throws:
    
    javax.ejb.EJBException
  - setDelimitedProjectIds
```
void setDelimitedProjectIds(java.lang.String value)
                     throws javax.ejb.EJBException
```
    Setter for property delimitedProjectIds ("Delimited 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
  - getDelimiter
```
java.lang.String getDelimiter()
                       throws javax.ejb.EJBException
```
    Getter for property delimiter ("Delimiter")
    
    Returns:
    
    String
    
    Throws:
    
    javax.ejb.EJBException
  - setDelimiter
```
void setDelimiter(java.lang.String value)
           throws javax.ejb.EJBException
```
    Setter for property delimiter ("Delimiter"). 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
  - getDeploymentId
```
java.lang.String getDeploymentId()
                          throws javax.ejb.EJBException
```
    Getter for property deploymentId ("Deployment Id")
    
    Returns:
    
    String
    
    Throws:
    
    javax.ejb.EJBException
  - setDeploymentId
```
void setDeploymentId(java.lang.String value)
              throws javax.ejb.EJBException
```
    Setter for property deploymentId ("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
  - getDeploymentMode
```
DeploymentLogEnumDeploymentMode getDeploymentMode()
                                           throws javax.ejb.EJBException
```
    Getter for property deploymentMode
    
    Returns:
    
    DeploymentLogEnumDeploymentMode
    
    Throws:
    
    javax.ejb.EJBException
  - setDeploymentMode
```
void setDeploymentMode(DeploymentLogEnumDeploymentMode value)
                throws javax.ejb.EJBException
```
    Setter for property deploymentMode . 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 - DeploymentLogEnumDeploymentMode
    
    Throws:
    
    javax.ejb.EJBException
  - getDeploymentType
```
DeploymentLogEnumDeploymentType getDeploymentType()
                                           throws javax.ejb.EJBException
```
    Getter for property deploymentType ("Deployment Type")
    
    Returns:
    
    DeploymentLogEnumDeploymentType
    
    Throws:
    
    javax.ejb.EJBException
  - setDeploymentType
```
void setDeploymentType(DeploymentLogEnumDeploymentType value)
                throws javax.ejb.EJBException
```
    Setter for property deploymentType ("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 - DeploymentLogEnumDeploymentType
    
    Throws:
    
    javax.ejb.EJBException
  - getEndTime
```
java.sql.Timestamp getEndTime()
                       throws javax.ejb.EJBException
```
    Getter for property endTime ("Deployment end")
    
    Returns:
    
    Timestamp
    
    Throws:
    
    javax.ejb.EJBException
  - setEndTime
```
void setEndTime(java.sql.Timestamp value)
         throws javax.ejb.EJBException
```
    Setter for property endTime ("Deployment end"). 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
  - getId
```
java.lang.String getId()
                throws javax.ejb.EJBException
```
    Getter for property id ("Log id")
    
    Returns:
    
    String
    
    Throws:
    
    javax.ejb.EJBException
  - setId
```
void setId(java.lang.String value)
    throws javax.ejb.EJBException
```
    Setter for property id ("Log 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
  - getLogTime
```
java.sql.Timestamp getLogTime()
                       throws javax.ejb.EJBException
```
    Getter for property logTime ("Deployment log time")
    
    Returns:
    
    Timestamp
    
    Throws:
    
    javax.ejb.EJBException
  - setLogTime
```
void setLogTime(java.sql.Timestamp value)
         throws javax.ejb.EJBException
```
    Setter for property logTime ("Deployment log 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
  - getStatus
```
DeploymentLogEnumStatus getStatus()
                           throws javax.ejb.EJBException
```
    Getter for property status ("Status")
    
    Returns:
    
    DeploymentLogEnumStatus
    
    Throws:
    
    javax.ejb.EJBException
  - setStatus
```
void setStatus(DeploymentLogEnumStatus 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 - DeploymentLogEnumStatus
    
    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
  - getTargetName
```
java.lang.String getTargetName()
                        throws javax.ejb.EJBException
```
    Getter for property targetName
    
    Returns:
    
    String
    
    Throws:
    
    javax.ejb.EJBException
  - setTargetName
```
void setTargetName(java.lang.String value)
            throws javax.ejb.EJBException
```
    Setter for property targetName . 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(DeploymentLog 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.

Interface DeploymentLog

Class DeploymentLog ("Deployment log")

Property Summaries

Property Details

Method Summary

Methods inherited from interface javax.ejb.EJBLocalObject

Method Detail

getActor

setActor

getBeginTime

setBeginTime

getDelimitedProjectIds

setDelimitedProjectIds

getDelimiter

setDelimiter

getDeploymentId

setDeploymentId

getDeploymentMode

setDeploymentMode

getDeploymentType

setDeploymentType

getEndTime

setEndTime

getId

setId

getLogTime

setLogTime

getStatus

setStatus

getStrictFileOps

getHasStrictFileOps

setStrictFileOps

setHasStrictFileOps

getStrictRepoOps

getHasStrictRepoOps

setStrictRepoOps

setHasStrictRepoOps

getTargetName

setTargetName

isRemoved

copyTo

writeInstance

prepareInstanceForWrite

_isMutable