atg.epub.project

Interface AgentDef

All Superinterfaces:

javax.ejb.EJBLocalObject

public interface AgentDef
extends javax.ejb.EJBLocalObject

Class AgentDef ("Deployment Agent Definition")

• Home: AgentDefHome
• 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	[:agentDef.surrogateFor, :targetDef.agents]
  resourceBundle	atg.epub.PublishingRepositoryResources
  uiwritable	false

Property Summaries

Property Name	Property Type	Property Description	Flags
creationTime	Timestamp	Creation time	R, W, Cch, Qry
description	String	Description	R, W, Cch, Qry
destinationMap	Map		R, W, Cch, CoM, Mv, Qry
displayName	String	Name	R, W, Cch, Qry
excludeAssetDestinations	Set	Exclude Asset Destinations	R, W, Cch, CoM, Mv, Qry
id	String	Agent ID	R, W, Cch, Id, Qry, Exp
includeAssetDestinations	Set	Include Asset Destinations	R, W, Cch, CoM, Mv, Qry
principalAssets	Set	Principal Assets	R, W, Cch, CoM, Mv, Qry
surrogateFor	AgentDef	Agent for which this agent acts as a surrogate	R, W, Cch, Qry
transport	TransportDef	Transport Definition	R, W, CsD, Cch, Qry, Req
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 creationTime ("Creation time"): Timestamp

• Getter: getCreationTime()
• Setter: setCreationTime(java.sql.Timestamp)
• Flags: readable, writable, cacheable, queryable
• Default Value: 2014-01-03 18:12:53.81
• 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 destinationMap: Map

• Getter: getDestinationMap()
• Setter: setDestinationMap(java.util.Map)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: {}
• Type Name: map
• Sort String: destinationmap
• 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 excludeAssetDestinations ("Exclude Asset Destinations"): Set

• Getter: getExcludeAssetDestinations()
• Setter: setExcludeAssetDestinations(java.util.Set)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: set
• Sort String: excludeassetdestinations ("exclude asset destinations")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property id ("Agent ID"): String

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

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property includeAssetDestinations ("Include Asset Destinations"): Set

• Getter: getIncludeAssetDestinations()
• Setter: setIncludeAssetDestinations(java.util.Set)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: set
• Sort String: includeassetdestinations ("include asset destinations")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property principalAssets ("Principal Assets"): Set

• Getter: getPrincipalAssets()
• Setter: setPrincipalAssets(java.util.Set)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: set
• Sort String: principalassets ("principal assets")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property surrogateFor ("Agent for which this agent acts as a surrogate"): AgentDef

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

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property transport ("Transport Definition"): TransportDef

• Getter: getTransport()
• Setter: setTransport(atg.epub.project.TransportDef)
• Flags: readable, writable, cascadeDelete, cacheable, queryable, required
• Type Name: string
• Sort String: transport ("transport definition")
• 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(AgentDef 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	getDescription() Getter for property description ("Description")
java.util.Map	getDestinationMap() Getter for property destinationMap
java.lang.String	getDisplayName() Getter for property displayName ("Name")
java.util.Set	getExcludeAssetDestinations() Getter for property excludeAssetDestinations ("Exclude Asset Destinations")
boolean	getHasVersion() Returns true if the value of property version is null.
java.lang.String	getId() Getter for property id ("Agent ID")
java.util.Set	getIncludeAssetDestinations() Getter for property includeAssetDestinations ("Include Asset Destinations")
java.util.Set	getPrincipalAssets() Getter for property principalAssets ("Principal Assets")
AgentDef	getSurrogateFor() Getter for property surrogateFor ("Agent for which this agent acts as a surrogate")
TransportDef	getTransport() Getter for property transport ("Transport Definition")
int	getVersion() Getter for property version ("Version")
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	setDescription(java.lang.String value) Setter for property description ("Description").
void	setDestinationMap(java.util.Map value) Setter for property destinationMap .
void	setDisplayName(java.lang.String value) Setter for property displayName ("Name").
void	setExcludeAssetDestinations(java.util.Set value) Setter for property excludeAssetDestinations ("Exclude Asset Destinations").
void	setId(java.lang.String value) Setter for property id ("Agent ID").
void	setIncludeAssetDestinations(java.util.Set value) Setter for property includeAssetDestinations ("Include Asset Destinations").
void	setPrincipalAssets(java.util.Set value) Setter for property principalAssets ("Principal Assets").
void	setSurrogateFor(AgentDef value) Setter for property surrogateFor ("Agent for which this agent acts as a surrogate").
void	setTransport(TransportDef value) Setter for property transport ("Transport Definition").
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

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

getDestinationMap

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

Getter for property destinationMap

Returns:

Map

Throws:

javax.ejb.EJBException

setDestinationMap

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

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

getExcludeAssetDestinations

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

Getter for property excludeAssetDestinations ("Exclude Asset Destinations")

Returns:

Set

Throws:

javax.ejb.EJBException

setExcludeAssetDestinations

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

Setter for property excludeAssetDestinations ("Exclude Asset Destinations"). 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

Throws:

javax.ejb.EJBException

getId

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

Getter for property id ("Agent ID")

Returns:

String

Throws:

javax.ejb.EJBException

setId

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

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

getIncludeAssetDestinations

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

Getter for property includeAssetDestinations ("Include Asset Destinations")

Returns:

Set

Throws:

javax.ejb.EJBException

setIncludeAssetDestinations

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

Setter for property includeAssetDestinations ("Include Asset Destinations"). 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

Throws:

javax.ejb.EJBException

getPrincipalAssets

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

Getter for property principalAssets ("Principal Assets")

Returns:

Set

Throws:

javax.ejb.EJBException

setPrincipalAssets

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

Setter for property principalAssets ("Principal Assets"). 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

Throws:

javax.ejb.EJBException

getSurrogateFor

AgentDef getSurrogateFor()
                         throws javax.ejb.EJBException

Getter for property surrogateFor ("Agent for which this agent acts as a surrogate")

Returns:

AgentDef

Throws:

javax.ejb.EJBException

setSurrogateFor

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

Setter for property surrogateFor ("Agent for which this agent 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 - AgentDef

Throws:

javax.ejb.EJBException

getTransport

TransportDef getTransport()
                          throws javax.ejb.EJBException

Getter for property transport ("Transport Definition")

Returns:

TransportDef

Throws:

javax.ejb.EJBException

setTransport

void setTransport(TransportDef value)
                  throws javax.ejb.EJBException

Setter for property transport ("Transport Definition"). 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 - TransportDef

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