atg.svc.repository.beans
Interface SkinConfig

All Superinterfaces:

ConfigurationObject, javax.ejb.EJBLocalObject

All Known Implementing Classes:

_SkinConfig_BeanImpl, _SkinConfig_Impl, _SkinConfig_ReposImpl

public interface SkinConfig
extends javax.ejb.EJBLocalObject, ConfigurationObject

Class SkinConfig

• Home: SkinConfigHome
• 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
configType	ConfigurationObjectConfigType		R, W, Cch, Qry, Req
enabledYn	boolean		R, W, Cch, Qry, Req
id	String		R, W, Cch, Id, Qry, Req
skinId	String		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 configType: ConfigurationObjectConfigType

• Getter: ConfigurationObject.getConfigType()
• Setter: ConfigurationObject.setConfigType(atg.svc.repository.beans.ConfigurationObjectConfigType)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: configtype
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Property enabledYn: boolean

• Getter: ConfigurationObject.isEnabledYn()
• Setter: ConfigurationObject.setEnabledYn(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: boolean
• Sort String: enabledyn

Property id: String

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

Property skinId: String

• Getter: getSkinId()
• Setter: setSkinId(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: skinid

Property userId: String

• Getter: ConfigurationObject.getUserId()
• Setter: ConfigurationObject.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(SkinConfig 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	getSkinId() Getter for property skinId
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	setId(java.lang.String value) Setter for property id .
void	setSkinId(java.lang.String value) Setter for property skinId .
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 atg.svc.repository.beans.ConfigurationObject

copyTo, getConfigType, getUserId, isEnabledYn, setConfigType, setEnabledYn, setUserId

Method Detail

getId

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

Getter for property id

Specified by:

getId in interface ConfigurationObject

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.

Specified by:

setId in interface ConfigurationObject

Parameters:

value - String

Throws:

javax.ejb.EJBException

getSkinId

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

Getter for property skinId

Returns:

String

Throws:

javax.ejb.EJBException

setSkinId

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

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

Specified by:

isRemoved in interface ConfigurationObject

Throws:

javax.ejb.EJBException

copyTo

void copyTo(SkinConfig 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.

Specified by:

writeInstance in interface ConfigurationObject

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.

Specified by:

prepareInstanceForWrite in interface ConfigurationObject

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.

Specified by:

_isMutable in interface ConfigurationObject