atg.svc.repository.beans
Interface OptionSegment

All Superinterfaces:

javax.ejb.EJBLocalObject

All Known Implementing Classes:

_OptionSegment_BeanImpl, _OptionSegment_Impl, _OptionSegment_ReposImpl

public interface OptionSegment
extends javax.ejb.EJBLocalObject

Class OptionSegment

• Home: OptionSegmentHome
• 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
default	boolean		R, W, Cch, Qry, Req
id	String		R, W, Cch, Id, Qry, Req
name	String		R, W, Cch, Qry, Req
priority	int		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 default: boolean

• Getter: isDefault()
• Setter: setDefault(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Default Value: false
• Type Name: boolean
• Sort String: default

Property id: String

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

Property name: String

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

Property priority: int

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

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(OptionSegment destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getId() Getter for property id
java.lang.String	getName() Getter for property name
int	getPriority() Getter for property priority
boolean	isDefault() Getter for property default
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	setDefault(boolean value) Setter for property default .
void	setId(java.lang.String value) Setter for property id .
void	setName(java.lang.String value) Setter for property name .
void	setPriority(int value) Setter for property priority .
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

isDefault

boolean isDefault()
                  throws javax.ejb.EJBException

Getter for property default

Returns:

boolean

Throws:

javax.ejb.EJBException

setDefault

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

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

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

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

getPriority

int getPriority()
                throws javax.ejb.EJBException

Getter for property priority

Returns:

int

Throws:

javax.ejb.EJBException

setPriority

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

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

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