atg.svc.repository.beans
Interface MarketingItem

All Superinterfaces:

javax.ejb.EJBLocalObject

All Known Implementing Classes:

_MarketingItem_BeanImpl, _MarketingItem_Impl, _MarketingItem_ReposImpl

public interface MarketingItem
extends javax.ejb.EJBLocalObject

Class MarketingItem ("Marketing Item")

• Home: MarketingItemHome
• 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
description	String		R, W, Cch, Qry
enddate	Date		R, W, Cch, Qry, Req
id	String		R, W, Cch, Id, Qry, Req
imageUrl	String		R, W, Cch, Qry
linkTarget	String		R, W, Cch, Qry
linkUrl	String		R, W, Cch, Qry
name	String		R, W, Cch, Qry, Req
segments	Set	name of the marketing segments associated with the marketing item	R, W, Cch, CoM, Mv, Qry
startdate	Date		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 description: String

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

Property enddate: Date

• Getter: getEnddate()
• Setter: setEnddate(java.util.Date)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: date
• Sort String: enddate

Property id: String

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

Property imageUrl: String

• Getter: getImageUrl()
• Setter: setImageUrl(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: imageurl

Property linkTarget: String

• Getter: getLinkTarget()
• Setter: setLinkTarget(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: linktarget

Property linkUrl: String

• Getter: getLinkUrl()
• Setter: setLinkUrl(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: linkurl

Property name: String

• Getter: getName()
• Setter: setName(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: name

Property segments: Set

name of the marketing segments associated with the marketing item
• Getter: getSegments()
• Setter: setSegments(java.util.Set)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: []
• Type Name: set
• Sort String: segments

Property startdate: Date

• Getter: getStartdate()
• Setter: setStartdate(java.util.Date)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: date
• Sort String: startdate

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(MarketingItem destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getDescription() Getter for property description
java.util.Date	getEnddate() Getter for property enddate
java.lang.String	getId() Getter for property id
java.lang.String	getImageUrl() Getter for property imageUrl
java.lang.String	getLinkTarget() Getter for property linkTarget
java.lang.String	getLinkUrl() Getter for property linkUrl
java.lang.String	getName() Getter for property name
java.util.Set	getSegments() Getter for property segments
java.util.Date	getStartdate() Getter for property startdate
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	setDescription(java.lang.String value) Setter for property description .
void	setEnddate(java.util.Date value) Setter for property enddate .
void	setId(java.lang.String value) Setter for property id .
void	setImageUrl(java.lang.String value) Setter for property imageUrl .
void	setLinkTarget(java.lang.String value) Setter for property linkTarget .
void	setLinkUrl(java.lang.String value) Setter for property linkUrl .
void	setName(java.lang.String value) Setter for property name .
void	setSegments(java.util.Set value) Setter for property segments .
void	setStartdate(java.util.Date value) Setter for property startdate .
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

getDescription

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

Getter for property description

Returns:

String

Throws:

javax.ejb.EJBException

setDescription

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

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

getEnddate

java.util.Date getEnddate()
                          throws javax.ejb.EJBException

Getter for property enddate

Returns:

Date

Throws:

javax.ejb.EJBException

setEnddate

void setEnddate(java.util.Date value)
                throws javax.ejb.EJBException

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

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

getImageUrl

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

Getter for property imageUrl

Returns:

String

Throws:

javax.ejb.EJBException

setImageUrl

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

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

getLinkTarget

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

Getter for property linkTarget

Returns:

String

Throws:

javax.ejb.EJBException

setLinkTarget

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

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

getLinkUrl

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

Getter for property linkUrl

Returns:

String

Throws:

javax.ejb.EJBException

setLinkUrl

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

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

getName

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

Getter for property name

Returns:

String

Throws:

javax.ejb.EJBException

setName

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

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

getSegments

java.util.Set getSegments()
                          throws javax.ejb.EJBException

Getter for property segments

Returns:

Set

Throws:

javax.ejb.EJBException

setSegments

void setSegments(java.util.Set value)
                 throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getStartdate

java.util.Date getStartdate()
                            throws javax.ejb.EJBException

Getter for property startdate

Returns:

Date

Throws:

javax.ejb.EJBException

setStartdate

void setStartdate(java.util.Date value)
                  throws javax.ejb.EJBException

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

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