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

Class SmartHomeOperations

java.lang.Object

oracle.ifs.core.tools.script.ScriptOperations

oracle.ifs.core.activity.ActivityOperations

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

All Implemented Interfaces:

AttributeValueGetter, Logger

public class SmartHomeOperations
extends ActivityOperations

A SmartHomeOperations defines the operations for executing smarthome Action classes.

Author:

Frank Closheim

(Published)

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.core.tools.script.ScriptOperations

ScriptOperations.ClassObjectOptions, ScriptOperations.JdbcExecutor, ScriptOperations.SavedSearchResult, ScriptOperations.ServerDefinition, ScriptOperations.ServiceDefinition

Field Summary

Fields inherited from class oracle.ifs.core.tools.script.ScriptOperations

INDENT

Constructor Summary

Constructors

Constructor and Description
SmartHomeOperations(ScriptDriver driver) Construct a SmartHomeOperations.

Method Summary

Modifier and Type	Method and Description
void	addSmartHomeItem(AttributeValueTable avt) Add a SmartHomeItem to a SmartHome.
void	changeSmartHomeItemState(AttributeValueTable avt) Create a StateChangeAction with the desired action specified.
void	createSmartHome(AttributeValueTable avt) Creates a SmartHome.
void	identifySmartHome(AttributeValueTable avt) Identify a SmartHome by its unique name.
void	identifySmartHomeItem(AttributeValueTable avt) Identify a SmartHomeItem by its SmartHome and its nodeId.
protected SmartHome	lookupSmartHome(String tag) Lookup an SmartHome by the specified tag.
protected SmartHomeItem	lookupSmartHomeItem(String tag) Lookup an SmartHomeItem by the specified tag.
protected void	showActivitySummary(ActivitySummary asumm, ActivityRecord ar, String prefix, boolean verbose, boolean showDates, boolean stripNumbers) Show the ActivitySummary of an ActivityRecord.
void	showAllSmartHomeItems(AttributeValueTable avt) Show details about all Invitations within a Community.
protected void	showExecutedAction(Action action, String prefix, boolean verbose, boolean showDates, boolean stripNumbers) Show the details of a previously-executed Action.
void	showSmartHome(AttributeValueTable avt) Show details about a SmartHome.
void	showSmartHomeItem(AttributeValueTable avt) Show details about a SmartHomeItem within a SmartHome.
protected void	showSmartHomeItem(SmartHomeItem shItem, String prefix) Show details about an Invitation.

Methods inherited from class oracle.ifs.core.activity.ActivityOperations

addActionSpecification, addActivityRecord, addActor, addContact, addConversationMessage, createActionSpecification, createActivityHierarchyTables, createActivitySpecification, createConversation, createPerformedActivitySpecification, createTrackedActivitySpecification, deletePrivatePerformedActivityRecords, deleteTrackedActivityRecord, freeActionSpecification, freeActivitySpecification, freePerformedActivitySpecification, freeTrackedActivitySpecification, getActorsFromArrayToken, getActorsFromTags, identifyActionSpecification, identifyActivityRecord, identifyActivitySpecification, identifyActor, identifyPerformedActivityRecord, identifyPerformedActivitySpecification, identifyTrackedActivityRecord, identifyTrackedActivitySpecification, initializeExecutedActionRetainedEvents, lookupActionSpecification, lookupActivityRecord, lookupActivityRecord, lookupActivitySpecification, lookupActor, lookupActor, lookupActorRelation, lookupConversation, lookupPerformedActivitySpecification, lookupTrackedActivitySpecification, processExecutedActionRetainedEvents, refreshActionSpecification, refreshAllDeltaSummaries, refreshDeltaSummary, removeActionSpecification, removeActivityRecord, removeAllContacts, removeContact, setSessionActor, showActionSpecification, showActivity, showActivityRecord, showActivityRecord, showActivitySpecification, showActivitySummary, showActor, showAllActionSpecifications, showAllActivitySpecifications, showAllConversations, showAllPerformedActivitySpecifications, showAllTrackedActivitySpecifications, showConversation, showConversation, showLastAction, showPerformedActivityRecord, showPerformedActivityRecord, showPerformedActivityRecords, showPerformedActivitySpecification, showPrimaryContactList, showPrivatePerformedActivityRecord, showPrivateTrackedActivityRecord, showSessionActor, showTrackedActivityRecord, showTrackedActivityRecord, showTrackedActivityRecords, showTrackedActivitySpecification, updateLastViewedSummary, updatePrivateTrackedActivityRecords, updateTrackedActivityRecord

