org.picketlink.idm.model

Interface AttributedType

All Superinterfaces:

Serializable

All Known Subinterfaces:

Account, IdentityType, Partition, Relationship

All Known Implementing Classes:

AbstractAttributedType, AbstractIdentityType, AbstractJdbcType, AbstractPartition, Agent, Grant, Group, GroupMembership, GroupRole, IdentityManagedJdbcType, PartitionJdbcType, Realm, RelationshipJdbcType, RelationshipReference, Role, Tier, User

public interface AttributedType
extends Serializable

Author:

Shane Bryzak

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AttributedType.QUERY_ATTRIBUTE

Field Summary

Fields

Modifier and Type	Field and Description
static QueryParameter	ID A query parameter used to set the id value.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Serializable> Attribute<T>	getAttribute(String name) Return the attribute value with the specified name
Collection<Attribute<? extends Serializable>>	getAttributes() Returns a Map containing all attribute values for this IdentityType instance.
String	getId() Returns the unique identifier for this instance
void	removeAttribute(String name) Remove the attribute with given name
void	setAttribute(Attribute<? extends Serializable> attribute) Set the specified attribute.
void	setId(String id) Sets the unique identifier for this instance

Field Detail

ID

static final QueryParameter ID

A query parameter used to set the id value.

Method Detail

getId

String getId()

Returns the unique identifier for this instance

Returns:

setId

void setId(String id)

Sets the unique identifier for this instance

setAttribute

void setAttribute(Attribute<? extends Serializable> attribute)

Set the specified attribute. This operation will overwrite any previous value.

Parameters:

name - of attribute

value - to be set

removeAttribute

void removeAttribute(String name)

Remove the attribute with given name

Parameters:

name - of attribute

getAttribute

<T extends Serializable> Attribute<T> getAttribute(String name)

Return the attribute value with the specified name

Parameters:

name - of attribute

Returns:

attribute value or null if attribute with given name doesn't exist. If given attribute has many values method will return first one

getAttributes

Collection<Attribute<? extends Serializable>> getAttributes()

Returns a Map containing all attribute values for this IdentityType instance.

Returns:

map of attribute names and their values