Package com.polarion.alm.ws.client.planning

Interface PlanningWebService

All Superinterfaces:
Remote
public interface PlanningWebService extends Remote

  • Method Details

    • addPlanAllowedType

      void addPlanAllowedType(String uri, EnumOptionId workItemType) throws RemoteException
      Adds specified work item type to allowed types in Plan.
      Parameters:
      uri - URI of the Plan (not null)
      workItemType - work item type to add (not null)
      Throws:
      RemoteException
      Since:
      3.9.0

    • addPlanItems

      void addPlanItems(String uri, String[] items) throws RemoteException
      Adds plan records to the plan
      Parameters:
      uri - the SubterraURI of the plan to add the items to
      items - an array containing the uris of all the work items to be added
      Throws:
      RemoteException
      Since:
      3.8.0

    • addProjectToPlanProjectSpan

      void addProjectToPlanProjectSpan(String uri, String projectId) throws RemoteException
      Adds specified Project to project span of the Plan.
      Parameters:
      uri - URI of the Plan (not null)
      projectId - project ID (not null)
      Throws:
      RemoteException
      Since:
      3.9.0

    • createPlan

      String createPlan(String projectId, String name, String id, String parentId, String templateId) throws RemoteException
      Creates a new plan
      Parameters:
      projectId - The project the plan will be created in
      name - The name of the plan
      id - The id of the plan
      parentId - The id of the parent plan (can be null)
      templateId - The id of the template used for this plan
      Returns:
      URI of the created plan.
      Throws:
      RemoteException
      Since:
      3.8.0

    • createPlanTemplate

      String createPlanTemplate(String projectId, String name, String id, String templateId) throws RemoteException
      Creates a new plan template
      Parameters:
      projectId - The project the plan template will be created in
      name - The name of the plan
      id - The id of the plan
      templateId - The id of the template used for this template (can be null)
      Returns:
      URI of the created plan.
      Throws:
      RemoteException
      Since:
      3.8.0

    • deletePlans

      void deletePlans(String projectId, String[] ids) throws RemoteException
      Delete plans
      Parameters:
      projectId - the project the plans will be deleted in
      ids - the array of ids to be deleted
      Throws:
      RemoteException
      Since:
      3.8.0

    • getPlanById

      Plan getPlanById(String projectId, String id) throws RemoteException
      Returns a specific plan
      Parameters:
      projectId - ID of the project that contains the specific plan
      id - ID of the plan
      Returns:
      the plan
      Throws:
      RemoteException
      Since:
      3.8.0

    • getPlanByUri

      Plan getPlanByUri(String uri) throws RemoteException
      Returns a specific plan
      Parameters:
      uri - the SubterraURI of the plan to load
      Returns:
      the plan
      Throws:
      RemoteException
      Since:
      3.8.0

    • getPlanStatistics

      PlanStatistics getPlanStatistics(String uri) throws RemoteException
      Get statistics of the plan
      Parameters:
      uri - the SubterraURI of the plan to get the statistics from
      Returns:
      the statistics of plan with given SubterraURI
      Throws:
      RemoteException
      Since:
      3.8.0

    • getPlanWikiContent

      Text getPlanWikiContent(String uri) throws RemoteException
      Returns the wiki content of plan with given uri
      Parameters:
      uri - the SubterraURI of the plan
      Returns:
      the wikipage content of the plan with given id
      Throws:
      RemoteException
      Since:
      3.8.0

    • removePlanAllowedType

      void removePlanAllowedType(String uri, EnumOptionId workItemType) throws RemoteException
      Removes all occurrences of specified work item type from allowed types in Plan.
      Parameters:
      uri - URI of the Plan (not null)
      workItemType - work item type to remove (not null)
      Throws:
      RemoteException
      Since:
      3.9.0

    • removePlanItems

      void removePlanItems(String uri, String[] items) throws RemoteException
      Remove plan records to the plan
      Parameters:
      uri - the SubterraURI of the plan to delete the items from
      items - an array containing the uris of all the work items to be removed
      Throws:
      RemoteException
      Since:
      3.8.0

    • removeProjectFromPlanProjectSpan

      void removeProjectFromPlanProjectSpan(String uri, String projectId) throws RemoteException
      Removes all occurrences of specified Project from project span of the Plan.
      Parameters:
      uri - URI of the Plan (not null)
      projectId - project ID (not null)
      Throws:
      RemoteException
      Since:
      3.9.0

    • searchPlanTemplates

      Plan[] searchPlanTemplates(String query, String sort, int resultsLimit) throws RemoteException
      Search plan templates.
      Parameters:
      query - the query used to find plan templates (can be null)
      sort - the format is same as for IIndexSearch.sort(String).
      resultsLimit - the maximum number of records to be returned, -1 for no limit.
      Returns:
      the found plan templates.
      Throws:
      RemoteException
      Since:
      3.8.0

    • searchPlanTemplatesWithFields

      Plan[] searchPlanTemplatesWithFields(String query, String sort, int resultsLimit, String[] fields) throws RemoteException
      Search plan templates with only fields specified filled with values. All other fields are not transmitted.
      Parameters:
      query - the query used to find plan templates (can be null)
      sort - the format is same as for IIndexSearch.sort(String).
      resultsLimit - the maximum number of records to be returned, -1 for no limit.
      fields - plan template fields that should be initialized, all other fields will be null.
      Returns:
      the found plan templates with filled specified fields.
      Throws:
      RemoteException
      Since:
      3.8.0

    • searchPlans

      Plan[] searchPlans(String query, String sort, int resultsLimit) throws RemoteException
      Search plans.
      Parameters:
      query - the query used to find plans (can be null)
      sort - the format is same as for IIndexSearch.sort(String).
      resultsLimit - the maximum number of records to be returned, -1 for no limit.
      Returns:
      the found plans.
      Throws:
      RemoteException
      Since:
      3.8.0

    • searchPlansWithFields

      Plan[] searchPlansWithFields(String query, String sort, int resultsLimit, String[] fields) throws RemoteException
      Search plans with only fields specified filled with values. All other fields are not transmitted.
      Parameters:
      query - the query used to find plans (can be null)
      sort - the format is same as for IIndexSearch.sort(String).
      resultsLimit - the maximum number of records to be returned, -1 for no limit.
      fields - plan fields that should be initialized, all other fields will be null.
      Returns:
      the found plans with filled specified fields.
      Throws:
      RemoteException
      Since:
      3.8.0

    • setPlanWikiContent

      void setPlanWikiContent(String uri, Text text) throws RemoteException
      Sets the wiki content of plan with given uri
      Parameters:
      uri - the SubterraURI of the plan
      text - the new content for plans wikipage
      Throws:
      RemoteException
      Since:
      3.8.0

    • updatePlan

      void updatePlan(Plan content) throws RemoteException
      Updates a plan.
      Parameters:
      content - a plan object containing the updates, the content must contain the uri of the plan to be update or else the update will fail
      Throws:
      RemoteException
      Since:
      3.8.0

    • wasPlanStarted

      boolean wasPlanStarted(String uri) throws RemoteException
      Checks if the plan was started
      Parameters:
      uri - the SubterraURI of the plan
      Returns:
      true if plan exists and is started, false otherwise
      Throws:
      RemoteException
      Since:
      3.8.0