Interface ITeamAppSoap
- All Known Implementing Classes:
TeamAppSoap
,TeamAppSoapMockStub
,TeamAppSoapStub
public interface ITeamAppSoap
-
Method Summary
Modifier and TypeMethodDescriptioncreateTeam
(String sessionId, String projectId, String title, String description, String parentTeamId, String teamOwnerUserName, String[] memberUserNames) Creates a new teamvoid
deleteTeam
(String sessionId, String teamId) Delete the team if team has no childgetChildTeamList
(String sessionId, String parentTeamId) Get list of child teams specific to parent teamgetTeamData
(String sessionId, String teamId) Get the team data for a team id.getTeamListForProject
(String sessionId, String projectId) Get list of teams specific to projectgetTeamMemberList
(String sessionId, String teamId) Get list of team members specific to teamvoid
setTeamData
(String sessionId, String teamId, String title, String description, String teamOwnerUserName, String[] memberUserNames, int version) Update team data for given team Id
-
Method Details
-
createTeam
TeamSoapDO createTeam(String sessionId, String projectId, String title, String description, String parentTeamId, String teamOwnerUserName, String[] memberUserNames) throws RemoteException Creates a new team- Parameters:
sessionId
- User session id.projectId
- The id of the project under which to create the new teamtitle
- The title of the new teamdescription
- The description of the new teamparentTeamId
- The id of the parent teamteamOwnerUserName
- The team owner namememberUserNames
- The members of the team- Returns:
- the team soap object
- Throws:
InvalidSessionFault
- when the specified session id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.NoSuchObjectFault
- when the specified object id is invalid.ObjectAlreadyExistsFault
- if an existing team already exists.IllegalArgumentFault
- if invalid argument value was supplied.InvalidProjectFault
- if invalid project id value was supplied.InvalidTeamFault
- if invalid team id value was supplied.RemoteException
- Since:
- 8.0
-
setTeamData
void setTeamData(String sessionId, String teamId, String title, String description, String teamOwnerUserName, String[] memberUserNames, int version) throws RemoteException Update team data for given team Id- Parameters:
sessionId
- User session id.teamId
- The team Id.title
- The team title.description
- The team description.teamOwnerUserName
- The team owner user name.memberUserNames
- The member user names.version
- The version number.- Throws:
InvalidSessionFault
- when the specified session id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.NoSuchObjectFault
- when the specified object id is invalid.ObjectAlreadyExistsFault
- if an existing team already exists.IllegalArgumentFault
- if invalid argument value was supplied.InvalidTeamFault
- if invalid team id value was supplied.VersionMismatchFault
- if invalid version number was supplied.RemoteException
- Since:
- 8.0
-
getTeamData
Get the team data for a team id.- Parameters:
sessionId
- User session id.teamId
- The team id.- Returns:
- the team soap object
- Throws:
InvalidSessionFault
- when the specified session id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.NoSuchObjectFault
- when the specified object id is invalid.ObjectAlreadyExistsFault
- if an existing team already exists.IllegalArgumentFault
- if invalid argument value was supplied.RemoteException
- Since:
- 8.0
-
deleteTeam
Delete the team if team has no child- Parameters:
sessionId
- User session id.teamId
- The team id.- Throws:
InvalidSessionFault
- when the specified session id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.NoSuchObjectFault
- when the specified object id is invalid.IllegalArgumentFault
- if invalid argument value was supplied.DeleteTeamFault
- if team has child.RemoteException
- Since:
- 8.0
-
getTeamListForProject
Get list of teams specific to project- Parameters:
sessionId
- User session id.projectId
- The id of the project under which to create the new team.- Returns:
- list of team for project.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.NoSuchObjectFault
- when the specified object id is invalid.ObjectAlreadyExistsFault
- if an existing team already exists.IllegalArgumentFault
- if invalid argument value was supplied.InvalidProjectFault
- if invalid project id value was supplied.RemoteException
- Since:
- 8.0
-
getChildTeamList
Get list of child teams specific to parent team- Parameters:
sessionId
- User session id.parentTeamId
- The parent team id.- Returns:
- list of child teams for given parent team id.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.NoSuchObjectFault
- when the specified object id is invalid.ObjectAlreadyExistsFault
- if an existing team already exists.IllegalArgumentFault
- if invalid argument value was supplied.RemoteException
- Since:
- 8.0
-
getTeamMemberList
Get list of team members specific to team- Parameters:
sessionId
- User session id.teamId
- The team id.- Returns:
- list of team members
- Throws:
InvalidSessionFault
- when the specified session id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.SystemFault
- when an unexpected system error occurs.NoSuchObjectFault
- when the specified object id is invalid.ObjectAlreadyExistsFault
- if an existing team already exists.IllegalArgumentFault
- if invalid argument value was supplied.RemoteException
- Since:
- 8.0
-