Package com.avoka.fc.core.entity

Class Portal

java.lang.Object
org.apache.cayenne.PersistentObject
org.apache.cayenne.BaseDataObject
org.apache.cayenne.CayenneDataObject
com.avoka.core.entity.BaseEntity
com.avoka.fc.core.entity.auto._Portal
com.avoka.fc.core.entity.Portal
All Implemented Interfaces:
IEntity, Auditable, Serializable, org.apache.cayenne.DataObject, org.apache.cayenne.Persistent, org.apache.cayenne.Validating
@CacheGroups("CONFIG") public class Portal extends _Portal implements Auditable
Provides a SmartForm Manager portal module, generally used for form hosting and rendering.
See Also:

  • Field Details

    • PORTAL_ADMIN_CONSOLE

      public static final String PORTAL_ADMIN_CONSOLE
      Portal name that identifies the Administration Console
      See Also:

    • PORTAL_TRANSACT_MAESTRO

      public static final String PORTAL_TRANSACT_MAESTRO
      Portal name that identifies the 'Transact Maestro' module.
      See Also:

    • PORTAL_TRANSACT_INSIGHTS

      public static final String PORTAL_TRANSACT_INSIGHTS
      Portal name that identifies the 'Transact Insights' module.
      See Also:

    • PORTAL_TRANSACT_OPERATIONS

      public static final String PORTAL_TRANSACT_OPERATIONS
      Portal name that identifies the 'Journey Operations' module.
      See Also:

    • PORTAL_AVOKA_EXCHANGE

      public static final String PORTAL_AVOKA_EXCHANGE
      Portal name that identifies the 'Avoka Exchange' module.
      See Also:

    • PORTAL_TRANSACT_RECEIPTS

      public static final String PORTAL_TRANSACT_RECEIPTS
      Portal name that identifies the 'Transact Receipts' module.
      See Also:

    • PORTAL_WEB_PLUG_IN

      public static final String PORTAL_WEB_PLUG_IN
      Portal name that identifies the 'Web Plug-in' module.
      See Also:

    • PORTAL_TYPE_ADMIN_CONSOLE

      public static final String PORTAL_TYPE_ADMIN_CONSOLE
      Portal type that identifies the Administration Console
      See Also:

    • PORTAL_TYPE_RECEIPTS

      public static final String PORTAL_TYPE_RECEIPTS
      Portal type that identifies a receipt generation module
      See Also:

    • PORTAL_TYPE_MAESTRO

      public static final String PORTAL_TYPE_MAESTRO
      Portal type that identifies a Maestro module
      See Also:

    • PORTAL_TYPE_OPERATIONS

      public static final String PORTAL_TYPE_OPERATIONS
      Portal type that identifies an Operations module
      See Also:

    • PORTAL_TYPE_REPORTS

      public static final String PORTAL_TYPE_REPORTS
      Portal type that identifies a reporting portal
      See Also:

    • PORTAL_TYPE_SELF_SERVICE

      public static final String PORTAL_TYPE_SELF_SERVICE
      Portal type that identifies a self-service portal
      See Also:

    • PORTAL_TYPE_WEB_PLUGIN

      public static final String PORTAL_TYPE_WEB_PLUGIN
      Portal type that identifies a web plugin portal
      See Also:

    • PORTAL_PROPERTY_WELCOME_PAGE_URL

      public static final String PORTAL_PROPERTY_WELCOME_PAGE_URL
      Portal Property name for the Welcome Page Url
      See Also:

    • PORTAL_TYPE_VALUES

      public static final String[] PORTAL_TYPE_VALUES
      The full set of portal types

  • Constructor Details

    • Portal

      public Portal()

  • Method Details

    • isAdminConsolePortal

      public boolean isAdminConsolePortal()
      Return whether this portal is the SmartForm Manager Administration Console
      Returns:
      true if the portal name matches PORTAL_ADMIN_CONSOLE

    • isReceiptsPortal

      public boolean isReceiptsPortal()
      Return whether this portal is the Transact Receipts
      Returns:
      true if the portal name matches PORTAL_TYPE_RECEIPTS
      Since:
      5.1.0

    • isSelfServicePortal

      public boolean isSelfServicePortal()
      Return whether this portal is a self-service portal
      Returns:
      true if the portal type is PORTAL_TYPE_SELF_SERVICE

    • isMaestroPortal

      public boolean isMaestroPortal()
      Return whether this portal is the Maestro type portal
      Returns:
      true if the portal type is PORTAL_TYPE_MAESTRO
      Since:
      4.3.4

    • isOperationsPortal

      public boolean isOperationsPortal()
      Return whether this portal is the Operations type portal
      Returns:
      true if the portal type is PORTAL_TYPE_OPERATIONS
      Since:
      22.10.0

    • isWebPluginPortal

      public boolean isWebPluginPortal()
      Return whether this portal is a web plugin portal
      Returns:
      true if the portal type is PORTAL_TYPE_WEB_PLUGIN

    • isNormalStatus

      public boolean isNormalStatus()
      Return whether the portal is operating normally
      Returns:
      true if the status is Active

    • isOfflineStatus

      public boolean isOfflineStatus()
      Return whether the portal is currently offline
      Returns:
      true if the status is Offline

    • isModuleWithSharedLogin

      public boolean isModuleWithSharedLogin()
      Return whether the portal is a shared login module.
      Returns:
      true if the module is a shared login module, otherwise false.

    • getPortalProperty

      public PortalProperty getPortalProperty(String name)
      Return the named portal property.
      Parameters:
      name - the name of the portal property
      Returns:
      the named portal property

    • getPropertyMap

      public Map<String,String> getPropertyMap()
      Return an immutable map of portal property values, keyed on property name.
      Returns:
      an immutable map of portal property values, keyed on property name
      Since:
      4.0.0