public class BinaryDevice extends TieApplicationObject
Modifier and Type | Field and Description |
---|---|
static String |
BINARYDEVICE_ACTIVITYSPECIFICATION_NAME
The name of the ActivitySpecification to use for the ActivityRecord on
BinaryDevices.
|
static String |
CLASS_NAME
The name of the ClassObject representing this class.
|
static String |
GATEWAY_ATTRIBUTE
The name of the Attribute holds the associated Gateway
(null for a Gateway itself).
|
static String |
LASTSTATECHANGEDATE_ATTRIBUTE
The name of the Attribute that holds the date of the last state change
of this BinaryDevice.
|
static String |
LOCATION_ATTRIBUTE
The name of the Attribute holds the location of this BinaryDevice.
|
static String |
MANUFACTURER_ATTRIBUTE
The name of the Attribute holds the manufacturer of this BinaryDevice.
|
static String |
NODEID_ATTRIBUTE
The name of the Attribute holds the node ID of this BinaryDevice.
|
static String |
PRODUCT_ATTRIBUTE
The name of the Attribute holds the product name of this BinaryDevice.
|
static String |
STATE_ATTRIBUTE
The name of the Attribute holds the current state of this BinaryDevice.
|
static String |
TOTALCOMPLETEDDURATION_ATTRIBUTE
The name of the Attribute that holds the total duration (in milliseconds)
the device was On prior to the last change to an Off state.
|
static String |
UNIQUENAME_ATTRIBUTE
The name that uniquely identifies this device.
|
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 |
---|
BinaryDevice(LibrarySession session,
Long id,
Long classId,
S_LibraryObjectData data)
Construct a BinaryDevice object.
|
Modifier and Type | Method and Description |
---|---|
void |
executeCreatedAction()
Execute a "Created" action to reflect the creation of the ActivityRecord -
essentially capturing the time when this BinaryDevice was created.
|
static BinaryDevice |
findByUniqueName(LibrarySession session,
String uniqueName)
Returns the a device matching the specified uniquename.
|
protected String |
getActivitySpecificationName()
Get the ActivitySpecification name
|
Gateway |
getGateway()
Gets the Gateway that manages this binary device.
|
Date |
getLastStateChangeDate()
Gets the date of the last state change of this BinaryDevice.
|
String |
getLocation()
Gets the location that this instance defines.
|
String |
getManufacturer()
Gets the manufacturer that this instance defines.
|
Integer |
getNodeId()
Gets the location that this instance defines.
|
String |
getProduct()
Gets the product that this instance defines.
|
String |
getState()
Gets the current state that this instance defines.
|
long |
getTotalCompletedDuration()
Gets the total duration (in milliseconds) the device was On
prior to the last change to an Off state.
|
String |
getUniqueName()
Gets the name that uniquely defines this instance.
|
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.
|
auditPublicObjectLocked, auditPublicObjectUnlocked, auditUpdated, constructApplicationObject, constructApplicationObjectVector, isValidEventType, preFree, reportApplicationObjectCreated, reportApplicationObjectFreed
addAccess, addAttachment, addCategory, addFlags, addMessageList, addRelationship, canAcquireManualLock, canReleaseDavLock, canReleaseLock, canReleaseManualLock, capabilities, 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, free, 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, handleAdminModeChange, handleEvent, 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 GATEWAY_ATTRIBUTE
public static final String STATE_ATTRIBUTE
public static final String LASTSTATECHANGEDATE_ATTRIBUTE
public static final String TOTALCOMPLETEDDURATION_ATTRIBUTE
public static final String LOCATION_ATTRIBUTE
public static final String MANUFACTURER_ATTRIBUTE
public static final String PRODUCT_ATTRIBUTE
public static final String NODEID_ATTRIBUTE
public static final String BINARYDEVICE_ACTIVITYSPECIFICATION_NAME
public BinaryDevice(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) throws IfsException
session
- current LibrarySessionid
- object idclassId
- class iddata
- data componentIfsException
- if the operation failspublic Gateway getGateway() throws IfsException
IfsException
- if operation failspublic String getUniqueName() throws IfsException
IfsException
- if operation failspublic String getLocation() throws IfsException
IfsException
- if operation failspublic String getState() throws IfsException
IfsException
- if operation failspublic Date getLastStateChangeDate() throws IfsException
IfsException
- if operation failspublic long getTotalCompletedDuration() throws IfsException
IfsException
- if operation failspublic String getManufacturer() throws IfsException
IfsException
- if operation failspublic String getProduct() throws IfsException
IfsException
- if operation failspublic Integer getNodeId() throws IfsException
IfsException
- 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 ApplicationObject
lodef
- object definition that was used to create the objectIfsException
- if the operation failsprotected String getActivitySpecificationName() throws IfsException
IfsException
- if operation failspublic void executeCreatedAction() throws IfsException
IfsException
- if operation failspublic static BinaryDevice findByUniqueName(LibrarySession session, String uniqueName) throws IfsException
Gateway names are case sensitive, so this operations requires an exact match with respect to case.
session
- the session contextuniqueName
- the Gateway UniqueNameIfsException
- if the operation fails.Copyright © 2023. All rights reserved.