Project: stp

com.ibm.rational.wvcm.stp.cc
Enum CcFile.CcCheckoutFlag

Object
  extended by Enum<CcFile.CcCheckoutFlag>
      extended by CcFile.CcCheckoutFlag
All Implemented Interfaces:
com.ibm.rational.wvcm.stpex.StpExEnumeration, Serializable, Comparable<CcFile.CcCheckoutFlag>
Enclosing interface:
CcFile

public static enum CcFile.CcCheckoutFlag
extends Enum<CcFile.CcCheckoutFlag>
implements com.ibm.rational.wvcm.stpex.StpExEnumeration

Flags for the doCheckout method.


Enum Constant Summary
FALLBACK_TO_UNRESERVED
          Fall back to unreserved if a reservation can not be obtained.
LATEST_NOT_LOADED
          Checkout the version of the file that is selected by the view's config spec.
LOADED_NOT_LATEST
          Checkout the version of the file that is currently loaded in the view, even if that version is not the version selected by the view's config spec.
NON_MASTERED_OK
          Indicates whether to checkout this file even if the currently selected branch is mastered by another replica.
PRESERVE_HIJACK_CONTENTS
          If the file is hijacked, keep the hijacked contents upon checkout.
PRESERVE_MODIFICATION_TIME
          After a file is 'checkedout', set the file's "last modified" time to be the time when the version was first created.
RESERVED
          Indicates whether to checkout this file reserved.
 
Method Summary
 String toString()
           
static CcFile.CcCheckoutFlag valueOf(String name)
          Returns the enum constant of this type with the specified name.
static CcFile.CcCheckoutFlag[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

FALLBACK_TO_UNRESERVED

public static final CcFile.CcCheckoutFlag FALLBACK_TO_UNRESERVED
Fall back to unreserved if a reservation can not be obtained.


LATEST_NOT_LOADED

public static final CcFile.CcCheckoutFlag LATEST_NOT_LOADED
Checkout the version of the file that is selected by the view's config spec. If this version is not loaded at checkout time, then load it prior to performing the checkout.

If the loaded version is not the version selected by the view's config spec, and neither LOADED_NOT_LATEST nor LATEST_NOT_LOADED flags are set, the checkout operation will throw an exception with reason code CHECKOUT_NOT_LATEST.


LOADED_NOT_LATEST

public static final CcFile.CcCheckoutFlag LOADED_NOT_LATEST
Checkout the version of the file that is currently loaded in the view, even if that version is not the version selected by the view's config spec.

If the loaded version is not the version selected by the view's config spec, and neither LOADED_NOT_LATEST nor LATEST_NOT_LOADED flags are set, the checkout operation will throw an exception with reason code CHECKOUT_NOT_LATEST.


NON_MASTERED_OK

public static final CcFile.CcCheckoutFlag NON_MASTERED_OK
Indicates whether to checkout this file even if the currently selected branch is mastered by another replica. The RESERVED flag must NOT be set with this flag.

If the file is mastered by this replica, setting this flag has no effect.


PRESERVE_HIJACK_CONTENTS

public static final CcFile.CcCheckoutFlag PRESERVE_HIJACK_CONTENTS
If the file is hijacked, keep the hijacked contents upon checkout.


PRESERVE_MODIFICATION_TIME

public static final CcFile.CcCheckoutFlag PRESERVE_MODIFICATION_TIME
After a file is 'checkedout', set the file's "last modified" time to be the time when the version was first created.

This applies only to dynamic views.


RESERVED

public static final CcFile.CcCheckoutFlag RESERVED
Indicates whether to checkout this file reserved.

Method Detail

toString

public String toString()
Overrides:
toString in class Enum<CcFile.CcCheckoutFlag>

valueOf

public static CcFile.CcCheckoutFlag valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

values

public static CcFile.CcCheckoutFlag[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (CcFile.CcCheckoutFlag c : CcFile.CcCheckoutFlag.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

Generated Fri 13-Jun-2014 11:11 PM

Copyright © IBM 2014. All rights reserved.