Project: stp
javax.wvcm

Interface ControllableResource

Parameters:
flags - Array of boolean flags (may be null):
  • ControllableResource.CheckinFlag.KEEP_CHECKED_OUT indicates whether to checkout the resource again immediately after checking it in. If true, the ACTIVITY and RESERVED properties should not be changed by the checkout.
  • ControllableResource.CheckinFlag.FORK_OK indicates whether to fork even if forking is discouraged.
  • ControllableResource.CheckinFlag.CHECKIN_IDENTICAL will force a checkin even if the controlled state is the same as its CHECKED_IN version. Otherwise, an uncheckout will be performed if the controlled state of this resource is the same as its CHECKED_IN version, and if the PREDECESSOR_LIST only contains the CHECKED_OUT version.
  • feedback - Specifies optional feedback to the caller.
    Returns:
    A new proxy for this resource, whose properties are specified by feedback.
    Throws:
    WvcmException - ReasonCode:
  • WvcmException.ReasonCode.MUST_BE_CHECKED_OUT: This ControllableResource MUST identify a resource whose IS_CHECKED_OUT property is true.
  • WvcmException.ReasonCode.VERSION_HISTORY_MUST_BE_A_TREE: The versions identified by the PREDECESSOR_LIST, MERGE_LIST and AUTO_MERGE_LIST of the checked-out resource MUST be descendants of the root version of the version history for the CHECKED_OUT version.
  • WvcmException.ReasonCode.CANNOT_FORK: A doCheckin request MUST fail if it would cause a version whose Version.CHECKIN_FORK is Version.Fork.FORBIDDEN to appear in the Version.PREDECESSOR_LIST of more than one version.
  • WvcmException.ReasonCode.CANNOT_CHECKIN_FORK_DISCOURAGED: A doCheckin request MUST fail if it would cause a version whose Version.CHECKIN_FORK is Version.Fork.DISCOURAGED to appear in the Version.PREDECESSOR_LIST of more than one version, unless forkOk is specified in the request.
  • WvcmException.ReasonCode.CANNOT_CREATE_BRANCH_IN_ACTIVITY: Any version which is in the version history of the checked-out resource and whose Version.ACTIVITY identifies the ACTIVITY of the checked-out resource MUST be an ancestor of the checked-out resource.
  • @WvcmException.ReasonCode.CANNOT_CHECKIN_TO_RESERVED_ACTIVITY If in another workspace there is a version-controlled resource whose CHECKED_OUT property identifies a version in the version history of this resource, then the RESERVED property of that version-controlled resource MUST be true.
  • WvcmException.ReasonCode.NO_CHECKED_OUT_BASELINE_CONTROLLED_FOLDER_MEMBERS: If this ControllableResource identifies a configuration, all version-controlled members of the Configuration.ROOT_FOLDER of the configuration MUST be checked-in.
  • WvcmException.ReasonCode.CANNOT_CREATE_BRANCH_IN_STREAM: If the Stream.VERSION_LIST of the Workspace.STREAM of this ControllableResource contains a version from the version history of this controllable resource, then the Stream.VERSION_LIST MUST contain one of the versions in the PREDECESSOR_LIST of this controllable resource.
  • Parameters:
    flags - Array of boolean flags (may be null):
    feedback - Specifies optional feedback to the caller.
    Returns:
    A new proxy for this resource, whose properties are specified by feedback.
    Throws:
    WvcmException - ReasonCode:
  • WvcmException.ReasonCode.MUST_BE_CHECKED_IN: The IS_CHECKED_OUT property of this ControllableResource MUST be false.
  • WvcmException.ReasonCode.CANNOT_CHECKOUT_FORKING_IS_FORBIDDEN: If the Version.CHECKOUT_FORK property of the version being checked out is Version.Fork.FORBIDDEN, the request MUST fail if the checked-out version has a non-empty list of successors.
  • WvcmException.ReasonCode.CANNOT_CHECKOUT_FORKING_IS_DISCOURAGED: If the Version.CHECKOUT_FORK property of the version being checked out is Version.Fork.DISCOURAGED, the request MUST fail if the checked-out version has a non-empty list of successors unless forkOk is specified in the request.
  • WvcmException.ReasonCode.CANNOT_CHECKOUT_MULTI_CHECKOUT_IS_DISCOURAGED: If the Version.CHECKOUT_FORK property of the version being checked out is Version.Fork.DISCOURAGED, the request MUST fail if a checked-out resource identifies that version in its CHECKED_OUT property unless forkOk is specified in the request.
  • WvcmException.ReasonCode.CANNOT_CHECKOUT_MULTI_CHECKOUT_IS_FORBIDDEN: If the Version.CHECKOUT_FORK property of the version being checked out is Version.Fork.FORBIDDEN, the request MUST fail if a checked-out resource identifies that version in its CHECKED_OUT property.
  • WvcmException.ReasonCode.ONE_CHECKOUT_PER_ACTIVITY_PER_HISTORY: If there is a request activity set, and if Reserved is specified, an existing reserved checkout from a version of that version history MUST NOT select an activity in that activity set.
  • WvcmException.ReasonCode.CANNOT_CREATE_BRANCH_IN_ACTIVITY: If there is a request activity set, and if Reserved is specified, the selected version MUST be a descendant of all other versions of that version history that select that activity.
  • WvcmException.ReasonCode.CANNOT_CREATE_BRANCH_IN_STREAM: If the Workspace.STREAM property of the workspace of this controllable resource is non-null, one of the following MUST be true:
    - the Stream.VERSION_LIST of the stream contains no version from the version history of the CHECKED_IN version.
    - the Stream.VERSION_LIST of the stream contains the CHECKED_IN version,
    - the ControllableResource.CheckoutFlag.RESERVED was not specified in the flags argument.
  • WvcmException.ReasonCode.BAD_ARGUMENT_TYPE: If the controllable resource is a configuration, and there is a request activity set, the activity argument MUST identify a stream; otherwise, the activity MUST identify an activity.
  • Generated Sat 3-Jun-2017 12:50 AM

    Copyright © IBM 2017. All rights reserved.