Package com.aquima.interactions.portal

Interface IRequestScope

All Superinterfaces:
IDisposableScope, IPortalScope, Serializable
All Known Implementing Classes:
RequestScope, RequestScopeDelegate
public interface IRequestScope extends IPortalScope, IDisposableScope
The portal engine holds and constructs request scopes and passes these to services and container methods. This object's life time is for only one request when portal is processing the input. After the processing has completed this object is discarded and in a next request a new scope lives.
Since:
5.0
Author:
Jon van Leuven, f.van.der.meer

  • Method Details

    • getLanguage

      ILanguage getLanguage()
      Retrieves the language in which the last page was submitted. Most language specific handling are part of the page-rendering mechanism, however this function is available to use the last submitted language to backend systems.
      Returns:
      The current language object which is never null

    • getChangedValues

      ValueReference[] getChangedValues()
      This method will return an array containing the references to all the values that were changed by fields from the current request. The array will contain the references to values from the current request.
      Returns:
      an array containing the references to all the values that were changed by fields from the current request.

    • isChangedValue

      boolean isChangedValue(ValueReference reference)
      This method may be used to check if a specific value has been updated by an event in the current request.
      Parameters:
      reference - Reference to the value that might have been updated.
      Returns:
      Boolean indicating if the value was updated by an event in the current request.

    • getOriginalValue

      IValue getOriginalValue(ValueReference reference)
      This method returns the value of the attribute as it was before the value got changed by the request. If the value did not get changed by in the request, the method will return a null value.
      Parameters:
      reference - The reference to the attribute whose value is requested before it was modified in the request.
      Returns:
      The value of the attribute as it was before the value got changed by in the request.

    • addProjectChange

      void addProjectChange(IProjectChange projectChange)
      This method will attach a new project change object to the queue of project changes objects of the current request scope.
      Parameters:
      projectChange - The specific project change object.

    • hasNextProjectChange

      boolean hasNextProjectChange()
      This method checks if the current request scope already has a next project change information attached to the queue of project changes.
      Returns:
      A flag indicating if the current request scope object has a next project change object.

    • getNextProjectChange

      IProjectChange getNextProjectChange()
      This method will return the next project change object attached to the queue of project changes of the request scope.
      Returns:
      The next project change object from the project changes queue, might be null.

    • addPortalChange

      void addPortalChange(IPortalChange portalChange)
      This method will attach a new portal change object to the queue of portal changes objects of the current request scope.
      Parameters:
      portalChange - The specific portal change object.

    • hasNextPortalChange

      boolean hasNextPortalChange()
      This method checks if the current request scope already has a next portal change information attached to the queue of portal changes.
      Returns:
      A flag indicating if the current request scope object has a next portal change object.

    • getNextPortalChange

      IPortalChange getNextPortalChange()
      This method will return the next portal change object attached to the queue of portal changes of the request scope.
      Returns:
      The next portal change object from the portal changes queue, might be null.