atg.svc.repository.beans
Interface Favorites

All Superinterfaces:

javax.ejb.EJBLocalObject

All Known Implementing Classes:

_Favorites_BeanImpl, _Favorites_Impl, _Favorites_ReposImpl

public interface Favorites
extends javax.ejb.EJBLocalObject

Class Favorites

• Home: FavoritesHome
• 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
URL	String		R, W, Cch, Qry
contextId	String		R, W, Cch, Qry
id	String		R, W, Cch, Id, Qry, Req
solutionId	String		R, W, Cch, Qry
title	String		R, W, Cch, Qry, Req
type	FavoritesType		R, W, Cch, Qry, Req
userId	String		R, W, Cch, Qry, Req

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

• Getter: getURL()
• Setter: setURL(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: url

Property contextId: String

• Getter: getContextId()
• Setter: setContextId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: contextid

Property id: String

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

Property solutionId: String

• Getter: getSolutionId()
• Setter: setSolutionId(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: solutionid

Property title: String

• Getter: getTitle()
• Setter: setTitle(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: title

Property type: FavoritesType

• Getter: getType()
• Setter: setType(atg.svc.repository.beans.FavoritesType)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: type
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property userId: String

• Getter: getUserId()
• Setter: setUserId(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: userid

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(Favorites destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getContextId() Getter for property contextId
java.lang.String	getId() Getter for property id
java.lang.String	getSolutionId() Getter for property solutionId
java.lang.String	getTitle() Getter for property title
FavoritesType	getType() Getter for property type
java.lang.String	getURL() Getter for property URL
java.lang.String	getUserId() Getter for property userId
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	setContextId(java.lang.String value) Setter for property contextId .
void	setId(java.lang.String value) Setter for property id .
void	setSolutionId(java.lang.String value) Setter for property solutionId .
void	setTitle(java.lang.String value) Setter for property title .
void	setType(FavoritesType value) Setter for property type .
void	setURL(java.lang.String value) Setter for property URL .
void	setUserId(java.lang.String value) Setter for property userId .
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

getURL

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

Getter for property URL

Returns:

String

Throws:

javax.ejb.EJBException

setURL

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

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

getContextId

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

Getter for property contextId

Returns:

String

Throws:

javax.ejb.EJBException

setContextId

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

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

getSolutionId

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

Getter for property solutionId

Returns:

String

Throws:

javax.ejb.EJBException

setSolutionId

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

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

getTitle

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

Getter for property title

Returns:

String

Throws:

javax.ejb.EJBException

setTitle

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

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

getType

FavoritesType getType()
                      throws javax.ejb.EJBException

Getter for property type

Returns:

FavoritesType

Throws:

javax.ejb.EJBException

setType

void setType(FavoritesType value)
             throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getUserId

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

Getter for property userId

Returns:

String

Throws:

javax.ejb.EJBException

setUserId

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

Setter for property userId . 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(Favorites 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.