Methods inherited from class oracle.ifs.core.tools.script.ScriptOperations

abortTransaction, acquireLock, acquireManualLock, activateAuditHandlerSpecification, activateAuditSpecification, activateOperationActionSpecification, activateServerSpecification, activateSystemObject, addAttachment, addAttribute, addAuditEventProperty, addAuditType, addAuditTypesForClass, addBooleanHandlerProperty, addCategory, addDefinitionAuditEntryType, addDefinitionAuditEntryTypesForClass, addDefinitionAuditEntryTypesUnderClass, addDefinitionBooleanProperty, addDefinitionDoubleProperty, addDefinitionIntegerProperty, addDefinitionLongProperty, addDefinitionProperties, addDefinitionProperty, addDefinitionStringArrayProperty, addDefinitionStringProperty, addDocumentDefinitionCharacterSet, addDocumentDefinitionContent, addDocumentDefinitionContentBfileReference, addDocumentDefinitionLanguage, addGlobalOperationActionSpecification, addGroupMember, addGroupMembers, addIntegerHandlerProperty, addLifecyclePolicyEntryDefinition, addLifecyclePolicyEntryDefinition, addLongHandlerProperty, addManagedServerDeclaration, addManagedServerDeclaration, addManagedServerDeclaration, addManagedServiceDeclaration, addManagedServiceDeclaration, addPreparedSelectorBindValue, addPreparedSelectorBooleanBindValue, addPreparedSelectorIntegerBindValue, addPreparedSelectorLibraryObjectBindValue, addPreparedSelectorLongBindValue, addPreparedSelectorStringBindValue, addPublicObjectDefinitionCategory, addSchemaObjectDefinitionCategory, addStringArrayHandlerProperty, addStringHandlerProperty, addSystemObjectDefinitionBooleanProperty, addSystemObjectDefinitionCategory, addSystemObjectDefinitionIntegerProperty, addSystemObjectDefinitionLongProperty, addSystemObjectDefinitionStringArrayProperty, addSystemObjectDefinitionStringProperty, addToDocumentDefinition, addToPublicObjectDefinition, applyLogLevelOverride, applyNamedFreezeLock, applySingletonLock, assignClassDomain, assignLifecyclePolicyByCategory, assignValueDefault, assignValueDomain, beginTransaction, businessObjectExists, clearImpersonateUser, clearSharedCaches, cloneCurrentSession, cloneDefinition, cloneDefinition, comment, comment, compareObjects, completeTransaction, concatenateObjectId, concatenateStrings, concatenateStrings, concatenateStrings, concatenateStrings, concatenateStrings, concatenateStrings, concatenateStrings, concatenateToLowerStrings, concatenateToLowerStrings, concatenateToLowerStrings, concatenateToUpperStrings, concatenateToUpperStrings, concatenateToUpperStrings, connect, connect, constructAuditEvent, constructPreparedSelectorGenerator, constructPreparedSelectorGenerator, convertPropertyDefinitionsToHashtable, convertStringArray, convertToBoolean, convertToBoolean, convertToDouble, convertToDouble, convertToInteger, convertToInteger, convertToLong, convertToLong, convertToRelativePath, copy, create, createAccessControlList, createAndApplyAuditTypeList, createApplicationToken, createApplicationToken, createAuditSpecification, createAuditSpecification, createAuditSpecification, createAuditSpecification, createAuditTypeList, createAuditTypeList, createAutoFolderingActionSpecification, createAutoFolderingActionSpecification, createCategorizedDocument, createClassDomain, createClassObject, createClassObject, createCustomLockEntry, createCustomMediaDriverSpecification, createCustomMediaDriverSpecification, createDefinition, createDefinitionFromDefinitionObject, createDefinitionFromObject, createDefinitionObject, createDependentView, createDocument, createDocument, createDocument, createDocumentBatch, createDocuments, createEntireAuditSpecification, createExtendedPermission, createExtendedUserProfile, createFolder, createFolder, createFolder, createFolderLink, createFolderTree, createFormat, createGroup, createGuestSession, createLibraryObject, createLibraryObject, createLifecycleDateRuleSpecification, createLifecycleDateRuleSpecification, createLifecyclePolicy, createLifecyclePolicy, createLifecyclePolicyActionSpecification, createLifecyclePolicyActionSpecification, createLifecyclePolicyEntryDefinition, createLink, createLink, createLink, createLockTypeLookupTables, createMedia, createMedia, createNamedFreezeLock, createNamedPropertyBundle, createNodeConfiguration, createNodeConfiguration, createOperationActionSpecification, createOperationActionSpecification, createOrUpdateClassObject, createPermissionBundle, createPolicy, createPolicyList, createPropertyBundle, createQueue, createRetentionPolicy, createServerConfiguration, createServerConfiguration, createServerSpecification, createServiceConfiguration, createServiceConfiguration, createSession, createSession, createSimplePropertyTable, createSimplePropertyTableList, createStorageGroup, createStorageGroup, createSystemLockObject, createUser, createUserSession, createValueDefault, createValueDomain, deactivateAuditHandlerSpecification, deactivateAuditSpecification, deactivateOperationActionSpecification, deactivateServerSpecification, deactivateSystemObject, deactivateUnknownOperationActionSpecifications, defineAttribute, defineAuditHandlerSpecificationDefinition, defineAuditHandlerSpecificationDefinition, defineAuditTargetSpecificationDefinition, defineAuditTypeListDefinition, defineAuditTypeListDefinition, defineClassObject, defineExistingClassObject, definitionExists, deleteAllCategories, deleteAuditSpecification, deleteNamedFreezeLock, deleteRepositoryParameter, deleteUser, deregisterBusinessObject, deregisterCustomLockType, deregisterDefinition, deregisterLockType, deregisterObject, deregisterSession, deregisterTransaction, determinePrimaryObjectColumnAlias, ensureFreed, executeAutocommitSql, executePreparedSelect, executePreparedSelect, executePreparedSelect, executePreparedSelect, executePreparedSelectCount, executePreparedSelectCount, executePreparedSelectCount, executePreparedSelectFromJson, executePreparedSelectResults, exists, existsRelative, extractContentForIndexing, findOrCreateCompositeGroup, freeClassDomain, freeClassObject, freeExtendedPermission, freeFolder, freeFormat, freeNamedPropertyBundle, freeNamedPropertyBundle, freeNodeConfiguration, freeNodeConfiguration, freeObject, freePermissionBundle, freePolicy, freeServerConfiguration, freeServerConfiguration, freeServiceConfiguration, freeServiceConfiguration, freeUnreferencedContent, freeValueDefault, freeValueDomain, generateClassObjectDefinitionTag, getAbsolutePath, getAclValueForConfigurationObjects, getAttributeValue, getAttributeValue, getAttributeValue, getAuditDriverHelper, getAuditEventDispatcher, getAuditingStartingId, getAuxiliaryTargets, getBindValues, getBypassSecurityAliases, getClassObjectCreationMode, getConsoleInputBoolean, getConsoleInputString, getConsoleInputString, getConsoleInputString, getConsoleSecureInputString, getContentPath, getCurrentSession, getDriver, getIncludedFileSettings, getLogWriter, getManagedServerDeclarations, getManagedServiceDeclarations, getParameterTable, getSavedSearchResultPrimaryObjects, getSavedSearchResults, getShowDates, getStringArray, getStringsFromArrayToken, getStripNumbersFromAuditEventProperties, handleEventPostedForCustomAuditHistory, handleTimerExpiredForCustomAuditHistory, identifyAcl, identifyAcl, identifyApplicationToken, identifyAttribute, identifyAttributePropertyBundle, identifyAuditHandlerSpecification, identifyAuditSpecification, identifyAuditTargetSpecification, identifyAuditTypeList, identifyAuditTypeListBySpecification, identifyAutoFolderingActionSpecification, identifyByAttribute, identifyByPath, identifyByRelativePath, identifyCategory, identifyCategory, identifyClassAcl, identifyClassDomain, identifyClassObject, identifyClassPolicyBundle, identifyClassPropertyBundle, identifyCompositeGroup, identifyCustomLock, identifyCustomMediaDriverSpecification, identifyDependentView, identifyExtendedPermission, identifyFormat, identifyGlobalAuditSpecification, identifyGlobalAuditTypeList, identifyGroup, identifyGuestUser, identifyInstancePropertyBundle, identifyLibraryObject, identifyLifecycleDateRuleSpecification, identifyLifecyclePolicy, identifyLifecyclePolicyActionSpecification, identifyLifecyclePolicyEntry, identifyMedia, identifyMessageEntry, identifyMessageList, identifyNamedFreezeLock, identifyNamedPropertyBundle, identifyNodeConfiguration, identifyObjectAuditSpecification, identifyObjectProperty, identifyOperationActionSpecification, identifyPermissionBundle, identifyPolicy, identifyPolicyList, identifyPrimaryUserProfile, identifyPropertyBundle, identifyQueue, identifyQueueTypeMapBundle, identifyRetentionPolicy, identifyServerConfiguration, identifyServerSpecification, identifyServiceConfiguration, identifySingletonLockType, identifyStorageGroup, identifySystemAcl, identifySystemLockObject, identifySystemUser, identifyUser, identifyValueDefault, identifyValueDomain, identifyWorldGroup, impersonateUser, impersonateUser, initializeManualTextIndexingRetainedEvents, isBootstrapModeEnabled, isDomainScopeImpliedForSearch, isInArray, log, log, lookupAcl, lookupApplicationToken, lookupAuditDomainContext, lookupAuditSpecification, lookupAutoFolderingActionSpecification, lookupBusinessObject, lookupBusinessObjectHashtable, lookupBusinessObjectList, lookupClassAcl, lookupDatatype, lookupDatatypeString, lookupDefinition, lookupDefinition, lookupDirectoryObject, lookupDocument, lookupFolder, lookupFormat, lookupFormatFromCollection, lookupGroup, lookupMedia, lookupMessageEntry, lookupObject, lookupObject, lookupObjectAttributeValue, lookupObjectId, lookupOperationActionSpecification, lookupPublicObject, lookupQueue, lookupSessionByTag, lookupSystemAcl, lookupSystemLockObject, lookupTagBySessionId, lookupUser, lookupUserFromCollection, makeDefinitionReadOnly, markCurrentAuditingId, modifyClassObject, move, moveCategory, normalizeBooleanString, notifyCustomAuditHistoryHandler, objectExists, postCustomAuditEvent, postCustomAuditEvent, postCustomAuditEvent, postSystemAuditEvent, postSystemAuditEvent, preprocessDocumentSettings, preprocessPublicObjectSettings, printStackTrace, processManualTextIndexingRetainedEvents, processRawAuditEvents, purgeGlobalAuditHistory, reactivateUnknownOperationActionSpecifications, readDocumentContent, refreshDependentView, registerAllNonCustomAuditTypes, registerAuditEventType, registerAuditEventType, registerBusinessObject, registerCustomAuditType, registerCustomLockType, registerDefinition, registerLockType, registerNewSession, registerObject, registerTransaction, releaseLock, releaseManualLock, removeAcesForFreedGrantees, removeAllAttachments, removeAttachment, removeAttribute, removeClassProperty, removeCustomLockEntry, removeGroupMembers, removeNamedFreezeLock, removeProperties, removeServerFromNodeConfiguration, removeServiceFromNodeConfiguration, removeSession, removeSessionState, removeSingletonLock, removeTag, rename, replaceMediaLookupsByFormat, replaceSession, resetFolderCountInfo, restoreGlobalOperationActionSpecification, runSchemaCreator, runScript, saveGlobalOperationActionSpecification, saveSearchResultPrimaryObjects, saveSearchResults, searchAuditHistory, searchAuditHistory, searchAuditHistory, sessionExists, setAdminMode, setAdminMode, setArrayTokenDelimiter, setAuditingStartingId, setAuditSpecificationAuditHandlerSpecificationDefinition, setAuditSpecificationAuditTargetSpecificationDefinition, setAuditSpecificationAuditTypeListDefinition, setAuditTargetSpecificationDefinitionTarget, setBooleanInstanceProperty, setClassObjectCreationMode, setClassPolicyList, setClassProperty, setCreateCategoriesServerSideOption, setCurrentSession, setCurrentSession, setDateFormat, setDefaultAuditEventSortClause, setDefaultMedia, setDefaultScriptOperationsClass, setDefaultStorageGroup, setDefinitionAttribute, setDefinitionAttribute, setDefinitionBooleanAttribute, setDefinitionClassObjectAttribute, setDefinitionDateAttribute, setDefinitionDirectoryObjectArrayAttribute, setDefinitionDirectoryObjectAttribute, setDefinitionDoubleAttribute, setDefinitionIntegerAttribute, setDefinitionLongAttribute, setDefinitionNullStringAttribute, setDefinitionObjectAttribute, setDefinitionSchemaObjectArrayAttribute, setDefinitionSchemaObjectAttribute, setDefinitionStringArrayAttribute, setDefinitionStringAttribute, setDefinitionSystemObjectAttribute, setDocumentDefinitionContentObjectDefinition, setGlobalAuditTypeList, setGlobalOperationActionSpecifications, setInstallationMode, setInstallationMode, setInstanceProperty, setIntegerInstanceProperty, setLifecyclePolicyDefinitionDeleteEntriesOption, setLocale, setLongInstanceProperty, setLongSessionState, setMainSessionAsCurrentSession, setMediaLookupByFormat, setNumberFormat, setObjectProperty, setPreventSessionTimeouts, setPreventSessionTimeouts, setProperty, setPublicObjectInstanceProperty, setRepositoryParameter, setStringInstanceProperty, setStringSessionState, setSubstitutionPrefix, setSystemAdminMode, setSystemAdminMode, setSystemObjectInstanceProperty, setTimeoutPeriodOption, setTimeZone, setUserCreateOptions, setUserDefaultAcl, setUserDeleteOptions, showAcl, showAggregateAuditEventColumns, showAllAutoFolderingActionSpecifications, showAllClassAcls, showAllClassDomains, showAllClassObjects, showAllCustomAuditSpecifications, showAllCustomMediaDriverSpecifications, showAllDependentViews, showAllExtendedPermissions, showAllExternalRetentionPolicies, showAllFormats, showAllLifecycleDateRuleSpecifications, showAllLifecyclePolicies, showAllLifecyclePolicyActionSpecifications, showAllMedias, showAllNodeConfigurations, showAllNodeConfigurations, showAllOperationActionSpecifications, showAllPermissionBundles, showAllPolicies, showAllPolicyLists, showAllRepositoryParameters, showAllRetentionPolicies, showAllServerConfigurations, showAllServerConfigurations, showAllServerSpecifications, showAllServiceConfigurations, showAllServiceConfigurations, showAllStorageGroups, showAllSystemAcls, showAllValueDefaults, showAllValueDomains, showApplicationToken, showApplicationTokens, showAttachments, showAttribute, showAttribute, showAuditCertificates, showAuditEventOperationTypes, showAuditSpecification, showAuditTypeList, showAuditTypesForClass, showAuditTypesForCreateOperations, showAuditTypesForFreeOperations, showAuditTypesUnderClass, showAutoFolderingActionSpecification, showCapabilities, showClassDomain, showClassDomain, showClassObject, showClassObjectAndSubNames, showClassObjectAndSubs, showCompositeGroup, showCreateClassObjectScript, showCurrentUser, showCustomAuditHistory, showCustomAuditHistory, showCustomAuditTypes, showCustomMediaDriverSpecification, showDefaultMedia, showDefaultStorageGroup, showDefineAttributeScript, showDefinition, showDefinitionObject, showDependentView, showDocument, showDocumentCharacterSet, showDocumentContentInfo, showDocumentContents, showDocumentContents, showDocumentContents, showDocumentLanguage, showDocumentsWithLifecyclePolicy, showExpandedAuditTypeList, showExtendedPermission, showFolder, showFolder, showFolderCountInfo, showFormat, showGlobalAuditHistory, showGlobalAuditHistory, showGlobalAuditSpecification, showGlobalAuditTypeList, showGlobalOperationActionSpecifications, showGroup, showInstanceProperty, showInstancePropertyBundle, showLibraryObject, showLibraryObject, showLifecycleDateRuleSpecification, showLifecyclePolicy, showLifecyclePolicyActionSpecification, showLifecyclePolicyEntry, showLink, showLocalizer, showLockEntry, showLockEntryInfo, showLockTypeLookupTables, showMedia, showMediaLookupByFormatMappings, showMessageEntry, showMessageList, showNamedPropertyBundle, showNodeConfiguration, showNodeConfiguration, showObject, showObjectAuditHistory, showObjectAuditHistory, showObjectAuditSpecification, showOperationActionSpecification, showParsedArrayToken, showParsedOperationString, showPermissionBundle, showPolicy, showPolicyList, showPreparedSelector, showPreparedSelector, showProperty, showPropertyBundle, showRepositoryParameter, showRetentionPolicy, showRuntimeStatistics, showSavedSearchResultPrimaryObjects, showSavedSearchResults, showServerConfiguration, showServerConfiguration, showServerSpecification, showServiceConfiguration, showServiceConfiguration, showServiceStatistics, showSessionCacheStatistics, showSessionState, showSimplePropertyTable, showSimplePropertyTableList, showStorageGroup, showUser, showValueDefault, showValueDefault, showValueDomain, showValueDomain, sleep, syncContentIndex, syncIndex, testJsonString, tokenToDirectoryObjectArray, tokenToDirectoryUserArray, tokenToDocumentArray, transactionExists, unregisterAuditEventType, unregisterCustomAuditType, update, updateAccessControlList, updateClassDomain, updateDefinitionObject, updateLibraryObject, updateLibraryObject, updateLibraryObject, updateNodeConfiguration, updateNodeConfiguration, updateServerConfiguration, updateServerConfiguration, updateServiceConfiguration, updateServiceConfiguration, updateUserPassword, updateValueDefault, updateValueDomain, verifyBusinessObjectTagNotExists, verifyDefinitionTagNotExists, verifyDefinitionWriteable, verifyObjectTagNotExists, writeConsoleOutputString, writeConsoleOutputString, writeDocumentContentToFile, zeroPad

