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

Class BinaryDeviceDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.ApplicationObjectDefinition

oracle.ifs.core.tools.script.test.overrides.activity.iot.BinaryDeviceDefinition

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

DoorDefinition, GatewayDefinition, LightDefinition, SwitchDefinition

public class BinaryDeviceDefinition
extends ApplicationObjectDefinition

A BinaryDeviceDefinition is used to define BinaryDevice instances.

Author:

Dave Long

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
BinaryDeviceDefinition(LibrarySessionInterface session) Constructs a definition explicitly capturing the session.
BinaryDeviceDefinition(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
Gateway	getGateway() Gets the Gateway that this instance is associated with.
void	setGateway(Gateway gateway) Sets the Gateway this BinaryDevice will be associated with.
static BinaryDeviceDefinition	toBinaryDeviceDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a BinaryDeviceDefinition.
static BinaryDeviceDefinition	toBinaryDeviceDefinition(LibraryObjectDefinition lodef, boolean enforce) Cast specified LibraryObjectDefinition to a BinaryDeviceDefinition.

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

BinaryDeviceDefinition

public BinaryDeviceDefinition(LibrarySessionInterface session)
                       throws IfsException

Constructs a definition explicitly capturing the session.

The initial ClassObject will be BinaryDevice.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

BinaryDeviceDefinition

public BinaryDeviceDefinition(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

getGateway

public Gateway getGateway()
                   throws IfsException

Gets the Gateway that this instance is associated with.

Returns:

the associated Gateway

Throws:

IfsException - if operation fails

setGateway

public void setGateway(Gateway gateway)
                throws IfsException

Sets the Gateway this BinaryDevice will be associated with.

Parameters:

gateway - the Gateway setting

Throws:

IfsException - if operation fails

toBinaryDeviceDefinition

public static BinaryDeviceDefinition toBinaryDeviceDefinition(LibraryObjectDefinition lodef)
                                                       throws IfsException

Cast specified LibraryObjectDefinition to a BinaryDeviceDefinition.

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

Parameters:

lodef - the definition to be cast

Returns:

a BinaryDeviceDefinition cast from the specified definition

Throws:

IfsException - if the operation fails

toBinaryDeviceDefinition

public static BinaryDeviceDefinition toBinaryDeviceDefinition(LibraryObjectDefinition lodef,
                                                              boolean enforce)
                                                       throws IfsException

Cast specified LibraryObjectDefinition to a BinaryDeviceDefinition.

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 BinaryDeviceDefinition cast from the specified definition

Throws:

IfsException - if the operation fails (throws 10822)