Package org.wso2.carbon.user.api

Class Claim

java.lang.Object
org.wso2.carbon.user.api.Claim
All Implemented Interfaces:
Serializable
public class Claim extends Object implements Serializable
Represents a claim that is associated with an entity usually a user. Claims describe the capabilities associated with some entity in the system. A claim is the expression of a right with respect to a particular value. Hence a claim has a uri, display name, value and many other properties. This class models the properties of a claim.
See Also:

  • Constructor Details

    • Claim

      public Claim()

  • Method Details

    • getClaimUri

      public String getClaimUri()

    • setClaimUri

      public void setClaimUri(String claimUri)

    • getDisplayTag

      public String getDisplayTag()

    • setDisplayTag

      public void setDisplayTag(String displayTag)

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • isSupportedByDefault

      public boolean isSupportedByDefault()

    • setSupportedByDefault

      public void setSupportedByDefault(boolean supportedByDefault)

    • isRequired

      public boolean isRequired()

    • setRequired

      public void setRequired(boolean required)

    • getRegEx

      public String getRegEx()

    • setRegEx

      public void setRegEx(String regEx)

    • getDialectURI

      public String getDialectURI()

    • setDialectURI

      public void setDialectURI(String dialectURI)

    • getValue

      public String getValue()

    • setValue

      public void setValue(String value)

    • getDisplayOrder

      public int getDisplayOrder()

    • setDisplayOrder

      public void setDisplayOrder(int displayOrder)

    • isReadOnly

      public boolean isReadOnly()

    • setReadOnly

      public void setReadOnly(boolean readOnly)

    • isCheckedAttribute

      public boolean isCheckedAttribute()

    • setCheckedAttribute

      public void setCheckedAttribute(boolean checkedAttribute)

    • isMultiValued

      public boolean isMultiValued()

    • setMultiValued

      public void setMultiValued(boolean multiValued)

    • isManagedInUserStore

      public Boolean isManagedInUserStore()
      Indicates whether the claim is managed in the user store.
      Returns:
      true if enabled, false otherwise.

    • setManagedInUserStore

      public void setManagedInUserStore(Boolean managedInUserStore)
      Sets the claim to be managed in the user store.
      Parameters:
      managedInUserStore - true to enable, false to disable.

    • getExcludedUserStores

      public Set<String> getExcludedUserStores()
      Get the set of user stores that exclude this claim.
      Returns:
      Set of excluded user stores.

    • setExcludedUserStores

      public void setExcludedUserStores(Set<String> excludedUserStores)
      Set the user stores that exclude this claim.
      Parameters:
      excludedUserStores - Set of excluded user stores.

    • isExtendedValued

      public boolean isExtendedValued()
      Indicates whether the claim is extended value which requires special handling in the user store.
      Returns:
      true if enabled, false otherwise.

    • setExtendedValued

      public void setExtendedValued(boolean extendedValued)
      Sets the claim to be extended value which requires special handling in the user store.
      Parameters:
      extendedValued - true to enable, false to disable.