oracle.ifs.core.tools.script.test.overrides.activity.smarthome

Class SmartHomeItemDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.ApplicationObjectDefinition

oracle.ifs.core.tools.script.test.overrides.activity.smarthome.SmartHomeItemDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class SmartHomeItemDefinition
extends ApplicationObjectDefinition

A SmartHomeItemDefinition is used to define SmartHomeItem instances.

Author:

Frank Closheim

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.beans.LibraryObjectDefinition

LibraryObjectDefinition.EnumToIntegerCode, LibraryObjectDefinition.LookupByName

Field Summary

Fields inherited from class oracle.ifs.beans.LibraryObjectDefinition

m_Attributes, m_ClassObjectName, m_ClassObjectValue, m_ContentSpecifications, m_DefinitionLists, m_Definitions, m_EnclosedDefinition, m_Id, m_Options, m_ReadOnly, m_ReferenceAttributes, m_Session, m_SystemOptions

Constructor Summary

Constructors

Constructor and Description
SmartHomeItemDefinition(LibrarySessionInterface session) Constructs a definition explicitly capturing the session.
SmartHomeItemDefinition(LibrarySessionInterface session, String className) Construct a definition explicitly capturing the session and setting the initial ClassObject name.

Method Summary

Modifier and Type	Method and Description
SmartHome	getSmartHome() Gets the SmartHome that this instance is associated with.
void	setSmartHome(SmartHome smarthome) Sets the SmartHome this SmartHomeItem will be associated with.
static SmartHomeItemDefinition	toSmartHomeItemDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a SmartHomeItemDefinition.
static SmartHomeItemDefinition	toSmartHomeItemDefinition(LibraryObjectDefinition lodef, boolean enforce) Cast specified LibraryObjectDefinition to a SmartHomeItemDefinition.

Methods inherited from class oracle.ifs.beans.PublicObjectDefinition

addCategoryDefinition, addCategoryDefinition, addCategoryDefinitions, addCategoryDefinitions, applySettings, getAddToFolderOption, getAddToFolderValue, getAutoFolderingActionSpecification, getCascadeCopyRelationshipsOption, getCascadeCopyRelationshipsOptionValue, getCategoryCopyOption, getCategoryDefinitions, getContentQuotaCopyOption, getCreateCategoriesServerSideOption, getExplicitCreateAndModifyAttributesOption, getExplicitCreateDate, getExplicitLastModifyDate, getFreeIfLastFolderReferenceOption, getKeepLastModifierOption, getKeepLastModifyDateOption, getLockEntryDefinition, getLockObject, getLockObjectDefinition, getLockObjectValue, getSecuringPublicObject, getSecuringPublicObjectValue, getUpdatedLockObjectDefinition, removeCategoryDefinitions, removeLockEntryDefinition, resolveAutoFolderingSettings, setAddToFolderOption, setAddToFolderValue, setAutoFolderingActionSpecification, setAutoFolderingActionSpecification, setCascadeCopyRelationshipsOption, setCategoryCopyOption, setCategoryDefinitions, setContentQuotaCopyOption, setCreateCategoriesServerSideOption, setExplicitCreateAndModifyAttributesOption, setExplicitCreateDate, setExplicitLastModifyDate, setFreeIfLastFolderReferenceOption, setKeepLastModifierOption, setKeepLastModifyDateOption, setLockEntryDefinition, setLockObject, setLockObjectDefinition, setLockObjectValue, setNullSecurity, setPrivateSecurity, setPublishedSecurity, setSecuringPublicObject, setSecuringPublicObjectValue, setUpdatedLockObjectDefinition, toPublicObjectDefinition, toPublicObjectDefinition

Methods inherited from class oracle.ifs.beans.LibraryObjectDefinition

