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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Claim()

Method Summary

Methods

Modifier and Type	Method and Description
String	getClaimUri()
String	getDescription()
String	getDialectURI()
int	getDisplayOrder()
String	getDisplayTag()
String	getRegEx()
String	getValue()
boolean	isCheckedAttribute()
boolean	isReadOnly()
boolean	isRequired()
boolean	isSupportedByDefault()
void	setCheckedAttribute(boolean checkedAttribute)
void	setClaimUri(String claimUri)
void	setDescription(String description)
void	setDialectURI(String dialectURI)
void	setDisplayOrder(int displayOrder)
void	setDisplayTag(String displayTag)
void	setReadOnly(boolean readOnly)
void	setRegEx(String regEx)
void	setRequired(boolean required)
void	setSupportedByDefault(boolean supportedByDefault)
void	setValue(String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Claim

public Claim()

Method Detail

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)