Methods inherited from class java.lang.Object

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

Constructor Detail

SmartHomeOperations

public SmartHomeOperations(ScriptDriver driver)

Construct a SmartHomeOperations.

Parameters:

driver - the main script driver instance

(Published)

Method Detail

createSmartHome

public void createSmartHome(AttributeValueTable avt)
                     throws IfsException

Creates a SmartHome.

The keys supported by this operation:

• TAG: the tag that will identify the new object
• NAME: the SmartHome name (which will also be its UniqueName)
• DESCRIPTION: the SmartHome description
• ACL: the ACL to use for the new SmartHome
• PARENTFOLDER: the tag of the parent folder

Parameters:

avt - the named arguments

Throws:

IfsException - if the operation fails

(Published)

identifySmartHome

public void identifySmartHome(AttributeValueTable avt)
                       throws IfsException

Identify a SmartHome by its unique name.

The keys supported by this operation:

• TAG: the tag that will identify the SmartHome
• NAME: the name of the SmartHome which uniquely identifies it

Parameters:

avt - the named arguments

Throws:

IfsException - if the operation fails

showSmartHome

public void showSmartHome(AttributeValueTable avt)
                   throws IfsException

Show details about a SmartHome.

The keys supported by this operation:

• SMARTHOME (or TAG): tag that identifies the SmartHome to show
• VERBOSE: whether the output should be verbose.

