Package com.collabnet.ce.soap60.webservices.team

# Interface ITeamAppSoap

All Known Implementing Classes:
  `TeamAppSoap`, `TeamAppSoapMockStub`, `TeamAppSoapStub`

public interface ITeamAppSoap

- ## Method Summary

  Modifier and Type
  Method
  Description
  `TeamSoapDO`
  `createTeam(String sessionId, String projectId, String title, String description, String parentTeamId, String teamOwnerUserName, String[] memberUserNames)`
  Creates a new team
  `void`
  `deleteTeam(String sessionId, String teamId)`
  Delete the team if team has no child
  `TeamSoapList`
  `getChildTeamList(String sessionId, String parentTeamId)`
  Get list of child teams specific to parent team
  `TeamSoapDO`
  `getTeamData(String sessionId, String teamId)`
  Get the team data for a team id.
  `TeamSoapList`
  `getTeamListForProject(String sessionId, String projectId)`
  Get list of teams specific to project
  `UserSoapList`
  `getTeamMemberList(String sessionId, String teamId)`
  Get list of team members specific to team
  `void`
  `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 team
      `title` - The title of the new team
      `description` - The description of the new team
      `parentTeamId` - The id of the parent team
      `teamOwnerUserName` - The team owner name
      `memberUserNames` - 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

    TeamSoapDO getTeamData(String sessionId, String teamId) throws RemoteException
    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

    void deleteTeam(String sessionId, String teamId) throws RemoteException
    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

    TeamSoapList getTeamListForProject(String sessionId, String projectId) throws RemoteException
    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

    TeamSoapList getChildTeamList(String sessionId, String parentTeamId) throws RemoteException
    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

    UserSoapList getTeamMemberList(String sessionId, String teamId) throws RemoteException
    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