Interface IExtensionStateModel


  • public interface IExtensionStateModel
    Allows clients to coordinate state across components that are part of the same logical extension.

    That is, a content provider might vary how it exposes its content based on the state of a specific property in the model. Interested parties may add themselves as IPropertyChangeListeners to track changes in the state model.

    Since:
    3.2
    Restriction:
    This interface is not intended to be implemented by clients.
    Restriction:
    This interface is not intended to be extended by clients.
    • Method Detail

      • getId

        String getId()
        The id is used to look up the state model across different components of the same logical extension. Generally, the id of the content extension is used.
        Returns:
        The unique identifier of this state model.
      • getViewerId

        String getViewerId()
        Returns:
        The viewer id that this state model is associated with.
      • getStringProperty

        String getStringProperty​(String aPropertyName)
        Parameters:
        aPropertyName - The name of a given property
        Returns:
        The current value of the property.
      • getBooleanProperty

        boolean getBooleanProperty​(String aPropertyName)
        Parameters:
        aPropertyName - The name of a given property
        Returns:
        The current value of the property.
      • getIntProperty

        int getIntProperty​(String aPropertyName)
        Parameters:
        aPropertyName - The name of a given property
        Returns:
        The current value of the property.
      • getProperty

        Object getProperty​(String aPropertyName)
        Parameters:
        aPropertyName - The name of a given property
        Returns:
        The current value of the property.
      • setStringProperty

        void setStringProperty​(String aPropertyName,
                               String aPropertyValue)
        Parameters:
        aPropertyName - The name of a given property
        aPropertyValue - The new value of a the given property.
      • setBooleanProperty

        void setBooleanProperty​(String aPropertyName,
                                boolean aPropertyValue)
        Parameters:
        aPropertyName - The name of a given property
        aPropertyValue - The new value of a the given property.
      • setIntProperty

        void setIntProperty​(String aPropertyName,
                            int aPropertyValue)
        Parameters:
        aPropertyName - The name of a given property
        aPropertyValue - The new value of a the given property.
      • setProperty

        void setProperty​(String aPropertyName,
                         Object aPropertyValue)
        Parameters:
        aPropertyName - The name of a given property
        aPropertyValue - The new value of a the given property.
      • removePropertyChangeListener

        void removePropertyChangeListener​(IPropertyChangeListener aListener)
        Parameters:
        aListener - An implementation of IPropertyChangeListener that should no longer be notified when changes occur in this model.