org.picketlink.idm

Interface RelationshipManager

public interface RelationshipManager

Defines relationship management operations

Author:

Shane Bryzak

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Relationship relationship) Adds the given Relationship instance to the configured identity store.
<T extends Relationship> RelationshipQuery<T>	createRelationshipQuery(Class<T> relationshipType) Creates an RelationshipQuery that can be used to query for Relationship instances.
void	remove(Relationship relationship) Removes the given Relationship instance.
void	update(Relationship relationship) Updates the given Relationship instance.

Method Detail

add

void add(Relationship relationship)

Adds the given Relationship instance to the configured identity store.

Parameters:

relationship -

Throws:

IdentityManagementException - If cannot add the provided Relationship instance.

update

void update(Relationship relationship)

Updates the given Relationship instance. The instance must have an identifier, otherwise a exception will be thrown.

Parameters:

relationship -

Throws:

IdentityManagementException - If cannot update the provided Relationship instance.

remove

void remove(Relationship relationship)

Removes the given Relationship instance. The instance must have an identifier, otherwise a exception will be thrown.

Parameters:

relationship -

Throws:

IdentityManagementException - If cannot remove the provided Relationship instance.

createRelationshipQuery

<T extends Relationship> RelationshipQuery<T> createRelationshipQuery(Class<T> relationshipType)

Creates an RelationshipQuery that can be used to query for Relationship instances.

The first argument tells which Relationship type should be returned. If you provide the Relationship base interface any Relationship instance that matches the provided query parameters will be returned.

Parameters:

identityType -

Returns: