org.picketlink.idm.model

Interface Group

All Superinterfaces:

AttributedType, IdentityType, Serializable

All Known Implementing Classes:

SimpleGroup

public interface Group
extends IdentityType, Serializable

Group representation

Nested Class Summary

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

AttributedType.ATTRIBUTE, AttributedType.AttributeParameter

Field Summary

Fields

Modifier and Type	Field and Description
static QueryParameter	NAME A query parameter used to set the name value.
static QueryParameter	PARENT A query parameter used to set the parent value.
static QueryParameter	PATH A query parameter used to set the path.

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

CREATED_AFTER, CREATED_BEFORE, CREATED_DATE, ENABLED, EXPIRY_AFTER, EXPIRY_BEFORE, EXPIRY_DATE, GROUP_ROLE_OF, HAS_GROUP_ROLE, HAS_MEMBER, HAS_ROLE, MEMBER_OF, PARTITION, ROLE_OF

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

ID

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Group name is unique identifier in specific group tree branch.
Group	getParentGroup()
String	getPath()
void	setParentGroup(Group group) Sets the parent group.

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

getCreatedDate, getExpirationDate, getPartition, isEnabled, setCreatedDate, setEnabled, setExpirationDate, setPartition

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

getAttribute, getAttributes, getId, removeAttribute, setAttribute, setId

Field Detail

NAME

static final QueryParameter NAME

A query parameter used to set the name value.

PATH

static final QueryParameter PATH

A query parameter used to set the path.

PARENT

static final QueryParameter PARENT

A query parameter used to set the parent value.

Method Detail

getName

String getName()

Group name is unique identifier in specific group tree branch. For example group with path "/acme/departments/marketing" will have name "marketing" and parent group path of "/acme/departments"

Returns:

name

getParentGroup

Group getParentGroup()

Returns:

parent group or null if it refers to root ("/") in a group tree.

setParentGroup

void setParentGroup(Group group)

Sets the parent group.

Parameters:

group -

getPath

String getPath()

Returns:

group path (eg.: /parentGroup/childGroup.