Package com.avoka.fc.core.entity

Class 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:
    Serialized Form

    • Field Detail

      • PORTAL_ADMIN_CONSOLE

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

      • PORTAL_TRANSACT_MAESTRO

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

      • PORTAL_TRANSACT_INSIGHTS

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

      • PORTAL_AVOKA_EXCHANGE

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

      • PORTAL_TRANSACT_RECEIPTS

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

      • PORTAL_WEB_PLUG_IN

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

      • PORTAL_TYPE_ADMIN_CONSOLE

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

      • PORTAL_TYPE_FIELD_WORKER

        public static final String PORTAL_TYPE_FIELD_WORKER
        Portal type that identifies a portal used to communicate with the SmartForm Manager FieldWorker
        See Also:
        Constant Field Values

      • PORTAL_TYPE_RECEIPTS

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

      • PORTAL_TYPE_MAESTRO

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

      • PORTAL_TYPE_REPORTS

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

      • PORTAL_TYPE_SELF_SERVICE

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

      • PORTAL_TYPE_WEB_PLUGIN

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

      • PORTAL_TYPE_VALUES

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

      • PORTAL_STATUS_NORMAL

        public static final String PORTAL_STATUS_NORMAL
        Indicates that the portal is operating normally
        See Also:
        Constant Field Values

      • PORTAL_STATUS_OFFLINE

        public static final String PORTAL_STATUS_OFFLINE
        Indicates that the portal is offline for maintenance
        See Also:
        Constant Field Values

      • PORTAL_STATUS_VALUES

        public static final String[] PORTAL_STATUS_VALUES
        The full set of operational statuses

    • Constructor Detail

      • Portal

        public Portal()

    • Method Detail

      • 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

      • isFieldWorkerPortal

        public boolean isFieldWorkerPortal()
        Return whether this portal is used to communicate with the SmartForm Manager FieldWorker
        Returns:
        true if the portal type is PORTAL_TYPE_FIELD_WORKER

      • 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

      • 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 PORTAL_STATUS_NORMAL

      • isOfflineStatus

        public boolean isOfflineStatus()
        Return whether the portal is currently offline
        Returns:
        true if the status is PORTAL_STATUS_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