atg.epub.project

Interface TopologyDef

All Superinterfaces:

javax.ejb.EJBLocalObject

public interface TopologyDef
extends javax.ejb.EJBLocalObject

Class TopologyDef ("Deployment Topology Definition")

• Home: TopologyDefHome
• 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
  resourceBundle	atg.epub.PublishingRepositoryResources
  uiwritable	false

Property Summaries

Property Name	Property Type	Property Description	Flags
id	String	Topology ID	R, W, Cch, Id, Qry, Exp
primary	boolean	Is primary topology ?	R, W, Cch, Qry, Exp
targets	List of TargetDef	Definition of Targets associated with this topology	R, W, Cch, CoM, Mv, 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 id ("Topology ID"): String

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

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property primary ("Is primary topology ?"): boolean

• Getter: isPrimary()
• Setter: setPrimary(boolean)
• Flags: readable, writable, cacheable, queryable, expert
• Default Value: false
• Type Name: boolean
• Sort String: primary ("is primary topology ?")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property targets ("Definition of Targets associated with this topology"): List of TargetDef

• Getter: getTargets()
• Setter: setTargets(java.util.List)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: list
• Sort String: targets ("definition of targets associated with this topology")
• 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

Modifier and Type	Method and Description
boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(TopologyDef destination) Copies the property values of this instance to another instance of the same data type.
boolean	getHasPrimary() Returns true if the value of property primary is null.
boolean	getHasVersion() Returns true if the value of property version is null.
java.lang.String	getId() Getter for property id ("Topology ID")
java.util.List	getTargets() Getter for property targets ("Definition of Targets associated with this topology")
int	getVersion() Getter for property version ("Version")
boolean	isPrimary() Getter for property primary ("Is primary topology ?")
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	setHasPrimary(boolean value) If this is set to false, then the underlying value of property primary is set to null.
void	setId(java.lang.String value) Setter for property id ("Topology ID").
void	setPrimary(boolean value) Setter for property primary ("Is primary topology ?").
void	setTargets(java.util.List value) Setter for property targets ("Definition of Targets associated with this topology").
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

getId

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

Getter for property id ("Topology ID")

Returns:

String

Throws:

javax.ejb.EJBException

setId

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

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

isPrimary

boolean isPrimary()
           throws javax.ejb.EJBException

Getter for property primary ("Is primary topology ?")

Returns:

boolean

Throws:

javax.ejb.EJBException

getHasPrimary

boolean getHasPrimary()
               throws javax.ejb.EJBException

Returns true if the value of property primary is null.

Throws:

javax.ejb.EJBException

setPrimary

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

Setter for property primary ("Is primary topology ?"). 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

setHasPrimary

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

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

Throws:

javax.ejb.EJBException

getTargets

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

Getter for property targets ("Definition of Targets associated with this topology")

Returns:

List of TargetDef

Throws:

javax.ejb.EJBException

setTargets

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

Setter for property targets ("Definition of Targets associated with this topology"). 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 of TargetDef

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