atg.svc.repository.beans
Interface WindowAttribute

All Superinterfaces:

javax.ejb.EJBLocalObject

public interface WindowAttribute
extends javax.ejb.EJBLocalObject

Class WindowAttribute

• Home: WindowAttributeHome
• 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

Property Summaries

Property Name	Property Type	Property Description	Flags
id	String		R, W, Cch, Id, Qry, Req
key	String		R, W, Cch, Qry, Req
serializedData	byte[]		R, W, Cch, Qry
sessionId	String		R, W, Cch, Qry, Req
windowId	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 id: String

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

Property key: String

• Getter: getKey()
• Setter: setKey(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: key

Property serializedData: byte[]

• Getter: getSerializedData()
• Setter: setSerializedData(byte[])
• Flags: readable, writable, cacheable, queryable
• Type Name: binary
• Sort String: serializeddata

Property sessionId: String

• Getter: getSessionId()
• Setter: setSessionId(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: sessionid

Property windowId: String

• Getter: getWindowId()
• Setter: setWindowId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: windowid

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(WindowAttribute destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getId() Getter for property id
java.lang.String	getKey() Getter for property key
byte[]	getSerializedData() Getter for property serializedData
java.lang.String	getSessionId() Getter for property sessionId
java.lang.Object	getValue() Gets the value of the attribute as an Object.
java.lang.String	getWindowId() Getter for property windowId
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 .
void	setKey(java.lang.String value) Setter for property key .
void	setSerializedData(byte[] value) Setter for property serializedData .
void	setSessionId(java.lang.String value) Setter for property sessionId .
void	setValue(java.lang.Object value) Set the value of the attribute as an Object.
void	setWindowId(java.lang.String value) Setter for property windowId .
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

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

getKey

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

Getter for property key

Returns:

String

Throws:

javax.ejb.EJBException

setKey

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

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

getSerializedData

byte[] getSerializedData()
                         throws javax.ejb.EJBException

Getter for property serializedData

Returns:

byte[]

Throws:

javax.ejb.EJBException

setSerializedData

void setSerializedData(byte[] value)
                       throws javax.ejb.EJBException

Setter for property serializedData . 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 - byte[]

Throws:

javax.ejb.EJBException

getSessionId

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

Getter for property sessionId

Returns:

String

Throws:

javax.ejb.EJBException

setSessionId

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

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

getWindowId

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

Getter for property windowId

Returns:

String

Throws:

javax.ejb.EJBException

setWindowId

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

Setter for property windowId . 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(WindowAttribute 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.

getValue

java.lang.Object getValue()
                          throws javax.ejb.EJBException

Gets the value of the attribute as an Object.

Throws:

javax.ejb.EJBException - A system-level error occurred

setValue

void setValue(java.lang.Object value)
              throws javax.ejb.EJBException

Set the value of the attribute as an Object.

Parameters:

value -

Throws:

javax.ejb.EJBException - A system-level error occurred