Parameters:

avt - the named arguments

Throws:

IfsException - if the operation fails

addSmartHomeItem

public void addSmartHomeItem(AttributeValueTable avt)
                      throws IfsException

Add a SmartHomeItem to a SmartHome.

The keys supported by this operation:

• TAG: the tag that will identify the new object
• SMARTHOME: the SmartHome tag
• LOCATION: the location of the SmartHomeItem
• STATE: the state of the SmartHomeItem
• MANUFACTURER: the manufacturer of the SmartHomeItem
• PRODUCT: the product name of the SmartHomeItem
• NODEID: the nodeId of the SmartHomeItem within the SmartHome

Parameters:

avt - the named arguments

Throws:

IfsException - if the operation fails

(Published)

identifySmartHomeItem

public void identifySmartHomeItem(AttributeValueTable avt)
                           throws IfsException

Identify a SmartHomeItem by its SmartHome and its nodeId.

The keys supported by this operation:

• TAG: the tag that will identify the SmartHomeItem
• SMARTHOME: the tag that identifies the SmartHomeItem's SmartHome
• NODEID: the nodeId of the SmartHomeItem

Parameters:

avt - the named arguments

Throws:

IfsException - if the operation fails

showSmartHomeItem

public void showSmartHomeItem(AttributeValueTable avt)
                       throws IfsException

