atg.epub.project

Interface ReadOnlyProject

All Superinterfaces:

javax.ejb.EJBLocalObject

public interface ReadOnlyProject
extends javax.ejb.EJBLocalObject

Class ReadOnlyProject ("Readonly Project")

• Home: ReadOnlyProjectHome
• Flags: expert, hidden
• 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	30
  categoryStatusPriority	20
  resourceBundle	atg.epub.PublishingRepositoryResources

Property Summaries

Property Name	Property Type	Property Description	Flags
completionDate	Timestamp	Completion date	R, Cch, Qry
displayName	String	Name	R, Cch, Qry
editable	boolean	Editable	R, Cch, Qry
id	String	Project id	R, Cch, Id, 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 completionDate ("Completion date"): Timestamp

• Getter: getCompletionDate()
• Flags: readable, cacheable, queryable
• Type Name: timestamp
• Sort String: completiondate ("completion date")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property displayName ("Name"): String

• Getter: getDisplayName()
• Flags: readable, cacheable, queryable
• Type Name: string
• Sort String: displayname ("name")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property editable ("Editable"): boolean

• Getter: isEditable()
• Flags: readable, cacheable, queryable
• Type Name: boolean
• Sort String: editable
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property id ("Project id"): String

• Getter: getId()
• Flags: readable, cacheable, idProperty, queryable, expert
• Type Name: string
• Sort String: id ("project id")
• 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(ReadOnlyProject destination) Copies the property values of this instance to another instance of the same data type.
java.sql.Timestamp	getCompletionDate() Getter for property completionDate ("Completion date")
java.lang.String	getDisplayName() Getter for property displayName ("Name")
boolean	getHasEditable() Returns true if the value of property editable is null.
java.lang.String	getId() Getter for property id ("Project id")
boolean	isEditable() Getter for property editable ("Editable")
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	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

getCompletionDate

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

Getter for property completionDate ("Completion date")

Returns:

Timestamp

Throws:

javax.ejb.EJBException

getDisplayName

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

Getter for property displayName ("Name")

Returns:

String

Throws:

javax.ejb.EJBException

isEditable

boolean isEditable()
            throws javax.ejb.EJBException

Getter for property editable ("Editable")

Returns:

boolean

Throws:

javax.ejb.EJBException

getHasEditable

boolean getHasEditable()
                throws javax.ejb.EJBException

Returns true if the value of property editable is null.

Throws:

javax.ejb.EJBException

getId

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

Getter for property id ("Project id")

Returns:

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