org.picketlink.idm.model

Interface IdentityType

All Superinterfaces:

AttributedType, Serializable

All Known Subinterfaces:

Account

All Known Implementing Classes:

AbstractIdentityType, AbstractUser, Agent, Application, CustomerUser, EmployeeUser, Group, OrganizationUnit, Role, User

public interface IdentityType
extends AttributedType

This interface is the base for all identity model objects. It declares a number of properties that must be supported by all identity types, in addition to defining the API for identity attribute management.

Author:

Shane Bryzak

Nested Class Summary

Nested classes/interfaces inherited from interface org.picketlink.idm.model.AttributedType

AttributedType.QUERY_ATTRIBUTE

Field Summary

Fields

Modifier and Type	Field and Description
static QueryParameter	CREATED_AFTER A query parameter used to set the created after date
static QueryParameter	CREATED_BEFORE A query parameter used to set the created before date
static QueryParameter	CREATED_DATE A query parameter used to set the createdDate value
static QueryParameter	ENABLED A query parameter used to set the enabled value.
static QueryParameter	EXPIRY_AFTER A query parameter used to set the expiration after date
static QueryParameter	EXPIRY_BEFORE A query parameter used to set the expiration before date
static QueryParameter	EXPIRY_DATE A query parameter used to set the expiryDate value
static QueryParameter	PARTITION A query parameter used to set the Partition value

Fields inherited from interface org.picketlink.idm.model.AttributedType

ID

Method Summary

Methods

Modifier and Type	Method and Description
Date	getCreatedDate() Returns the date that this IdentityType instance was created.
Date	getExpirationDate() Returns the date that this IdentityType expires, or null if there is no expiry date.
Partition	getPartition() Returns the owning Partition for this identity object.
boolean	isEnabled() Indicates the current enabled status of this IdentityType.
void	setCreatedDate(Date createdDate) Sets the date that this IdentityType was created.
void	setEnabled(boolean enabled) Sets the current enabled status of this IdentityType.
void	setExpirationDate(Date expirationDate) Sets the date that this IdentityType expires.
void	setPartition(Partition partition) Sets the Partition for this object.

Methods inherited from interface org.picketlink.idm.model.AttributedType

getAttribute, getAttributes, getId, removeAttribute, setAttribute, setId

Field Detail

PARTITION

static final QueryParameter PARTITION

A query parameter used to set the Partition value

ENABLED

static final QueryParameter ENABLED

A query parameter used to set the enabled value.

CREATED_DATE

static final QueryParameter CREATED_DATE

A query parameter used to set the createdDate value

CREATED_AFTER

static final QueryParameter CREATED_AFTER

A query parameter used to set the created after date

CREATED_BEFORE

static final QueryParameter CREATED_BEFORE

A query parameter used to set the created before date

EXPIRY_DATE

static final QueryParameter EXPIRY_DATE

A query parameter used to set the expiryDate value

EXPIRY_AFTER

static final QueryParameter EXPIRY_AFTER

A query parameter used to set the expiration after date

EXPIRY_BEFORE

static final QueryParameter EXPIRY_BEFORE

A query parameter used to set the expiration before date

Method Detail

isEnabled

boolean isEnabled()

Indicates the current enabled status of this IdentityType.

Returns:

A boolean value indicating whether this IdentityType is enabled.

setEnabled

void setEnabled(boolean enabled)

Sets the current enabled status of this IdentityType.

Parameters:

enabled -

getCreatedDate

Date getCreatedDate()

Returns the date that this IdentityType instance was created.

Returns:

Date value representing the creation date

setCreatedDate

void setCreatedDate(Date createdDate)

Sets the date that this IdentityType was created.

Parameters:

expirationDate -

getExpirationDate

Date getExpirationDate()

Returns the date that this IdentityType expires, or null if there is no expiry date.

Returns:

setExpirationDate

void setExpirationDate(Date expirationDate)

Sets the date that this IdentityType expires.

Parameters:

expirationDate -

getPartition

Partition getPartition()

Returns the owning Partition for this identity object.

Returns:

setPartition

void setPartition(Partition partition)

Sets the Partition for this object.

Parameters:

partition -