public String setExpiryTime()

in taverna-server-webapp/src/main/java/org/apache/taverna/server/master/rest/TavernaServerRunREST.java [265:435]

• 80 lines of code
• 1 McCabe index (conditional complexity)

	public String setExpiryTime(@Nonnull String expiry)
			throws NoUpdateException;

	/** Get an outline of the operations supported. */
	@OPTIONS
	@Path(T_EXPIRE)
	@Description("Produces the description of the run expiry.")
	Response expiryOptions();

	/**
	 * Returns the time when the workflow run was created.
	 * 
	 * @return When the run was first submitted to the server.
	 */
	@GET
	@Path(T_CREATE)
	@Produces(TEXT)
	@Description("Gives the time when the workflow run was first submitted "
			+ "to the server.")
	@Nonnull
	public String getCreateTime();

	/** Get an outline of the operations supported. */
	@OPTIONS
	@Path(T_CREATE)
	@Description("Produces the description of the run create time.")
	Response createTimeOptions();

	/**
	 * Returns the time when the workflow run was started (through a user-driven
	 * state change).
	 * 
	 * @return When the run was started, or <tt>null</tt>.
	 */
	@GET
	@Path(T_START)
	@Produces(TEXT)
	@Description("Gives the time when the workflow run was started, or an "
			+ "empty string if the run has not yet started.")
	@Nonnull
	public String getStartTime();

	/** Get an outline of the operations supported. */
	@OPTIONS
	@Path(T_START)
	@Description("Produces the description of the run start time.")
	Response startTimeOptions();

	/**
	 * Returns the time when the workflow run was detected to have finished.
	 * 
	 * @return When the run finished, or <tt>null</tt>.
	 */
	@GET
	@Path(T_FINISH)
	@Produces(TEXT)
	@Description("Gives the time when the workflow run was first detected as "
			+ "finished, or an empty string if it has not yet finished "
			+ "(including if it has never started).")
	@Nonnull
	public String getFinishTime();

	/** Get an outline of the operations supported. */
	@OPTIONS
	@Path(T_FINISH)
	@Description("Produces the description of the run finish time.")
	Response finishTimeOptions();

	/**
	 * Gets the current status of the workflow run.
	 * 
	 * @return The status code.
	 */
	@GET
	@Path(STATUS)
	@Produces(TEXT)
	@Description("Gives the current status of the workflow run.")
	@Nonnull
	public String getStatus();

	/**
	 * Sets the status of the workflow run. This does nothing if the status code
	 * is the same as the run's current state.
	 * 
	 * @param status
	 *            The new status code.
	 * @return Description of what status the run is actually in, or a 202 to
	 *         indicate that things are still changing.
	 * @throws NoUpdateException
	 *             If the current user is not permitted to update the run.
	 * @throws BadStateChangeException
	 *             If the state cannot be modified in the manner requested.
	 */
	@PUT
	@Path(STATUS)
	@Consumes(TEXT)
	@Produces(TEXT)
	@Description("Attempts to update the status of the workflow run.")
	@Nonnull
	public Response setStatus(@Nonnull String status) throws NoUpdateException,
			BadStateChangeException;

	/** Get an outline of the operations supported. */
	@OPTIONS
	@Path(STATUS)
	@Description("Produces the description of the run status.")
	Response statusOptions();

	/**
	 * Get the working directory of this workflow run.
	 * 
	 * @return A RESTful delegate for the working directory.
	 */
	@Path(DIR)
	@Description("Get the working directory of this workflow run.")
	@Nonnull
	public TavernaServerDirectoryREST getWorkingDirectory();

	/**
	 * Get the event listeners attached to this workflow run.
	 * 
	 * @return A RESTful delegate for the list of listeners.
	 */
	@Path(LISTEN)
	@Description("Get the event listeners attached to this workflow run.")
	@Nonnull
	public TavernaServerListenersREST getListeners();

	/**
	 * Get a delegate for working with the inputs to this workflow run.
	 * 
	 * @param ui
	 *            About the URI used to access this resource.
	 * @return A RESTful delegate for the inputs.
	 */
	@Path(IN)
	@Description("Get the inputs to this workflow run.")
	@Nonnull
	public TavernaServerInputREST getInputs(@Nonnull @Context UriInfo ui);

	/**
	 * Get the output Baclava file for this workflow run.
	 * 
	 * @return The filename, or empty string to indicate that the outputs will
	 *         be written to the <tt>out</tt> directory.
	 */
	@GET
	@Path(OUT)
	@Produces(TEXT)
	@Description("Gives the Baclava file where output will be written; empty "
			+ "means use multiple simple files in the out directory.")
	@Nonnull
	public String getOutputFile();

	/**
	 * Get a description of the outputs.
	 * 
	 * @param ui
	 *            About the URI used to access this operation.
	 * @return A description of the outputs (higher level than the filesystem).
	 * @throws BadStateChangeException
	 *             If the run is in the {@link Status#Initialized Initialized}
	 *             state.
	 * @throws FilesystemAccessException
	 *             If problems occur when accessing the filesystem.
	 * @throws NoDirectoryEntryException
	 *             If things are odd in the filesystem.
	 */
	@GET
	@Path(OUT)
	@Produces({ XML, JSON })