atg.epub.project

Interface TargetDef

All Superinterfaces:

javax.ejb.EJBLocalObject

public interface TargetDef
extends javax.ejb.EJBLocalObject

Class TargetDef ("Deployment Target Definition")

• Home: TargetDefHome
• 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	[:topologyDef.targets, :targetDef.surrogateFor]
  resourceBundle	atg.epub.PublishingRepositoryResources
  uiwritable	false

Property Summaries

Property Name	Property Type	Property Description	Flags
agents	Set of AgentDef	Agent Definitions	R, W, CsD, Cch, CoM, Mv, Qry
creationTime	Timestamp	Creation time	R, W, Cch, Qry
description	String	Description	R, W, Cch, Qry
destinations	Map	Destination repositories and VFSs for this Target server	R, W, Cch, CoM, Mv, Qry
displayName	String	Name	R, W, Cch, Qry
flagAgents	boolean	If the agents should be simply flagged on target initialization ?	R, W, Cch, Qry
halted	boolean	If this target is not accepting deployment jobs ?	R, W, Cch, Qry
id	String	Target ID	R, W, Cch, Id, Qry, Exp
initialSnapshotName	String	Initial snapshot name	R, W, Cch, Qry, Exp
repositoryTableMappings	Map with TableMapping values	Repository table mappings	R, W, CsD, Cch, CoM, Mv, Qry
surrogateFor	TargetDef	Target for which this target acts as a surrogate	R, W, Cch, Qry
targetType	TargetDefTargetType	Target 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 agents ("Agent Definitions"): Set of AgentDef

• Getter: getAgents()
• Setter: setAgents(java.util.Set)
• Flags: readable, writable, cascadeDelete, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: set
• Sort String: agents ("agent definitions")
• 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.814
• Type Name: timestamp
• Sort String: creationtime ("creation time")
• 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 destinations ("Destination repositories and VFSs for this Target server"): Map

• Getter: getDestinations()
• Setter: setDestinations(java.util.Map)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: {}
• Type Name: map
• Sort String: destinations ("destination repositories and vfss for this target server")
• 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 flagAgents ("If the agents should be simply flagged on target initialization ?"): boolean

• Getter: isFlagAgents()
• Setter: setFlagAgents(boolean)
• Flags: readable, writable, cacheable, queryable
• Default Value: false
• Type Name: boolean
• Sort String: flagagents ("if the agents should be simply flagged on target initialization ?")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property halted ("If this target is not accepting deployment jobs ?"): boolean

• Getter: isHalted()
• Setter: setHalted(boolean)
• Flags: readable, writable, cacheable, queryable
• Default Value: false
• Type Name: boolean
• Sort String: halted ("if this target is not accepting deployment jobs ?")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property id ("Target ID"): String

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

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property initialSnapshotName ("Initial snapshot name"): String

• Getter: getInitialSnapshotName()
• Setter: setInitialSnapshotName(java.lang.String)
• Flags: readable, writable, cacheable, queryable, expert
• Type Name: string
• Sort String: initialsnapshotname ("initial snapshot name")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property repositoryTableMappings ("Repository table mappings"): Map with TableMapping values

• Getter: getRepositoryTableMappings()
• Setter: setRepositoryTableMappings(java.util.Map)
• Flags: readable, writable, cascadeDelete, cacheable, collectionOrMap, multivalued, queryable
• Default Value: {}
• Type Name: map
• Sort String: repositorytablemappings ("repository table mappings")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property surrogateFor ("Target for which this target acts as a surrogate"): TargetDef

• Getter: getSurrogateFor()
• Setter: setSurrogateFor(atg.epub.project.TargetDef)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: surrogatefor ("target for which this target acts as a surrogate")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property targetType ("Target type"): TargetDefTargetType

