com.nulabinc.backlog4j.api

Interface GroupMethods

All Known Subinterfaces:

BacklogClient

All Known Implementing Classes:

BacklogClientImpl

public interface GroupMethods

Executes Backlog Group APIs.

Method Summary

Modifier and Type	Method and Description
Group	createGroup(CreateGroupParams params) Creates a group.
Group	deleteGroup(java.lang.Object groupId) Deletes the existing groups.
Group	getGroup(java.lang.Object groupId) Returns the groups identified by the group's id.
ResponseList<Group>	getGroups() Returns all the groups.
ResponseList<Group>	getGroups(OffsetParams params) Returns all the groups.
Group	updateGroup(UpdateGroupParams params) Updates the existing group.

Method Detail

getGroups

ResponseList<Group> getGroups()
                       throws BacklogException

Returns all the groups.

Returns:

the groups in a list.

Throws:

BacklogException

getGroups

ResponseList<Group> getGroups(OffsetParams params)
                       throws BacklogException

Returns all the groups.

Parameters:

params - the offset parameters

Returns:

the groups in a list.

Throws:

BacklogException

createGroup

Group createGroup(CreateGroupParams params)
           throws BacklogException

Creates a group.

Parameters:

params - the group creating parameters

Returns:

the created Group

Throws:

BacklogException

getGroup

Group getGroup(java.lang.Object groupId)
        throws BacklogException

Returns the groups identified by the group's id.

Parameters:

groupId - the group identifier

Returns:

the Group.

Throws:

BacklogException

updateGroup

Group updateGroup(UpdateGroupParams params)
           throws BacklogException

Updates the existing group.

Parameters:

params - the group updating parameters

Returns:

the updated Group.

Throws:

BacklogException

deleteGroup

Group deleteGroup(java.lang.Object groupId)
           throws BacklogException

Deletes the existing groups.

Parameters:

groupId - the group identifier

Returns:

the deleted Group.

Throws:

BacklogException