atg.svc.repository.beans
Interface UserOption

All Superinterfaces:

javax.ejb.EJBLocalObject, atg.svc.repository.beans.Option

public interface UserOption
extends javax.ejb.EJBLocalObject, atg.svc.repository.beans.Option

Class UserOption

A user preference.

• Home: UserOptionHome
• 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
accessRight	String		R, W, Cch, Qry
allowedValues	String[]		R, W, Cch, Mv, Qry
dataType	UserOptionDataType		R, W, Cch, Qry
defaultValue	String	value to user when none has been input by the user	R, W, Cch, Qry
id	String		R, W, Cch, Id, Qry, Req
info	Map		R, W, Cch, CoM, Mv, Qry
multiValued	boolean	true if the value represent multiple values	R, W, Cch, Qry
name	String	unique logical name of the option	R, W, Cch, Qry, Req
rawValue	String	value input by the user	R, W, Cch, Qry
userId	String	the user associated with the option	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 accessRight: String

• Getter: getAccessRight()
• Setter: setAccessRight(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: accessright

Property allowedValues: String[]

• Getter: getAllowedValues()
• Setter: setAllowedValues(java.lang.String[])
• Flags: readable, writable, cacheable, multivalued, queryable
• Default Value: [Ljava.lang.String;@110278e
• Type Name: array
• Sort String: allowedvalues

Property dataType: UserOptionDataType

• Getter: getDataType()
• Setter: setDataType(atg.svc.repository.beans.UserOptionDataType)
• Flags: readable, writable, cacheable, queryable
• Type Name: enumerated
• Sort String: datatype
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property defaultValue: String

value to user when none has been input by the user
• Getter: getDefaultValue()
• Setter: setDefaultValue(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: defaultvalue

Property id: String

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

Property info: Map

• Getter: getInfo()
• Setter: setInfo(java.util.Map)
• Flags: readable, writable, cacheable, collectionOrMap, multivalued, queryable
• Default Value: {}
• Type Name: map
• Sort String: info

Property multiValued: boolean

true if the value represent multiple values
• Getter: isMultiValued()
• Setter: setMultiValued(boolean)
• Flags: readable, writable, cacheable, queryable
• Type Name: boolean
• Sort String: multivalued

Property name: String

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

Property rawValue: String

value input by the user
• Getter: getRawValue()
• Setter: setRawValue(java.lang.String)
• Flags: readable, writable, cacheable, queryable
• Type Name: string
• Sort String: rawvalue

Property userId: String

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

Field Summary

Fields inherited from interface atg.svc.repository.beans.Option

CLASS_VERSION

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(UserOption destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getAccessRight() Getter for property accessRight
java.lang.String[]	getAllowedValues() Getter for property allowedValues
java.lang.String[]	getArrayValue() Gets the value of the option as an array of type String.
UserOptionDataType	getDataType() Getter for property dataType
java.lang.String	getDefaultValue() Getter for property defaultValue
boolean	getHasMultiValued() Returns true if the value of property multiValued is null.
java.lang.String	getId() Getter for property id
java.util.Map	getInfo() Getter for property info
java.lang.String	getName() Getter for property name
java.lang.String	getRawValue() Getter for property rawValue
java.lang.String	getUserId() Getter for property userId
java.lang.String	getValue() Gets the value of the option.
boolean	isMultiValued() Getter for property multiValued
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	setAccessRight(java.lang.String value) Setter for property accessRight .
void	setAllowedValues(java.lang.String[] value) Setter for property allowedValues .
void	setArrayValue(java.lang.String[] value) Set the value of the option as an array of type String.
void	setDataType(UserOptionDataType value) Setter for property dataType .
void	setDefaultValue(java.lang.String value) Setter for property defaultValue .
void	setHasMultiValued(boolean value) If this is set to false, then the underlying value of property multiValued is set to null.
void	setId(java.lang.String value) Setter for property id .
void	setInfo(java.util.Map value) Setter for property info .
void	setMultiValued(boolean value) Setter for property multiValued .
void	setName(java.lang.String value) Setter for property name .
void	setRawValue(java.lang.String value) Setter for property rawValue .
void	setUserId(java.lang.String value) Setter for property userId .
void	setValue(java.lang.String value) Sets the value on the option.
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

getAccessRight

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

Getter for property accessRight

Returns:

String

Throws:

javax.ejb.EJBException

setAccessRight

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

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

getAllowedValues

java.lang.String[] getAllowedValues()
                                    throws javax.ejb.EJBException

Getter for property allowedValues

Specified by:

getAllowedValues in interface atg.svc.repository.beans.Option

Returns:

String[]

Throws:

javax.ejb.EJBException

setAllowedValues

void setAllowedValues(java.lang.String[] value)
                      throws javax.ejb.EJBException

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

getDataType

UserOptionDataType getDataType()
                               throws javax.ejb.EJBException

Getter for property dataType

Returns:

UserOptionDataType

Throws:

javax.ejb.EJBException

setDataType

void setDataType(UserOptionDataType value)
                 throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

getDefaultValue

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

Getter for property defaultValue

Specified by:

getDefaultValue in interface atg.svc.repository.beans.Option

Returns:

String

Throws:

javax.ejb.EJBException

setDefaultValue

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

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

Specified by:

setDefaultValue in interface atg.svc.repository.beans.Option

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

getInfo

java.util.Map getInfo()
                      throws javax.ejb.EJBException

Getter for property info

Returns:

Map

Throws:

javax.ejb.EJBException

setInfo

void setInfo(java.util.Map value)
             throws javax.ejb.EJBException

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

Throws:

javax.ejb.EJBException

isMultiValued

boolean isMultiValued()
                      throws javax.ejb.EJBException

Getter for property multiValued

Returns:

boolean

Throws:

javax.ejb.EJBException

getHasMultiValued

boolean getHasMultiValued()
                          throws javax.ejb.EJBException

Returns true if the value of property multiValued is null.

Throws:

javax.ejb.EJBException

setMultiValued

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

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

setHasMultiValued

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

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

Throws:

javax.ejb.EJBException

getName

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

Getter for property name

Specified by:

getName in interface atg.svc.repository.beans.Option

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.

Specified by:

setName in interface atg.svc.repository.beans.Option

Parameters:

value - String

Throws:

javax.ejb.EJBException

getRawValue

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

Getter for property rawValue

Specified by:

getRawValue in interface atg.svc.repository.beans.Option

Returns:

String

Throws:

javax.ejb.EJBException

setRawValue

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

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

Specified by:

setRawValue in interface atg.svc.repository.beans.Option

Parameters:

value - String

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

getArrayValue

java.lang.String[] getArrayValue()
                                 throws javax.ejb.EJBException

Gets the value of the option as an array of type String.

Throws:

javax.ejb.EJBException - A system-level error occurred

setArrayValue

void setArrayValue(java.lang.String[] value)
                   throws javax.ejb.EJBException

Set the value of the option as an array of type String.

Parameters:

value -

Throws:

javax.ejb.EJBException - A system-level error occurred

setValue

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

Sets the value on the option.

Specified by:

setValue in interface atg.svc.repository.beans.Option

Parameters:

value -

Throws:

javax.ejb.EJBException - A system-level error occurred

getValue

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

Gets the value of the option.

Specified by:

getValue in interface atg.svc.repository.beans.Option

Returns:

The value of the option. If the raw value is null the default value is returned.

Throws:

javax.ejb.EJBException - A system-level error occurred