org.jboss.picketlink.idm.model
Interface Group

All Superinterfaces:

IdentityType

All Known Implementing Classes:

SimpleGroup

public interface Group
extends IdentityType

Group representation

Field Summary

static String

KEY_PREFIX

Method Summary

String	getId() Groups are stored in tree hierarchy and therefore ID represents a path.
String	getName() Group name is unique identifier in specific group tree branch.
Group	getParentGroup()

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

getAttribute, getAttributes, getAttributeValues, getCreationDate, getExpirationDate, getKey, isEnabled, removeAttribute, setAttribute, setAttribute

Field Detail

KEY_PREFIX

static final String KEY_PREFIX

See Also:

Constant Field Values

Method Detail

getId

String getId()

Groups are stored in tree hierarchy and therefore ID represents a path. ID string always begins with "/" element that represents root of the tree

Example: Valid IDs are "/acme/departments/marketing", "/security/administrator" or "/administrator". Where "acme", "departments", "marketing", "security" and "administrator" are group names.

Returns:

Group Id in String representation.

getName

String getName()

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

Returns:

name

getParentGroup

Group getParentGroup()

Returns:

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