atg.svc.repository.beans
Interface Renderer

All Superinterfaces:

javax.ejb.EJBLocalObject

All Known Implementing Classes:

_Renderer_BeanImpl, _Renderer_Impl, _Renderer_ReposImpl

public interface Renderer
extends javax.ejb.EJBLocalObject

Class Renderer

• Home: RendererHome
• 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
  references	[:SlotRendererCombo.renderer]

Property Summaries

Property Name	Property Type	Property Description	Flags
description	String		R, W, Cch, Qry
id	String		R, W, Cch, Id, Qry, Req
itemDescriptor	String		R, W, Cch, Qry
name	String		R, W, Cch, Qry
path	String		R, W, Cch, Qry
repositoryName	String		R, W, Cch, Qry

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 description: String

• Getter: getDescription()
• Setter: setDescription(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: description

Property id: String

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

Property itemDescriptor: String

• Getter: getItemDescriptor()
• Setter: setItemDescriptor(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: itemdescriptor

Property name: String

• Getter: getName()
• Setter: setName(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: name

Property path: String

• Getter: getPath()
• Setter: setPath(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: path

Property repositoryName: String

• Getter: getRepositoryName()
• Setter: setRepositoryName(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: repositoryname

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(Renderer destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getDescription() Getter for property description
java.lang.String	getId() Getter for property id
java.lang.String	getItemDescriptor() Getter for property itemDescriptor
java.lang.String	getName() Getter for property name
java.lang.String	getPath() Getter for property path
java.lang.String	getRepositoryName() Getter for property repositoryName
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	setDescription(java.lang.String value) Setter for property description .
void	setId(java.lang.String value) Setter for property id .
void	setItemDescriptor(java.lang.String value) Setter for property itemDescriptor .
void	setName(java.lang.String value) Setter for property name .
void	setPath(java.lang.String value) Setter for property path .
void	setRepositoryName(java.lang.String value) Setter for property repositoryName .
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

getDescription

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

Getter for property description

Returns:

String

Throws:

javax.ejb.EJBException

setDescription

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

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

getId

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

Getter for property id

Returns:

String

Throws:

javax.ejb.EJBException

setId

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

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

getItemDescriptor

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

Getter for property itemDescriptor

Returns:

String

Throws:

javax.ejb.EJBException

setItemDescriptor

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

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

getName

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

Getter for property name

Returns:

String

Throws:

javax.ejb.EJBException

setName

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

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

getPath

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

Getter for property path

Returns:

String

Throws:

javax.ejb.EJBException

setPath

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

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

getRepositoryName

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

Getter for property repositoryName

Returns:

String

Throws:

javax.ejb.EJBException

setRepositoryName

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

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

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