com.google.gerrit.extensions.api.groups

Class GroupApi.NotImplemented

java.lang.Object

com.google.gerrit.extensions.api.groups.GroupApi.NotImplemented

All Implemented Interfaces:

GroupApi

Enclosing interface:

GroupApi

public static class GroupApi.NotImplemented
extends java.lang.Object
implements GroupApi

A default implementation which allows source compatibility when adding new methods to the interface.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.gerrit.extensions.api.groups.GroupApi

GroupApi.NotImplemented

Constructor Summary

Constructors

Constructor and Description
NotImplemented()

Method Summary

Modifier and Type	Method and Description
void	addGroups(java.util.List<java.lang.String> groups) Adds subgroups to this group.
void	addMembers(java.util.List<java.lang.String> members) Add members to a group.
java.util.List<? extends GroupAuditEventInfo>	auditLog() Returns the audit log of the group.
java.lang.String	description()
void	description(java.lang.String description) Set group decsription.
GroupInfo	detail()
GroupInfo	get()
java.util.List<GroupInfo>	includedGroups() Lists the subgroups of this group.
void	index() Reindexes the group.
java.util.List<AccountInfo>	members() List group members, non-recursively.
java.util.List<AccountInfo>	members(boolean recursive) List group members.
java.lang.String	name()
void	name(java.lang.String name) Set group name.
GroupOptionsInfo	options()
void	options(GroupOptionsInfo options) Set group options.
GroupInfo	owner()
void	owner(java.lang.String owner) Set group owner.
void	removeGroups(java.util.List<java.lang.String> groups) Removes subgroups from this group.
void	removeMembers(java.util.List<java.lang.String> members) Remove members from a group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.gerrit.extensions.api.groups.GroupApi

addGroups, addMembers, removeGroups, removeMembers

Constructor Detail

NotImplemented

public NotImplemented()

Method Detail

get

public GroupInfo get()
              throws RestApiException

Specified by:

get in interface GroupApi

Returns:

group info with no ListGroupsOptions set.

Throws:

RestApiException

detail

public GroupInfo detail()
                 throws RestApiException

Specified by:

detail in interface GroupApi

Returns:

group info with all ListGroupsOptions set.

Throws:

RestApiException

name

public java.lang.String name()
                      throws RestApiException

Specified by:

name in interface GroupApi

Returns:

group name.

Throws:

RestApiException

name

public void name(java.lang.String name)
          throws RestApiException

Description copied from interface: GroupApi

Set group name.

Specified by:

name in interface GroupApi

Parameters:

name - new name.

Throws:

RestApiException

owner

public GroupInfo owner()
                throws RestApiException

Specified by:

owner in interface GroupApi

Returns:

owning group info.

Throws:

RestApiException

owner

public void owner(java.lang.String owner)
           throws RestApiException

Description copied from interface: GroupApi

Set group owner.

Specified by:

owner in interface GroupApi

Parameters:

owner - identifier of new group owner.

Throws:

RestApiException

description

public java.lang.String description()
                             throws RestApiException

Specified by:

description in interface GroupApi

Returns:

group description.

Throws:

RestApiException

description

public void description(java.lang.String description)
                 throws RestApiException

Description copied from interface: GroupApi

Set group decsription.

Specified by:

description in interface GroupApi

Parameters:

description - new description.

Throws:

RestApiException

options

public GroupOptionsInfo options()
                         throws RestApiException

Specified by:

options in interface GroupApi

Returns:

group options.

Throws:

RestApiException

options

public void options(GroupOptionsInfo options)
             throws RestApiException

Description copied from interface: GroupApi

Set group options.

Specified by:

options in interface GroupApi

Parameters:

options - new options.

Throws:

RestApiException

members

public java.util.List<AccountInfo> members()
                                    throws RestApiException

Description copied from interface: GroupApi

List group members, non-recursively.

Specified by:

members in interface GroupApi

Returns:

group members.

Throws:

RestApiException

members

public java.util.List<AccountInfo> members(boolean recursive)
                                    throws RestApiException

Description copied from interface: GroupApi

List group members.

Specified by:

members in interface GroupApi

Parameters:

recursive - whether to recursively included groups.

Returns:

group members.

Throws:

RestApiException

addMembers

public void addMembers(java.util.List<java.lang.String> members)
                throws RestApiException

Description copied from interface: GroupApi

Add members to a group.

Specified by:

addMembers in interface GroupApi

Parameters:

members - list of member identifiers, in any format accepted by Accounts.id(String)

Throws:

RestApiException

removeMembers

public void removeMembers(java.util.List<java.lang.String> members)
                   throws RestApiException

Description copied from interface: GroupApi

Remove members from a group.

Specified by:

removeMembers in interface GroupApi

Parameters:

members - list of member identifiers, in any format accepted by Accounts.id(String)

Throws:

RestApiException

includedGroups

public java.util.List<GroupInfo> includedGroups()
                                         throws RestApiException

Description copied from interface: GroupApi

Lists the subgroups of this group.

Specified by:

includedGroups in interface GroupApi

Returns:

the found subgroups

Throws:

RestApiException

addGroups

public void addGroups(java.util.List<java.lang.String> groups)
               throws RestApiException

Description copied from interface: GroupApi

Adds subgroups to this group.

Specified by:

addGroups in interface GroupApi

Parameters:

groups - list of group identifiers, in any format accepted by Groups.id(String)

Throws:

RestApiException

removeGroups

public void removeGroups(java.util.List<java.lang.String> groups)
                  throws RestApiException

Description copied from interface: GroupApi

Removes subgroups from this group.

Specified by:

removeGroups in interface GroupApi

Parameters:

groups - list of group identifiers, in any format accepted by Groups.id(String)

Throws:

RestApiException

auditLog

public java.util.List<? extends GroupAuditEventInfo> auditLog()
                                                       throws RestApiException

Description copied from interface: GroupApi

Returns the audit log of the group.

Specified by:

auditLog in interface GroupApi

Returns:

list of audit events of the group.

Throws:

RestApiException

index

public void index()
           throws RestApiException

Description copied from interface: GroupApi

Reindexes the group.

Only supported for internal groups.

Specified by:

index in interface GroupApi

Throws:

RestApiException