public interface AgentDef
extends javax.ejb.EJBLocalObject
AgentDefHome
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 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 |
Property creationTime ("Creation time"): Timestamp
getCreationTime()
setCreationTime(java.sql.Timestamp)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property description ("Description"): String
getDescription()
setDescription(java.lang.String)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
getDestinationMap()
setDestinationMap(java.util.Map)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property displayName ("Name"): String
getDisplayName()
setDisplayName(java.lang.String)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property excludeAssetDestinations ("Exclude Asset Destinations"): Set
getExcludeAssetDestinations()
setExcludeAssetDestinations(java.util.Set)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property id ("Agent ID"): String
getId()
setId(java.lang.String)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property includeAssetDestinations ("Include Asset Destinations"): Set
getIncludeAssetDestinations()
setIncludeAssetDestinations(java.util.Set)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property principalAssets ("Principal Assets"): Set
getPrincipalAssets()
setPrincipalAssets(java.util.Set)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property surrogateFor ("Agent for which this agent acts as a surrogate"): AgentDef
getSurrogateFor()
setSurrogateFor(atg.epub.project.AgentDef)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property transport ("Transport Definition"): TransportDef
getTransport()
setTransport(atg.epub.project.TransportDef)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property version ("Version"): int
getVersion()
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
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.
|
java.sql.Timestamp getCreationTime() throws javax.ejb.EJBException
Timestamp
javax.ejb.EJBException
void setCreationTime(java.sql.Timestamp value) throws javax.ejb.EJBException
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.value
- Timestamp
javax.ejb.EJBException
java.lang.String getDescription() throws javax.ejb.EJBException
String
javax.ejb.EJBException
void setDescription(java.lang.String value) throws javax.ejb.EJBException
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.value
- String
javax.ejb.EJBException
java.util.Map getDestinationMap() throws javax.ejb.EJBException
Map
javax.ejb.EJBException
void setDestinationMap(java.util.Map value) throws javax.ejb.EJBException
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.value
- Map
javax.ejb.EJBException
java.lang.String getDisplayName() throws javax.ejb.EJBException
String
javax.ejb.EJBException
void setDisplayName(java.lang.String value) throws javax.ejb.EJBException
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.value
- String
javax.ejb.EJBException
java.util.Set getExcludeAssetDestinations() throws javax.ejb.EJBException
Set
javax.ejb.EJBException
void setExcludeAssetDestinations(java.util.Set value) throws javax.ejb.EJBException
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.value
- Set
javax.ejb.EJBException
java.lang.String getId() throws javax.ejb.EJBException
String
javax.ejb.EJBException
void setId(java.lang.String value) throws javax.ejb.EJBException
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.value
- String
javax.ejb.EJBException
java.util.Set getIncludeAssetDestinations() throws javax.ejb.EJBException
Set
javax.ejb.EJBException
void setIncludeAssetDestinations(java.util.Set value) throws javax.ejb.EJBException
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.value
- Set
javax.ejb.EJBException
java.util.Set getPrincipalAssets() throws javax.ejb.EJBException
Set
javax.ejb.EJBException
void setPrincipalAssets(java.util.Set value) throws javax.ejb.EJBException
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.value
- Set
javax.ejb.EJBException
AgentDef getSurrogateFor() throws javax.ejb.EJBException
AgentDef
javax.ejb.EJBException
void setSurrogateFor(AgentDef value) throws javax.ejb.EJBException
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.value
- AgentDef
javax.ejb.EJBException
TransportDef getTransport() throws javax.ejb.EJBException
TransportDef
javax.ejb.EJBException
void setTransport(TransportDef value) throws javax.ejb.EJBException
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.value
- TransportDef
javax.ejb.EJBException
int getVersion() throws javax.ejb.EJBException
javax.ejb.EJBException
boolean getHasVersion() throws javax.ejb.EJBException
javax.ejb.EJBException
boolean isRemoved() throws javax.ejb.EJBException
javax.ejb.EJBException
void copyTo(AgentDef destination) throws javax.ejb.EJBException
javax.ejb.EJBException
void writeInstance() throws javax.ejb.EJBException
javax.ejb.EJBException
void prepareInstanceForWrite() throws javax.ejb.EJBException
javax.ejb.EJBException
boolean _isMutable()