addDefinition, addDefinitions, addProperty, addPropertyDefinition, addPropertyDefinition, addPropertyDefinitions, addPropertyDefinitions, addSimplePropertyDefinition, addSimplePropertyDefinition, addSimplePropertyDefinitions, addSimplePropertyDefinitions, applyEnumSetting, applyEnumSetting, applyMapSetting, applyMapSetting, applyObjectArraySetting, applyObjectArraySetting, applyObjectSetting, applyObjectSetting, applySetting, applySetting, captureSession, captureSession, captureSession, clone, constructInstance, constructInstance, constructInstance, copyInto, deriveObjectArraySetting, deriveObjectSetting, getAttribute, getAttribute, getAttributes, getAttributes, getAttributesSorted, getClassId, getClassObject, getClassObjectValue, getContentSpecification, getContentSpecificationKeys, getCopiedObjectValue, getDefinition, getDefinitionClassName, getDefinitionKeys, getDefinitionListKeys, getDefinitions, getId, getLibrarySession, getName, getOption, getOptionAsAttributeValue, getOptionKeys, getPolicyMode, getPropertyDefinitions, getReferenceAttribute, getReferenceAttributes, getServerDefinition, getSession, getSimplePropertyDefinitions, getSLibrarySession, getStringAttribute, getSystemOption, getSystemOptionAsAttributeValue, getSystemOptionAsBoolean, getSystemOptionKeys, getWriteableInstance, isReadOnly, prepareForDefinitionObject, processSimplePropertiesForCreate, processSimplePropertiesForUpdate, removeAttribute, removeContentSpecification, removeDefinition, removeDefinitions, removeOption, removePropertyDefinitions, removeReferenceAttribute, removeSimplePropertyDefinitions, removeSystemOption, reset, resolve, setAttribute, setAttribute, setAttribute, setAttributeByUpperCaseName, setAttributeByUpperCaseName, setAttributePolicyMode, setAttributes, setClassId, setClassname, setClassObject, setClassObjectValue, setContentSpecification, setCopiedObjectValue, setDefinition, setDefinitions, setId, setName, setOption, setReadOnly, setReferenceAttribute, setReferenceAttribute, setSession, setSimplePropertyDefinitions, setSystemOption, unresolve, verifySession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SmartHomeItemDefinition

public SmartHomeItemDefinition(LibrarySessionInterface session)
                        throws IfsException

Constructs a definition explicitly capturing the session.

The initial ClassObject will be TestSmartHomeItem.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

SmartHomeItemDefinition

public SmartHomeItemDefinition(LibrarySessionInterface session,
                               String className)
                        throws IfsException

Construct a definition explicitly capturing the session and setting the initial ClassObject name.

Parameters:

session - the current session

className - the initial class name

Throws:

IfsException - if the operation fails

Method Detail

getSmartHome

public SmartHome getSmartHome()
                       throws IfsException

Gets the SmartHome that this instance is associated with.

Returns:

the associated SmartHome

Throws:

IfsException - if operation fails

setSmartHome

public void setSmartHome(SmartHome smarthome)
                  throws IfsException

Sets the SmartHome this SmartHomeItem will be associated with.

Parameters:

smarthome - the SmartHome setting

Throws:

IfsException - if operation fails

toSmartHomeItemDefinition

public static SmartHomeItemDefinition toSmartHomeItemDefinition(LibraryObjectDefinition lodef)
                                                         throws IfsException

Cast specified LibraryObjectDefinition to a SmartHomeItemDefinition.

Return null if the specified LibraryObjectDefinition is not a SmartHomeItemDefinition, or if the specified definition is null.

Parameters:

lodef - the definition to be cast

Returns:

a SmartHomeItemDefinition cast from the specified definition

Throws:

IfsException - if the operation fails

toSmartHomeItemDefinition

public static SmartHomeItemDefinition toSmartHomeItemDefinition(LibraryObjectDefinition lodef,
                                                                boolean enforce)
                                                         throws IfsException

Cast specified LibraryObjectDefinition to a SmartHomeItemDefinition.

Return null if the specified definition is null. If non-null and unable to cast, return null if enforceCompat is false but throw otherwise.

Parameters:

lodef - the definition to be cast

enforce - whether to throw an exception if cast fails

Returns:

a SmartHomeItemDefinition cast from the specified definition

Throws:

IfsException - if the operation fails (throws 10822)