org.onehippo.repository.security

Interface Group

public interface Group

Represents a group of Users in the repository.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Get the description property of this group.
String	getId() Get the id of the group.
Iterable<User>	getMembers() Get the members of this group.
String	getProperty(String propertyName) Get an external group property by name.
boolean	isSystemGroup() Whether this group is marked as a system group.

Method Detail

getId

String getId()
      throws javax.jcr.RepositoryException

Get the id of the group.

Returns:

the id of the group

Throws:

javax.jcr.RepositoryException

getMembers

Iterable<User> getMembers()
                   throws javax.jcr.RepositoryException

Get the members of this group.

Returns:

the Users that are members of this group.

Throws:

javax.jcr.RepositoryException

getDescription

String getDescription()
               throws javax.jcr.RepositoryException

Get the description property of this group.

Returns:

the description property of this group, or null if not present

Throws:

javax.jcr.RepositoryException

isSystemGroup

boolean isSystemGroup()
               throws javax.jcr.RepositoryException

Whether this group is marked as a system group.

Returns:

whether this group is a system group

Throws:

javax.jcr.RepositoryException

getProperty

String getProperty(String propertyName)
            throws javax.jcr.RepositoryException

Get an external group property by name.

Returns:

the external property of the group identified by propertyName, or null if not present

Throws:

javax.jcr.RepositoryException