public class SwitchDefinition extends BinaryDeviceDefinition
LibraryObjectDefinition.EnumToIntegerCode, LibraryObjectDefinition.LookupByNamem_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 and Description |
|---|
SwitchDefinition(LibrarySessionInterface session)
Constructs a definition explicitly capturing the session.
|
SwitchDefinition(LibrarySessionInterface session,
String className)
Construct a definition explicitly capturing the session
and setting the initial ClassObject name.
|
| Modifier and Type | Method and Description |
|---|---|
void |
setAssociatedLight(Light light)
Sets the Light this Switch will be associated with.
|
static SwitchDefinition |
toSwitchDefinition(LibraryObjectDefinition lodef)
Cast specified LibraryObjectDefinition to a SwitchDefinition.
|
static SwitchDefinition |
toSwitchDefinition(LibraryObjectDefinition lodef,
boolean enforce)
Cast specified LibraryObjectDefinition to a SwitchDefinition.
|
getGateway, setGateway, toBinaryDeviceDefinition, toBinaryDeviceDefinitionaddCategoryDefinition, 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, toPublicObjectDefinitionaddDefinition, 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, verifySessionpublic SwitchDefinition(LibrarySessionInterface session) throws IfsException
The initial ClassObject will be Switch.
session - the current sessionIfsException - if the operation failspublic SwitchDefinition(LibrarySessionInterface session, String className) throws IfsException
session - the current sessionclassName - the initial class nameIfsException - if the operation failspublic void setAssociatedLight(Light light) throws IfsException
light - the Light settingIfsException - if operation failspublic static SwitchDefinition toSwitchDefinition(LibraryObjectDefinition lodef) throws IfsException
Return null if the specified LibraryObjectDefinition is not a SwitchDefinition, or if the specified definition is null.
lodef - the definition to be castIfsException - if the operation failspublic static SwitchDefinition toSwitchDefinition(LibraryObjectDefinition lodef, boolean enforce) throws IfsException
Return null if the specified definition is null. If non-null and unable to cast, return null if enforceCompat is false but throw otherwise.
lodef - the definition to be castenforce - whether to throw an exception if cast failsIfsException - if the operation fails (throws 10822)Copyright © 2023. All rights reserved.