public class SmartHome extends TieFolder
Modifier and Type | Field and Description |
---|---|
static String |
CLASS_NAME
The name of the ClassObject representing this class.
|
static String |
SMARTHOME_ACTIVITYSPECIFICATION_NAME
The name of the ActivitySpecification to use for the ActivityRecord
on SmartHomes.
|
static String |
SMARTHOMEITEM_ACTIVITYSPECIFICATION_NAME
The name of the ActivitySpecification to use for the ActivityRecord on
SmartHomeItems.
|
static String |
UNIQUENAME_ATTRIBUTE
The name that uniquely identifies this SmartHome.
|
SYSTEMOPTIONVALUE_FOLDER_DEPTH_DEEPEST, SYSTEMOPTIONVALUE_FOLDER_DEPTH_MUST_BE_EMPTY, SYSTEMOPTIONVALUE_FOLDER_DEPTH_NONE
ACL_ATTRIBUTE, CREATEDATE_ATTRIBUTE, CREATOR_ATTRIBUTE, DELETOR_ATTRIBUTE, DESCRIPTION_ATTRIBUTE, EXPIRATIONDATE_ATTRIBUTE, FAMILY_ATTRIBUTE, FLAG_CATEGORY_EXISTS, FLAG_CONFIGURATIONCATEGORY_EXISTS, FLAG_MARKED, FLAG_NOINFERIOR, FLAG_NOSELECT, FLAG_NTFS_ARCHIVE, FLAG_NTFS_HIDDEN, FLAG_NTFS_READONLY, FLAG_NTFS_SYSTEM, FLAG_UNMARKED, FLAGS_ATTRIBUTE, LASTMODIFIER_ATTRIBUTE, LASTMODIFYDATE_ATTRIBUTE, LOCKENTRIES_ATTRIBUTE, LOCKOBJECT_ATTRIBUTE, NAME_ATTRIBUTE, OWNER_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PRIMARYPARENTFOLDER_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE, RESOLVEDPUBLICOBJECT_ATTRIBUTE, SECURINGPUBLICOBJECT_ATTRIBUTE
DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session
Constructor and Description |
---|
SmartHome(LibrarySession session,
Long id,
Long classId,
S_LibraryObjectData data)
Construct a SmartHome object.
|
Modifier and Type | Method and Description |
---|---|
SmartHomeItem |
addSmartHomeItem(SmartHomeItemDefinition shItemDef)
Add an SmartHomeItem to this SmartHome.
|
void |
executeAddSmartHomeItemAction(SmartHomeItem shItem)
Execute an "Add SmartHomeItem" action to reflect the addition of a new SmartHomeItem.
|
void |
executeCreatedAction()
Execute a "Created" action to reflect the creation of the ActivityRecord -
essentially capturing the Actor who created this SmartHome.
|
static SmartHome |
findByUniqueName(LibrarySession session,
String uniqueName)
Returns the a SmartHome matching the specified uniquename.
|
SmartHomeItem |
findSmartHomeItem(Integer nodeId)
Returns the SmartHomeItem instance that matches the specified name.
|
SmartHomeItem[] |
getSmartHomeItems()
Gets the SmartHomeItems contained within this SmartHome.
|
SmartHomeItem[] |
getSmartHomeItems(String sortClause)
Gets the SmartHomeItems contained within this SmartHome.
|
protected void |
postCreate(LibraryObjectDefinition lodef)
Extensibility point to perform actions after the
creation of a PublicObject.
|
protected void |
preCreate(LibraryObjectDefinition lodef)
Extensibility point to perform actions prior to the
creation of a PublicObject.
|
addItem, addItem, addItems, auditUpdated, capabilities, checkExistenceOfPublicObjectByPath, constructFolder, constructFolderArray, constructFolderVector, createSecuredDocument, createUniqueName, createUniqueName, deepFree, exists, fetchItemCount, fetchSubfolderCount, find, findPublicObjectByPath, free, getGlobalAuditEventExpirationPeriod, getGlobalAuditTypeList, getItemCount, getItems, getResolvedItems, getSortSpecification, getSubfolderCount, handleAdminModeChange, handleDefaultFolderOptionChange, handleEvent, hasItems, hasSubfolders, initializeSubfolderIndication, isAuditAdministrator, isValidEventType, isValidNameForNewObject, lock, lock, moveItems, newGetItems, preFree, removeAllItems, removeItem, removeItem, removeItems, reportFolderCreated, reportFolderFreed, reportFolderItemAdded, reportFolderItemRemoved, resetItems, resolveSortSpecification, setDomainVisibleSecurity, setSortSpecification, unlock, vectorToFolderArray, verifyAddItemCapability, verifyRemoveItemCapability, verifyValidAuditDomain
addAccess, addAttachment, addCategory, addFlags, addMessageList, addRelationship, auditPublicObjectLocked, auditPublicObjectUnlocked, canAcquireManualLock, canReleaseDavLock, canReleaseLock, canReleaseManualLock, checkAuditViewCapability, checkCapabilities, checkCapability, checkEffectiveAccess, checkEffectiveAccess, checkLockAccess, checkParentFolderCapability, checkVersioned, clearFlags, constructPublicObject, constructPublicObjectArray, constructPublicObjectVector, containsLockEntry, copy, coreAutoFolderingEnabled, createCategories, createDedicatedPolicyPropertyBundle, delete, deriveEffectiveAccessLevel, findAttachmentRelation, findOrAddActivityRecord, findOrAddActivityRecord, findOrAddActor, findOrAddActor, findOrAddMessageList, findOrAddMessageList, getAcl, getActivityRecord, getActor, getAllFolderPaths, getAllFolderPaths, getAllFolderPaths, getAnyFolderPath, getAnyFolderPath, getAnyFolderPath, getAttachmentRelation, getAttachmentRelations, getAttachments, getCapabilities, getCategories, getCategories, getCategories, getCategories, getCategories, getCategory, getConsumedStorage, getCreateDate, getCreator, getDefaultAccessLevel, getDefinitionForSimplePropertyUpdates, getDeletor, getDescription, getEffectiveAccessLevel, getEffectiveAccessLevel, getExpirationDate, getFamily, getFirstCategory, getFirstVersion, getFlags, getFolderReferences, getFolderReferences, getFolderReferencesSortSpecification, getLastModifier, getLastModifyDate, getLastVersion, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLeftwardRelationshipsCount, getLeftwardRelationshipsCount, getLinks, getLockEntries, getLockEntries, getLockObject, getLockRestrictions, getLockTypeAuditProperties, getMessageList, getNextVersion, getOwner, getPolicyBundle, getPolicyLists, getPreviousVersion, getPrimaryFolderPath, getPrimaryParentFolder, getPrimaryParentFolder, getRelations, getReservationComment, getReservationDate, getReservor, getResolvedPublicObject, getRestrictingLockEntries, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getSecuringPublicObject, getSingletonVersionDescription, getVersionNumber, getVersions, getVersionSeries, getWorkingCopy, grantAccess, handleCopy, handleCreate, handleUnlockAll, hasActivityRecord, hasActor, hasAttachmentRelation, hasCategories, hasCategory, hasConfigurationCategories, hasMessageList, hasNameAttribute, hasPropertyBundleAttribute, isAttachment, isDeleted, isLatestVersion, isLocked, isLockingSupported, isOwner, isReserved, isReservedByCurrentUser, isVersionable, isVersioned, isWorkingCopy, listLeftwardRelationships, listRightwardRelationships, lock, lock, lock, lock, newVersion, postCopy, postSecurityChangedEvent, postUpdate, preCopy, preUpdate, putPolicy, reassociateLinks, removeAllPolicies, removeAttachment, removePolicy, removePolicy, removeRelationship, reserveNext, resetFolderReferences, resolveFolderReferenceSortSpecification, revokeAccess, revokeAllAccess, setAcl, setDescription, setExpirationDate, setFlags, setFolderReferencesSortSpecification, setLockEntries, setLockEntrySecurity, setOwner, setOwnerByName, setPolicyBundle, setPolicyLists, setSecuringPublicObject, toPublicObjectArray, undelete, unlock, unlock, unlockAll, unReserve, updateFlags, updateLock, vectorPublicObjectElement, vectorToPublicObjectArray, verifyAddRelationshipCapability, verifyCapabilities, verifyCapability, verifyDeleteCapability, verifyLockCapability, verifyRemoveRelationshipCapability, verifyUnlockCapability, verifyVersionSeries
added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getAttributeByUpperCaseName, getClassId, getId, getSessionInterface
getTraceLogger, isTraced, trace
public static final String CLASS_NAME
public static final String UNIQUENAME_ATTRIBUTE
public static final String SMARTHOME_ACTIVITYSPECIFICATION_NAME
public static final String SMARTHOMEITEM_ACTIVITYSPECIFICATION_NAME
public SmartHome(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) throws IfsException
session
- current LibrarySessionid
- object idclassId
- class iddata
- data componentIfsException
- if the operation failspublic SmartHomeItem[] getSmartHomeItems() throws IfsException
IfsException
- if operation failspublic SmartHomeItem[] getSmartHomeItems(String sortClause) throws IfsException
sortClause
- the Sort clauseIfsException
- if operation failsprotected void preCreate(LibraryObjectDefinition lodef) throws IfsException
Set an option that indicates that Categories are NOT to be created from within S_PublicObject.
preCreate
in class PublicObject
lodef
- object definition that will be used to create
the objectIfsException
- if the operation failsprotected void postCreate(LibraryObjectDefinition lodef) throws IfsException
This assumes that a transaction context has already been established.
postCreate
in class Folder
lodef
- object definition that was used to create the objectIfsException
- if the operation failspublic SmartHomeItem addSmartHomeItem(SmartHomeItemDefinition shItemDef) throws IfsException
shItemDef
- the SmartHomeItemDefinition to addIfsException
- if operation failspublic void executeCreatedAction() throws IfsException
IfsException
- if operation failspublic void executeAddSmartHomeItemAction(SmartHomeItem shItem) throws IfsException
shItem
- the new SmartHomeItemIfsException
- if operation failspublic static SmartHome findByUniqueName(LibrarySession session, String uniqueName) throws IfsException
SmartHome names are case sensitive, so this operations requires an exact match with respect to case.
session
- the session contextuniqueName
- the SmartHome UniqueNameIfsException
- if the operation fails.public SmartHomeItem findSmartHomeItem(Integer nodeId) throws IfsException
If more than one instance exists with the same name, the oldest one is returned.
nodeId
- the nodeId of the SmartHomeItemIfsException
- if the operation fails.Copyright © 2023. All rights reserved.