Show details about a SmartHomeItem within a SmartHome.

The keys supported by this operation:

• SMARTHOMEITEM (or TAG): tag that identifies the SmartHomeItem to show
• VERBOSE: whether the output should be verbose.

Parameters:

avt - the named arguments

Throws:

IfsException - if the operation fails

showAllSmartHomeItems

public void showAllSmartHomeItems(AttributeValueTable avt)
                           throws IfsException

Show details about all Invitations within a Community.

The keys supported by this operation:

• COMMUNITY: tag that identifies the Community, whose Invitations will be shown
• SORTCLAUSE: the Sort clause.
• VERBOSE: whether the output should be verbose.

Parameters:

avt - the named arguments

Throws:

IfsException - if the operation fails

changeSmartHomeItemState

public void changeSmartHomeItemState(AttributeValueTable avt)
                              throws IfsException

Create a StateChangeAction with the desired action specified.

The keys supported by this operation:

• TAG or SMARTHOMEITEM: the tag that will identify the SmartHomeItem that will change its state
• STATE: The setting for the StateChangeAction; possible values are OPEN, CLOSED, STARTED, STOPPED or UNDEFINED

Parameters:

avt - the named arguments

Throws:

IfsException - if the operation fails

lookupSmartHome

protected SmartHome lookupSmartHome(String tag)
                             throws IfsException

