atg.epub.project

Interface ProcessTaskInfo

All Superinterfaces:

javax.ejb.EJBLocalObject

public interface ProcessTaskInfo
extends javax.ejb.EJBLocalObject

Class ProcessTaskInfo ("Process task information")

• Home: ProcessTaskInfoHome
• 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	[:process.taskInfos]
  resourceBundle	atg.epub.PublishingRepositoryResources

Property Summaries

Property Name	Property Type	Property Description	Flags
acl	String	Runtime access control list	R, W, Cch, Qry
id	String	Task information id	R, W, Cch, Id, Qry
lastActionDate	Timestamp	Last action date	R, W, Cch, Qry
lastActorName	String	Last actor	R, W, Cch, Qry
lastOutcomeElementId	String	Last outcome	R, W, Cch, Qry
ownerName	String	Owner	R, W, Cch, Qry
priority	int	Priority	R, W, Cch, Qry
process	Process	Process id	R, W, Cch, Qry, Req
processName	String	Process name	R, W, Cch, Qry
segmentName	String	Segment name	R, W, Cch, Qry
taskElementId	String	Task element id	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 acl ("Runtime access control list"): String

• Getter: getAcl()
• Setter: setAcl(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: big string
• Sort String: acl ("runtime access control list")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property id ("Task information id"): String

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

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property lastActionDate ("Last action date"): Timestamp

• Getter: getLastActionDate()
• Setter: setLastActionDate(java.sql.Timestamp)
• Flags: readable, writable, cacheable, queryable
• Type Name: timestamp
• Sort String: lastactiondate ("last action date")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property lastActorName ("Last actor"): String

• Getter: getLastActorName()
• Setter: setLastActorName(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: lastactorname ("last actor")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property lastOutcomeElementId ("Last outcome"): String

• Getter: getLastOutcomeElementId()
• Setter: setLastOutcomeElementId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: lastoutcomeelementid ("last outcome")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property ownerName ("Owner"): String

• Getter: getOwnerName()
• Setter: setOwnerName(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: ownername ("owner")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property priority ("Priority"): int

• Getter: getPriority()
• Setter: setPriority(int)
• Flags: readable, writable, cacheable, queryable
• Type Name: int
• Sort String: priority
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property process ("Process id"): Process

• Getter: getProcess()
• Setter: setProcess(atg.epub.project.Process)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: process ("process id")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property processName ("Process name"): String

• Getter: getProcessName()
• Setter: setProcessName(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: processname ("process name")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property segmentName ("Segment name"): String

• Getter: getSegmentName()
• Setter: setSegmentName(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: segmentname ("segment name")
• Attributes:

  Attribute Name	Attribute Value
  resourceBundle	atg.epub.PublishingRepositoryResources

Property taskElementId ("Task element id"): String

• Getter: getTaskElementId()
• Setter: setTaskElementId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: taskelementid ("task element id")
• 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

Methods

Modifier and Type	Method and Description
boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(ProcessTaskInfo destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getAcl() Getter for property acl ("Runtime access control list")
boolean	getHasPriority() Returns true if the value of property priority is null.
boolean	getHasVersion() Returns true if the value of property version is null.
java.lang.String	getId() Getter for property id ("Task information id")
java.sql.Timestamp	getLastActionDate() Getter for property lastActionDate ("Last action date")
java.lang.String	getLastActorName() Getter for property lastActorName ("Last actor")
java.lang.String	getLastOutcomeElementId() Getter for property lastOutcomeElementId ("Last outcome")
java.lang.String	getOwnerName() Getter for property ownerName ("Owner")
int	getPriority() Getter for property priority ("Priority")
Process	getProcess() Getter for property process ("Process id")
java.lang.String	getProcessName() Getter for property processName ("Process name")
java.lang.String	getSegmentName() Getter for property segmentName ("Segment name")
java.lang.String	getTaskElementId() Getter for property taskElementId ("Task element id")
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	setAcl(java.lang.String value) Setter for property acl ("Runtime access control list").
void	setHasPriority(boolean value) If this is set to false, then the underlying value of property priority is set to null.
void	setId(java.lang.String value) Setter for property id ("Task information id").
void	setLastActionDate(java.sql.Timestamp value) Setter for property lastActionDate ("Last action date").
void	setLastActorName(java.lang.String value) Setter for property lastActorName ("Last actor").
void	setLastOutcomeElementId(java.lang.String value) Setter for property lastOutcomeElementId ("Last outcome").
void	setOwnerName(java.lang.String value) Setter for property ownerName ("Owner").
void	setPriority(int value) Setter for property priority ("Priority").
void	setProcess(Process value) Setter for property process ("Process id").
void	setProcessName(java.lang.String value) Setter for property processName ("Process name").
void	setSegmentName(java.lang.String value) Setter for property segmentName ("Segment name").
void	setTaskElementId(java.lang.String value) Setter for property taskElementId ("Task element id").
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

getAcl

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

Getter for property acl ("Runtime access control list")

Returns:

String

Throws:

javax.ejb.EJBException

setAcl

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

Setter for property acl ("Runtime access control list"). 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 ("Task information id")

Returns:

String

Throws:

javax.ejb.EJBException

setId

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

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

getLastActionDate

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

Getter for property lastActionDate ("Last action date")

Returns:

Timestamp

Throws:

javax.ejb.EJBException

setLastActionDate

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

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

getLastActorName

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

Getter for property lastActorName ("Last actor")

Returns:

String

Throws:

javax.ejb.EJBException

setLastActorName

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

Setter for property lastActorName ("Last actor"). 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

getLastOutcomeElementId

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

Getter for property lastOutcomeElementId ("Last outcome")

Returns:

String

Throws:

javax.ejb.EJBException

setLastOutcomeElementId

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

Setter for property lastOutcomeElementId ("Last outcome"). 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

getOwnerName

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

Getter for property ownerName ("Owner")

Returns:

String

Throws:

javax.ejb.EJBException

setOwnerName

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

Setter for property ownerName ("Owner"). 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

getPriority

int getPriority()
                throws javax.ejb.EJBException

Getter for property priority ("Priority")

Returns:

int

Throws:

javax.ejb.EJBException

getHasPriority

boolean getHasPriority()
                       throws javax.ejb.EJBException

Returns true if the value of property priority is null.

Throws:

javax.ejb.EJBException

setPriority

void setPriority(int value)
                 throws javax.ejb.EJBException

Setter for property priority ("Priority"). 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 - int

Throws:

javax.ejb.EJBException

setHasPriority

void setHasPriority(boolean value)
                    throws javax.ejb.EJBException

If this is set to false, then the underlying value of property priority is set to null. If set to true, then nothing is done.

Throws:

javax.ejb.EJBException

getProcess

Process getProcess()
                   throws javax.ejb.EJBException

Getter for property process ("Process id")

Returns:

Process

Throws:

javax.ejb.EJBException

setProcess

void setProcess(Process value)
                throws javax.ejb.EJBException

Setter for property process ("Process 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 - Process

Throws:

javax.ejb.EJBException

getProcessName

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

Getter for property processName ("Process name")

Returns:

String

Throws:

javax.ejb.EJBException

setProcessName

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

Setter for property processName ("Process 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

getSegmentName

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

Getter for property segmentName ("Segment name")

Returns:

String

Throws:

javax.ejb.EJBException

setSegmentName

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

Setter for property segmentName ("Segment 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

getTaskElementId

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

Getter for property taskElementId ("Task element id")

Returns:

String

Throws:

javax.ejb.EJBException

setTaskElementId

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

Setter for property taskElementId ("Task element 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

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