Package swiss.trustbroker.saml.dto

Class UiObject

java.lang.Object
swiss.trustbroker.saml.dto.UiObject
All Implemented Interfaces:
Serializable
public class UiObject extends Object implements Serializable
See Also:

  • Constructor Details

    • UiObject

      public UiObject()

    • UiObject

      public UiObject(String urn, UiDisableReason disabled, Integer order, String name, String title, String description, String image, String shortcut, String color, Integer noticeMaxAgeSec, List<String> noticeClaimsProviders)
      Creates a new UiObject instance.
      Parameters:
      urn - id uniquely identifies a tile.
      disabled - disabled signals to the frontend to inactivate the tile.
      order - order allows to compose multiple tiles in a flexible manner.
      name - name is displayed on the tile given it's not used as a key into the translation service or overridden by tileTitle.
      title - Title for the CP tile and help item.
      The fallback order (if not defined) is: title > name > ID
      description - Text displayed in the CP tile.
      The fallback order (if not defined) is: description > name > ID
      image - Image displayed in the HRD large view.
      shortcut - A usually two-character code identifying the CP on small screens.
      color - HTML color code identifying the CP on small screens.
      noticeMaxAgeSec - Notice max age
      noticeClaimsProviders - The list of ClaimsProviders name

  • Method Details

    • getOrderWithDefault

      public Integer getOrderWithDefault()
      Returns:
      configured order number or a default order at the end of a common CP list (using range [100, 999].

    • builder

      public static UiObject.UiObjectBuilder builder()

    • getUrn

      public String getUrn()
      id uniquely identifies a tile.

    • getDisabled

      public UiDisableReason getDisabled()
      disabled signals to the frontend to inactivate the tile.

    • getOrder

      public Integer getOrder()
      order allows to compose multiple tiles in a flexible manner.

    • getName

      public String getName()
      name is displayed on the tile given it's not used as a key into the translation service or overridden by tileTitle.

    • getTitle

      public String getTitle()
      Title for the CP tile and help item.
      The fallback order (if not defined) is: title > name > ID

    • getDescription

      public String getDescription()
      Text displayed in the CP tile.
      The fallback order (if not defined) is: description > name > ID

    • getImage

      public String getImage()
      Image displayed in the HRD large view.

    • getShortcut

      public String getShortcut()
      A usually two-character code identifying the CP on small screens.

    • getColor

      public String getColor()
      HTML color code identifying the CP on small screens.

    • getNoticeMaxAgeSec

      public Integer getNoticeMaxAgeSec()
      Notice max age

    • getNoticeClaimsProviders

      public List<String> getNoticeClaimsProviders()
      The list of ClaimsProviders name

    • setUrn

      public void setUrn(String urn)
      id uniquely identifies a tile.

    • setDisabled

      public void setDisabled(UiDisableReason disabled)
      disabled signals to the frontend to inactivate the tile.

    • setOrder

      public void setOrder(Integer order)
      order allows to compose multiple tiles in a flexible manner.

    • setName

      public void setName(String name)
      name is displayed on the tile given it's not used as a key into the translation service or overridden by tileTitle.

    • setTitle

      public void setTitle(String title)
      Title for the CP tile and help item.
      The fallback order (if not defined) is: title > name > ID

    • setDescription

      public void setDescription(String description)
      Text displayed in the CP tile.
      The fallback order (if not defined) is: description > name > ID

    • setImage

      public void setImage(String image)
      Image displayed in the HRD large view.

    • setShortcut

      public void setShortcut(String shortcut)
      A usually two-character code identifying the CP on small screens.

    • setColor

      public void setColor(String color)
      HTML color code identifying the CP on small screens.

    • setNoticeMaxAgeSec

      public void setNoticeMaxAgeSec(Integer noticeMaxAgeSec)
      Notice max age

    • setNoticeClaimsProviders

      public void setNoticeClaimsProviders(List<String> noticeClaimsProviders)
      The list of ClaimsProviders name

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object