• Getter: getTargetType()
• Setter: setTargetType(atg.epub.project.TargetDefTargetType)
• Flags: readable, writable, cacheable, queryable
• Default Value: workflow
• Type Name: enumerated
• Sort String: targettype ("target 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(TargetDef destination) Copies the property values of this instance to another instance of the same data type.
java.util.Set	getAgents() Getter for property agents ("Agent Definitions")
java.sql.Timestamp	getCreationTime() Getter for property creationTime ("Creation time")
java.lang.String	getDescription() Getter for property description ("Description")
java.util.Map	getDestinations() Getter for property destinations ("Destination repositories and VFSs for this Target server")
java.lang.String	getDisplayName() Getter for property displayName ("Name")
boolean	getHasFlagAgents() Returns true if the value of property flagAgents is null.
boolean	getHasHalted() Returns true if the value of property halted is null.
boolean	getHasVersion() Returns true if the value of property version is null.
java.lang.String	getId() Getter for property id ("Target ID")
java.lang.String	getInitialSnapshotName() Getter for property initialSnapshotName ("Initial snapshot name")
java.util.Map	getRepositoryTableMappings() Getter for property repositoryTableMappings ("Repository table mappings")
TargetDef	getSurrogateFor() Getter for property surrogateFor ("Target for which this target acts as a surrogate")
atg.epub.project.TargetDefTargetType	getTargetType() Getter for property targetType ("Target type")
int	getVersion() Getter for property version ("Version")
boolean	isFlagAgents() Getter for property flagAgents ("If the agents should be simply flagged on target initialization ?")
boolean	isHalted() Getter for property halted ("If this target is not accepting deployment jobs ?")
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	setAgents(java.util.Set value) Setter for property agents ("Agent Definitions").
void	setCreationTime(java.sql.Timestamp value) Setter for property creationTime ("Creation time").
void	setDescription(java.lang.String value) Setter for property description ("Description").
void	setDestinations(java.util.Map value) Setter for property destinations ("Destination repositories and VFSs for this Target server").
void	setDisplayName(java.lang.String value) Setter for property displayName ("Name").
void	setFlagAgents(boolean value) Setter for property flagAgents ("If the agents should be simply flagged on target initialization ?").
void	setHalted(boolean value) Setter for property halted ("If this target is not accepting deployment jobs ?").
void	setHasFlagAgents(boolean value) If this is set to false, then the underlying value of property flagAgents is set to null.
void	setHasHalted(boolean value) If this is set to false, then the underlying value of property halted is set to null.
void	setId(java.lang.String value) Setter for property id ("Target ID").
void	setInitialSnapshotName(java.lang.String value) Setter for property initialSnapshotName ("Initial snapshot name").
void	setRepositoryTableMappings(java.util.Map value) Setter for property repositoryTableMappings ("Repository table mappings").
void	setSurrogateFor(TargetDef value) Setter for property surrogateFor ("Target for which this target acts as a surrogate").
void	setTargetType(atg.epub.project.TargetDefTargetType value) Setter for property targetType ("Target type").
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

getAgents

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

Getter for property agents ("Agent Definitions")

Returns:

Set of AgentDef

Throws:

javax.ejb.EJBException

setAgents

void setAgents(java.util.Set value)
               throws javax.ejb.EJBException

Setter for property agents ("Agent Definitions"). 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 - Set of AgentDef

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

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

getDestinations

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

Getter for property destinations ("Destination repositories and VFSs for this Target server")

Returns:

Map

Throws:

javax.ejb.EJBException

setDestinations

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

Setter for property destinations ("Destination repositories and VFSs for this Target server"). 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

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

isFlagAgents

boolean isFlagAgents()
                     throws javax.ejb.EJBException

Getter for property flagAgents ("If the agents should be simply flagged on target initialization ?")

Returns:

boolean

Throws:

javax.ejb.EJBException

getHasFlagAgents

boolean getHasFlagAgents()
                         throws javax.ejb.EJBException

Returns true if the value of property flagAgents is null.

Throws:

javax.ejb.EJBException

setFlagAgents

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

Setter for property flagAgents ("If the agents should be simply flagged on target initialization ?"). 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

setHasFlagAgents

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

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

Throws:

javax.ejb.EJBException

isHalted

boolean isHalted()
                 throws javax.ejb.EJBException

Getter for property halted ("If this target is not accepting deployment jobs ?")

Returns:

boolean

Throws:

javax.ejb.EJBException

getHasHalted

boolean getHasHalted()
                     throws javax.ejb.EJBException

Returns true if the value of property halted is null.

Throws:

javax.ejb.EJBException

setHalted

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

Setter for property halted ("If this target is not accepting deployment jobs ?"). 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

setHasHalted

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

If this is set to false, then the underlying value of property halted 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 ("Target ID")

Returns:

String

Throws:

javax.ejb.EJBException

setId

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

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

getInitialSnapshotName

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

Getter for property initialSnapshotName ("Initial snapshot name")

Returns:

String

Throws:

javax.ejb.EJBException

setInitialSnapshotName

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

Setter for property initialSnapshotName ("Initial snapshot 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

getRepositoryTableMappings

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

Getter for property repositoryTableMappings ("Repository table mappings")

Returns:

Map with TableMapping values

Throws:

javax.ejb.EJBException

setRepositoryTableMappings

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

Setter for property repositoryTableMappings ("Repository table mappings"). 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 with TableMapping values

Throws:

javax.ejb.EJBException

getSurrogateFor

TargetDef getSurrogateFor()
                          throws javax.ejb.EJBException

Getter for property surrogateFor ("Target for which this target acts as a surrogate")

Returns:

TargetDef

Throws:

javax.ejb.EJBException

setSurrogateFor

void setSurrogateFor(TargetDef value)
                     throws javax.ejb.EJBException

Setter for property surrogateFor ("Target for which this target acts as a surrogate"). 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 - TargetDef

Throws:

javax.ejb.EJBException

getTargetType

atg.epub.project.TargetDefTargetType getTargetType()
                                                   throws javax.ejb.EJBException

Getter for property targetType ("Target type")

Returns:

TargetDefTargetType

Throws:

javax.ejb.EJBException

setTargetType

void setTargetType(atg.epub.project.TargetDefTargetType value)
                   throws javax.ejb.EJBException

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

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