Package com.polarion.alm.projects

Interface IProjectManagementJobUnit

All Superinterfaces:
IJobUnit
public interface IProjectManagementJobUnit extends IJobUnit
IJobUnit which allows to create, delete, unmark, move and mark projects.

If multiple operations are requested, they are executed in the following order: delete, create, unmark, move, mark.

Since:
3.3.0
Version:
$Revision$ $Date$
Author:
Stepan Roh
See Also:

  • Field Details

  • Method Details

    • setProject

      void setProject(String projectId)
      Required job parameter: id of project to create/delete/mark/unmark.
      Parameters:
      projectId - project id (not null)

    • getProject

      @NotNull String getProject()
      Returns:
      project id
      Since:
      3.23.10

    • setLocation

      void setLocation(ILocation location)
      Job parameter: repository location of project to be marked.

      Required if setMark(boolean) is true, ignored otherwise.

      Parameters:
      location - project location (not null)

    • setCreate

      void setCreate(boolean create)
      Job parameter: whether to create the project first.
      Parameters:
      create - true to create the project first, false (default) otherwise
      Since:
      3.23.10

    • setDelete

      void setDelete(boolean delete)
      Job parameter: whether to delete the project.
      Parameters:
      delete - true to delete the project, false (default) otherwise
      Since:
      3.23.10

    • setUnmark

      void setUnmark(boolean unmark)
      Job parameter: whether to unmark the project (always happens after create if that was requested).
      Parameters:
      unmark - true to unmark the project, false (default) otherwise

    • setMark

      void setMark(boolean mark)
      Job parameter: whether to mark the project (always happens after unmark if that was requested).
      Parameters:
      mark - true to mark the project, false (default) otherwise

    • setMoveFolder

      void setMoveFolder(boolean moveFolder)
      Job parameter: whether to move project's folder after unmark.

      Is done only if both setMark(boolean) and setUnmark(boolean) are true, ignored otherwise.

      Parameters:
      moveFolder - true to move the project's folder, false (default) otherwise

    • setTemplateId

      void setTemplateId(String templateId)
      Job parameter: project template id.

      Not part of job descriptor.

      Parameters:
      templateId - The template's ID or null (default)

    • setTemplateParameters

      void setTemplateParameters(Map<String,String> parameters)
      Job parameter: project template parameters.

      Not part of job descriptor.

      Parameters:
      parameters - template parameters or null (default)