Lookup an SmartHome by the specified tag.

This will throw a RuntimeException if the tag does not correctly identify a SmartHome.

Parameters:

tag - the tag that identifies a SmartHome

Returns:

the SmartHome

Throws:

IfsException - if the operation fails

lookupSmartHomeItem

protected SmartHomeItem lookupSmartHomeItem(String tag)
                                     throws IfsException

Lookup an SmartHomeItem by the specified tag.

This will throw a RuntimeException if the tag does not correctly identify a SmartHomeItem.

Parameters:

tag - the tag that identifies a SmartHomeItem

Returns:

the SmartHomeItem

Throws:

IfsException - if the operation fails

showSmartHomeItem

protected void showSmartHomeItem(SmartHomeItem shItem,
                                 String prefix)
                          throws IfsException

Show details about an Invitation.

Parameters:

shItem - the SmartHomeItem

prefix - the prefix

Throws:

IfsException - if the operation fails

(Unpublished)

showActivitySummary

protected void showActivitySummary(ActivitySummary asumm,
                                   ActivityRecord ar,
                                   String prefix,
                                   boolean verbose,
                                   boolean showDates,
                                   boolean stripNumbers)
                            throws IfsException

Show the ActivitySummary of an ActivityRecord.

Override to show information specific to social activity.

Overrides:

showActivitySummary in class ActivityOperations

Parameters:

asumm - the ActivitySummary to show

ar - ActivityRecord on which the ActivitySummary is based

prefix - the indentation prefix

verbose - whether the output should be verbose

showDates - whether the output should show dates

stripNumbers - whether the output should strip numbers from output

Throws:

IfsException - if the operation fails

showExecutedAction

protected void showExecutedAction(Action action,
                                  String prefix,
                                  boolean verbose,
                                  boolean showDates,
                                  boolean stripNumbers)
                           throws IfsException

Show the details of a previously-executed Action.

Delegate to superclass after showing SmartHome/SmartHomeItem-specific info.

Overrides:

showExecutedAction in class ActivityOperations

Parameters:

action - the Action to show

prefix - the indentation prefix

verbose - whether the output should be verbose

showDates - whether the output should show dates

stripNumbers - whether the output should strip numbers from output

Throws:

IfsException - if the operation fails