IsLockedValidator

java.lang.Object

com.ptc.core.meta.container.common.AbstractValidator

com.ptc.core.foundation.locks.common.IsLockedValidator

All Implemented Interfaces:: ActionValidator

public final class IsLockedValidator extends com.ptc.core.meta.container.common.AbstractValidator

Returns true if the given TypeInstance has been locked. Traps all exceptions, returns false.

Supported API: true

Extendable: false

Method Summary

Modifier and Type

Method

Description

protected Object

calculate(AttributeContainer the_attribute_container)

Examines the AttributeContainer for an AttributeTypeIdentifier whose logical identifier locker.id context (a TypeInstanceIdentifier) is not null, indicating it's not locked.

AttributeContainerSpec

getFilter(AttributeContainerSpec the_filter, TypeIdentifier type_identifier)

Will add the filter this validator needs to the supplied parameter and return that parameter.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- getFilter
  
  public AttributeContainerSpec getFilter(AttributeContainerSpec the_filter, TypeIdentifier type_identifier)
  
  Will add the filter this validator needs to the supplied parameter and return that parameter. TypeIdentifier can be null, will create a TypeIdentifier for Lockable
  
  Supported API: true
  
  Specified by:
  
  getFilter in interface ActionValidator
  
  Specified by:
  
  getFilter in class com.ptc.core.meta.container.common.AbstractValidator
  
  Parameters:
  
  the_filter -
  
  type_identifier - Used to get the DefinitionIdentifier for constructing the AttributeTypeIdentifier
  
  Returns:
  
  AttributeContainerSpec
- calculate
  
  protected Object calculate(AttributeContainer the_attribute_container) throws InvalidFunctionArgumentException
  
  Examines the AttributeContainer for an AttributeTypeIdentifier whose logical identifier locker.id context (a TypeInstanceIdentifier) is not null, indicating it's not locked. Returns true if the context is not null, else false. Default return value is true for any exceptions/errors.
  
  Supported API: true
  
  Specified by:
  
  calculate in class com.ptc.core.meta.container.common.AbstractValidator
  
  Parameters:
  
  the_attribute_container -
  
  Returns:
  
  Object
  
  Throws:
  
  InvalidFunctionArgumentException