Interface FormFragmentComponentDefinition

    • Method Detail

      • getInterfaceClassName

        String getInterfaceClassName()
        Returns the classname of the interface the FormFragment implements.
        Returns:
        the classname of the interface the FormFragment implements
      • setInterfaceClassName

        void setInterfaceClassName​(String className)
        Sets the classname of the interface the FormFragment implements.
        Parameters:
        className - the classname of the interface the FormFragment implements
      • getIcon

        String getIcon()
        Returns the location of the icon file relative to the src/main/resources/backend directory of the WCB.
        Returns:
        the location of the icon file
      • setIcon

        void setIcon​(String icon)
        Sets the location of the icon file relative to the src/main/resources/backend directory of the WCB.
        Parameters:
        icon - the location of the icon file relative to the src/main/resources/backend directory of the WCB
      • getLanguageLabel

        String getLanguageLabel()
        Returns the key of the language label describing this form fragment. This refers to an entry in the messages.properties file(s) in the messages-directory of the WCB.
        Returns:
        the key of the language label describing this form fragment
      • setLanguageLabel

        void setLanguageLabel​(String languageLabel)
        Sets the key of the language label describing this form fragment. This refers to an entry in the messages.properties file(s) in the messages-directory of the WCB.
        Parameters:
        languageLabel - the key of the language label describing this form fragment
      • getLabel

        String getLabel()
        Returns the internal label identifying this type of FormFragment.
        Returns:
        the internal label identifying this type of FormFragment
      • getPresentationScope

        String getPresentationScope()
        Returns the scope that identifies presentations of this type of FormFragment.
        Returns:
        the scope that identifies presentations of this type of FormFragment
      • setPresentationScope

        void setPresentationScope​(String presentationScope)
        Sets the scope that identifies presentations of this type of FormFragment.
        Parameters:
        presentationScope - the scope that identifies presentations of this type of FormFragment
      • getFragmentType

        String getFragmentType()
        Returns the Fragment Type. This is one of the static Strings defined in the WCBConstants file of the wmpformapi. Typically one of "static", "input" or "group".
        Returns:
        the Fragment Type
      • setFragmentType

        void setFragmentType​(String type)
        Sets the Fragment Type. This is one of the static Strings defined in the WCBConstants file of the wmpformapi. Typically one of "static", "input" or "group".
        Parameters:
        type - the Fragment Type
      • getRanking

        int getRanking()
        Returns the ranking. This is an arbitrary integer that is used to order the fragments in the form panel.
        Returns:
        the ranking
      • setRanking

        void setRanking​(int ranking)
        Sets the ranking. This is an arbitrary integer that is used to order the fragments in the form panel.
        Parameters:
        ranking - the ranking
      • setUsePermissions

        void setUsePermissions​(Permission[] permissions)
        Sets the permissions that grant the user the authorization to use this formfragment. The user has to be assigned to one of the permissions only to be granted that authorization. If input argument is null, use permission is granted to all users
        Parameters:
        permissions - All permissions that grant the user the authorization to use this formfragment
      • getUsePermissions

        Permission[] getUsePermissions()
        Gets the permissions that grant the user the authorization to use this formfragment. The user has to be assigned to one of the permissions only to be granted that authorization. If result is null, use permission is granted to all users
        Returns:
        All permissions that grant the user the authorization to use this formfragment