com.spss.psapi.core

Interface PropertiedObject

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean clearKeyedProperty(java.lang.String propertyName)
      Removes all keys associated with the supplied property.
      long creationDate()
      Returns the date/time when the object was created in milliseconds since January 1, 1970 00:00:00 GMT.
      java.util.List getKeyedPropertyKeys(java.lang.String propertyName)
      Returns the keys currently defined for the supplied keyed property name.
      java.lang.Object getKeyedPropertyValue(java.lang.String propertyName, java.lang.String keyName)
      Returns the value of the named property and key or null if no such property or key exists.
      java.lang.String getLabel()
      Returns the object's display label.
      java.lang.String getName()
      Returns the object's name.
      PropertyType getPropertyType(java.lang.String propertyName)
      Returns the PropertyType for the named property or null if no such property exists.
      java.lang.Object getPropertyValue(java.lang.String propertyName)
      Returns the value of the named property or null if no such property exists.
      double getSavedByVersion()
      Return the object's saved by version.
      StructuredPropertyDefinition getStructuredPropertyDefinition(java.lang.String propertyName)
      Returns the StructuredPropertyDefinition for the named property or null if no such property exists, or the property is not a structure or structure list property.
      boolean isKeyedProperty(java.lang.String propertyName)
      Returns true if the supplied property name is a keyed property.
      boolean isLocked()
      Returns true if this object is locked.
      boolean isProperty(java.lang.String propertyName)
      Returns true if the supplied property name is a valid property.
      boolean isServerConnectionRequiredProperty(java.lang.String propertyName)
      Returns true if the supplied property name should only be set if there is a valid server connection.
      java.util.Iterator propertyIterator()
      Returns an iterator of property names for this object.
      void setKeyedPropertyValue(java.lang.String propertyName, java.lang.String keyName, java.lang.Object value)
      Sets the value of the named property and key.
      void setLabel(java.lang.String label)
      Sets the object's display label.
      void setPropertyValue(java.lang.String propertyName, java.lang.Object value)
      Sets the value of the named property.
      void setPropertyValues(java.util.Map properties)
      Sets the values of the named properties.
      void setPropertyValuesFrom(PropertiedObject otherObject)
      Sets the values of the properties that are in both this object and the supplied other object.
      void unlock()
      Removes one level of locking on the object.
    • Method Detail

      • getName

        java.lang.String getName()
        Returns the object's name.
        Returns:
        the object's name
      • getSavedByVersion

        double getSavedByVersion()
                                 throws java.lang.Exception
        Return the object's saved by version.
        Returns:
        the saved by version
        Throws:
        java.lang.Exception - if the information cannot be accessed for some reason
      • setLabel

        void setLabel(java.lang.String label)
        Sets the object's display label. If the new label is a non-empty string it is assigned to the property "custom_name", and false is assigned to the property "use_custom_name" so that the specified label takes precedence; otherwise, an empty string is assigned to the property "custom_name", and true is assigned to the property .
        Parameters:
        label - the object's display label
        See Also:
        getLabel(), Property.OBJECT_CUSTOM_NAME, Property.OBJECT_USE_CUSTOM_NAME
      • isProperty

        boolean isProperty(java.lang.String propertyName)
        Returns true if the supplied property name is a valid property.
        Parameters:
        propertyName - the property name
        Returns:
        true if the supplied property name is a valid property
        Since:
        PSAPI 16.0
      • getPropertyType

        PropertyType getPropertyType(java.lang.String propertyName)
        Returns the PropertyType for the named property or null if no such property exists.
        Parameters:
        propertyName - the property name
        Returns:
        the PropertyType for the named property or null if no such property exists
      • propertyIterator

        java.util.Iterator propertyIterator()
        Returns an iterator of property names for this object.
        Returns:
        an iterator of property names for this object
      • isKeyedProperty

        boolean isKeyedProperty(java.lang.String propertyName)
        Returns true if the supplied property name is a keyed property.
        Parameters:
        propertyName - the property name
        Returns:
        true if the supplied property name is a keyed property
      • getKeyedPropertyKeys

        java.util.List getKeyedPropertyKeys(java.lang.String propertyName)
        Returns the keys currently defined for the supplied keyed property name.
        Parameters:
        propertyName - the property name
        Returns:
        a list of associated key values
        Since:
        PSAPI 16.0
      • isServerConnectionRequiredProperty

        boolean isServerConnectionRequiredProperty(java.lang.String propertyName)
        Returns true if the supplied property name should only be set if there is a valid server connection.
        Parameters:
        propertyName - the property name
        Returns:
        true if the supplied property name should only be set if there is a valid server connection
      • getStructuredPropertyDefinition

        StructuredPropertyDefinition getStructuredPropertyDefinition(java.lang.String propertyName)
        Returns the StructuredPropertyDefinition for the named property or null if no such property exists, or the property is not a structure or structure list property.
        Parameters:
        propertyName - the property name
        Returns:
        the StructuredPropertyDefinition for the named property or null if no such property exists, or the property is not a structure or structure list property
      • creationDate

        long creationDate()
        Returns the date/time when the object was created in milliseconds since January 1, 1970 00:00:00 GMT. If the object doesn't store the creation time explicitly, it will return 0L.
        Returns:
        the creation time
        Since:
        PSAPI 18.1
      • isLocked

        boolean isLocked()
        Returns true if this object is locked. An object may have multiple levels of locking and is only unlocked when all locking contexts have been unwound. For example, a node may be locked and then the owning stream may also become locked - this in turn will lock all the nodes within the stream and means that both the stream and whatever locked the node original node have to unlock it.
        Returns:
        true if this object is locked
        Since:
        PSAPI 18.1
      • unlock

        void unlock()
        Removes one level of locking on the object. If there are multiple levels of locking on an object, calling isLocked() may still return true. WARNING do not use this method unless you know exactly what you are doing. Arbitrarily unlocking an object can have unintended consequences and should only be used as a last resort.
        Since:
        PSAPI 18.1
        See Also:
        isLocked()

(C) Copyright IBM Corp. 1994, 2015. All Rights Reserved.