Class Component

    • Constructor Detail

      • Component

        public Component()
    • Method Detail

      • getRequiredPermissions

        @NonNull
        public abstract Set<Permission> getRequiredPermissions()
        Returns the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle. An empty list indicates that any user can include this bundle.
        Returns:
        the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle.
      • getDisplayPermissions

        public String getDisplayPermissions()
      • isEnabled

        @Exported
        public boolean isEnabled()
        Returns true if the current authentication can include this component in a bundle.
        Returns:
        true if the current authentication can include this component in a bundle.
      • isSelectedByDefault

        @Exported
        public boolean isSelectedByDefault()
      • isApplicable

        public <C extends AbstractModelObject> boolean isApplicable​(Class<C> clazz)
        Return if this component is applicable to a specific class of item.
        Type Parameters:
        C - Object that extends AbstractModelObject
        Parameters:
        clazz - the class
        Returns:
        true if applicable to this class
      • getDisplayName

        @NonNull
        @Exported
        public abstract String getDisplayName()
      • addContents

        public abstract void addContents​(@NonNull
                                         Container container)
        Add contents to a container
        Parameters:
        container - a Container
      • getId

        @Exported
        @NonNull
        public String getId()
        Returns the component id.
        Returns:
        by default, the Class.getSimpleName() of the component implementation.