atg.epub.project
Interface History

All Superinterfaces:

javax.ejb.EJBLocalObject

public interface History
extends javax.ejb.EJBLocalObject

Class History

• Home: HistoryHome
• 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	[:project.history, :process.history]
  resourceBundle	atg.epub.PublishingRepositoryResources

Property Summaries

Property Name	Property Type	Property Description	Flags
action	String	Action	R, W, Cch, Qry
actionParams	List	Action parameters	R, W, Cch, CoM, Mv, Qry
actionType	String	Action type	R, W, Cch, Qry
description	String	Description	R, W, Cch, Qry
id	String	History id	R, W, Cch, Id, Qry, Exp
profile	RepositoryItem	User	R, W, Cch, Qry
timestamp	Timestamp	Timestamp	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 action ("Action"): String

• Getter: getAction()
• Setter: setAction(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: action
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property actionParams ("Action parameters"): List

• Getter: getActionParams()
• Setter: setActionParams(java.util.List)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: list
• Sort String: actionparams ("action parameters")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property actionType ("Action type"): String

• Getter: getActionType()
• Setter: setActionType(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: actiontype ("action type")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property description ("Description"): String

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

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property id ("History id"): String

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

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property profile ("User"): RepositoryItem

• Getter: getProfile()
• Setter: setProfile(atg.repository.RepositoryItem)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: profile ("user")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property timestamp ("Timestamp"): Timestamp

• Getter: getTimestamp()
• Setter: setTimestamp(java.sql.Timestamp)
• Flags: readable, writable, cacheable, queryable
• Default Value: 2011-03-29 20:36:14.567
• Type Name: timestamp
• Sort String: timestamp
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(History destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getAction() Getter for property action ("Action")
java.util.List	getActionParams() Getter for property actionParams ("Action parameters")
java.lang.String	getActionType() Getter for property actionType ("Action type")
java.lang.String	getDescription() Getter for property description ("Description")
java.lang.String	getId() Getter for property id ("History id")
RepositoryItem	getProfile() Getter for property profile ("User")
java.sql.Timestamp	getTimestamp() Getter for property timestamp ("Timestamp")
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	setAction(java.lang.String value) Setter for property action ("Action").
void	setActionParams(java.util.List value) Setter for property actionParams ("Action parameters").
void	setActionType(java.lang.String value) Setter for property actionType ("Action type").
void	setDescription(java.lang.String value) Setter for property description ("Description").
void	setId(java.lang.String value) Setter for property id ("History id").
void	setProfile(RepositoryItem value) Setter for property profile ("User").
void	setTimestamp(java.sql.Timestamp value) Setter for property timestamp ("Timestamp").
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

getAction

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

Getter for property action ("Action")

Returns:

String

Throws:

javax.ejb.EJBException

setAction

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

Setter for property action ("Action"). 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

getActionParams

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

Getter for property actionParams ("Action parameters")

Returns:

List

Throws:

javax.ejb.EJBException

setActionParams

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

Setter for property actionParams ("Action parameters"). 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

Throws:

javax.ejb.EJBException

getActionType

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

Getter for property actionType ("Action type")

Returns:

String

Throws:

javax.ejb.EJBException

setActionType

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

Setter for property actionType ("Action 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 - String

Throws:

javax.ejb.EJBException

getDescription

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

Getter for property description ("Description")

Returns:

String

Throws:

javax.ejb.EJBException

setDescription

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

Setter for property description ("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 ("History id")

Returns:

String

Throws:

javax.ejb.EJBException

setId

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

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

getProfile

RepositoryItem getProfile()
                          throws javax.ejb.EJBException

Getter for property profile ("User")

Returns:

RepositoryItem

Throws:

javax.ejb.EJBException

setProfile

void setProfile(RepositoryItem value)
                throws javax.ejb.EJBException

Setter for property profile ("User"). 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 - RepositoryItem

Throws:

javax.ejb.EJBException

getTimestamp

java.sql.Timestamp getTimestamp()
                                throws javax.ejb.EJBException

Getter for property timestamp ("Timestamp")

Returns:

Timestamp

Throws:

javax.ejb.EJBException

setTimestamp

void setTimestamp(java.sql.Timestamp value)
                  throws javax.ejb.EJBException

Setter for property timestamp ("Timestamp"). 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 - Timestamp

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