atg.epub.project

Interface TransportDef

All Superinterfaces:

javax.ejb.EJBLocalObject

public interface TransportDef
extends javax.ejb.EJBLocalObject

Class TransportDef ("Deployment Transport Definition")

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

Property Summaries

Property Name	Property Type	Property Description	Flags
id	String	Transport ID	R, W, Cch, Id, Qry, Exp
jndiName	String	JNDI Name	R, W, Cch, Qry
rmiURI	String	RMI URI	R, W, Cch, Qry
transportType	TransportDefEnumTransportType	Transport 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 id ("Transport ID"): String

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

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property jndiName ("JNDI Name"): String

• Getter: getJndiName()
• Setter: setJndiName(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: jndiname ("jndi name")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property rmiURI ("RMI URI"): String

• Getter: getRmiURI()
• Setter: setRmiURI(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: rmiuri ("rmi uri")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property transportType ("Transport Type"): TransportDefEnumTransportType

• Getter: getTransportType()
• Setter: setTransportType(atg.epub.project.TransportDefEnumTransportType)
• Flags: readable, writable, cacheable, queryable
• Default Value: RMI
• Type Name: enumerated
• Sort String: transporttype ("transport 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

Modifier and Type	Method and Description
boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(TransportDef destination) Copies the property values of this instance to another instance of the same data type.
boolean	getHasVersion() Returns true if the value of property version is null.
java.lang.String	getId() Getter for property id ("Transport ID")
java.lang.String	getJndiName() Getter for property jndiName ("JNDI Name")
java.lang.String	getRmiURI() Getter for property rmiURI ("RMI URI")
TransportDefEnumTransportType	getTransportType() Getter for property transportType ("Transport Type")
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	setId(java.lang.String value) Setter for property id ("Transport ID").
void	setJndiName(java.lang.String value) Setter for property jndiName ("JNDI Name").
void	setRmiURI(java.lang.String value) Setter for property rmiURI ("RMI URI").
void	setTransportType(TransportDefEnumTransportType value) Setter for property transportType ("Transport 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

getId

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

Getter for property id ("Transport ID")

Returns:

String

Throws:

javax.ejb.EJBException

setId

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

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

getJndiName

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

Getter for property jndiName ("JNDI Name")

Returns:

String

Throws:

javax.ejb.EJBException

setJndiName

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

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

getRmiURI

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

Getter for property rmiURI ("RMI URI")

Returns:

String

Throws:

javax.ejb.EJBException

setRmiURI

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

Setter for property rmiURI ("RMI URI"). 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

getTransportType

TransportDefEnumTransportType getTransportType()
                                        throws javax.ejb.EJBException

Getter for property transportType ("Transport Type")

Returns:

TransportDefEnumTransportType

Throws:

javax.ejb.EJBException

setTransportType

void setTransportType(TransportDefEnumTransportType value)
               throws javax.ejb.EJBException

Setter for property transportType ("Transport 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 - TransportDefEnumTransportType

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