Package ch.ivyteam.util

Interface IAttributeStore<T>

  • Type Parameters:
    T - the attribute type
    All Known Subinterfaces:
    IApplication, ISession, IWorkflowSession
    public interface IAttributeStore<T>
    This interface defines the API of an attribute map, i.e. a store for any kind of Objects addressed by a name (e.g. a session store).
    API:
    This is a public API.

    • Method Detail

      • setAttribute

        T setAttribute​(String attributeName,
               T attributeValue)
        Sets a attribute object, which is not persisted, so that after a server restart these attribute are not more set. If value is null, then any previously stored object will be removed; i.e. setAttribute("key", null) is equivalent to removeAttribute("key").
        Parameters:
        attributeName - name of the attribute
        attributeValue - value of the attribute
        Returns:
        the previously stored attribute value, if one was set (null otherwise)
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.
        Security:
        Application: SESSION OWNS ApplicationWriteAttribute PERMISSION OR OWNS ApplicationWriteAttribute@SYSTEM PERMISSION
        Session: SESSION (MATCHES THIS AND MATCHES THIS.UserUnknown) OR (MATCHES THIS AND MATCHES THIS.UserKnown AND OWNS SessionWriteOwnAttribute PERMISSION) OR OWNS SessionWriteAttribute PERMISSION OR OWNS SessionWriteAttribute@SYSTEM PERMISSION

      • getAttribute

        T getAttribute​(String attributeName)
        Gets a store attribute.
        Parameters:
        attributeName - Name of the attribute
        Returns:
        attribute value, null if attribute doesn't exist
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.
        Security:
        Application: SESSION OWNS ApplicationReadAttribute PERMISSION OR OWNS ApplicationReadAttribute@SYSTEM PERMISSION
        Session: SESSION (MATCHES THIS AND MATCHES THIS.UserUnknown) OR (MATCHES THIS AND MATCHES THIS.UserKnown AND OWNS SessionReadOwnAttribute PERMISSION) OR OWNS SessionReadAttribute PERMISSION OR OWNS SessionReadAttribute@SYSTEM PERMISSION

      • removeAttribute

        T removeAttribute​(String attributeName)
        Removes a store attribute.
        Parameters:
        attributeName - Name of the store attribute
        Returns:
        removed attribute value or null if attribute didn't exist
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.
        Security:
        Application: SESSION OWNS ApplicationDeleteAttribute PERMISSION OR OWNS ApplicationDeleteAttribute@SYSTEM PERMISSION
        Session: SESSION (MATCHES THIS AND MATCHES THIS.UserUnknown) OR (MATCHES THIS AND MATCHES THIS.UserKnown AND OWNS SessionDeleteOwnAttribute PERMISSION) OR OWNS SessionDeleteAttribute PERMISSION OR OWNS SessionDeleteAttribute@SYSTEM PERMISSION

      • getAttributeNames

        Set<String> getAttributeNames()
        Gets all store attribute names in an unmodifiable Set.
        Returns:
        unmodifiable Set with all store attribute names
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.
        Security:
        Application: SESSION OWNS ApplicationReadAttributeNames PERMISSION OR OWNS ApplicationReadAttributeNames@SYSTEM PERMISSION
        Session: SESSION (MATCHES THIS AND MATCHES THIS.UserUnknown) OR (MATCHES THIS AND MATCHES THIS.UserKnown AND OWNS SessionReadOwnAttributeNames PERMISSION) OR OWNS SessionReadAttributeNames PERMISSION OR OWNS SessionReadAttributeNames@SYSTEM PERMISSION