Package com.aquima.interactions.portal

Interface IPortalScope

All Superinterfaces:
Serializable
All Known Subinterfaces:
IFlowScope, IInternalSessionScope, IPageScope, IPortalMessageScope, IRequestScope, ISessionScope, IUserScope
All Known Implementing Classes:
ConcurrentFlowScope, ConcurrentPageScope, ConcurrentPortalMessageScope, ConcurrentPortalScope, ConcurrentSessionScope, FlowScope, FlowScopeDelegate, PageScope, PageScopeDelegate, PortalMessageScope, PortalScope, ProcessEnabledSessionScope, ReadonlySessionScope, RequestScope, RequestScopeDelegate, SessionScope, SessionScopeDelegate, SessionScopeWrapper, UserScope
public interface IPortalScope extends Serializable
Basic interface for portal scope objects. Derived interfaces all allow properties to be held and modified.
Since:
5.0
Author:
O. Kerpershoek, f.van.der.meer

  • Method Summary

    Modifier and Type
    Method
    Description
    Serializable
    clearAttribute(String key)
    This method will remove the value from the scope for the specified key, and returns the value that has been removed.
    Serializable
    getAttribute(String key)
    This method will return the value that has been added to this scope for the specified attribute key.
    String[]
    getAttributeNames()
    This method returns an array containing all the names of the attribute that have a value in this scope.
    PortalScopeType
    getType()
    This method will return the scope type of the portal scope implementation.
    boolean
    hasAttribute(String key)
    This method will check if an attribute with the specified key has been added to this scope.
    Serializable
    setAttribute(String key, Serializable attrValue)
    This method will set the value in the scope under the specified key, and will return the value that might have been replaced by this action.

  • Method Details

    • getAttributeNames

      String[] getAttributeNames()
      This method returns an array containing all the names of the attribute that have a value in this scope.
      Returns:
      array containing all the names of the attribute that have a value in this scope.

    • hasAttribute

      boolean hasAttribute(String key)
      This method will check if an attribute with the specified key has been added to this scope. The key name of the attribute is not case sensitive.
      Parameters:
      key - Name of the attribute that should be checked (mandatory).
      Returns:
      boolean indicating if a value is present for the specified attribute key.

    • getAttribute

      Serializable getAttribute(String key)
      This method will return the value that has been added to this scope for the specified attribute key. When there is no value present for the specified key, a null value will be returned.
      Parameters:
      key - Name of the attribute for which the value is requested (mandatory).
      Returns:
      The value for the specified key, or null when there is no value present.

    • clearAttribute

      Serializable clearAttribute(String key)
      This method will remove the value from the scope for the specified key, and returns the value that has been removed. When there is no value present for the specified key, the method invocation has no effect, and a null value will be returned.
      Parameters:
      key - Name of the attribute of which the value should be removed (mandatory).
      Returns:
      The value that was removed from the scope, or null when there was no value defined for the specified key.

    • setAttribute

      Serializable setAttribute(String key, Serializable attrValue)
      This method will set the value in the scope under the specified key, and will return the value that might have been replaced by this action. When there was no value present for the specified key, a null value will be returned.
      Parameters:
      key - Name of the attribute for which the value should be set (mandatory).
      attrValue - The value that should be set for the specified key (mandatory).
      Returns:
      The value that was replaced (previously present) by the set action.

    • getType

      PortalScopeType getType()
      This method will return the scope type of the portal scope implementation.
      Returns:
      The current scope type.