Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.1.0)

E17493-02

oracle.jdeveloper.vcs.generic
Class VCSProfile

java.lang.Object
  extended by oracle.jdeveloper.vcs.spi.VCSExtension
      extended by oracle.jdeveloper.vcs.generic.VCSProfile
All Implemented Interfaces:
ShutdownHook, VCS

public abstract class VCSProfile
extends VCSExtension

Since:
11.1.2.0.0 (Sherman)

Field Summary
static java.lang.String CHANGELIST_CONTEXT_GROUP_CLIPBOARD
           
static java.lang.String CHANGELIST_CONTEXT_GROUP_CONFLICTS
           
static java.lang.String CHANGELIST_CONTEXT_GROUP_DIFF
           
static java.lang.String CHANGELIST_CONTEXT_GROUP_GENERAL
           
static java.lang.String CHANGELIST_CONTEXT_GROUP_OPERATIONS
           
static java.lang.String CHANGELIST_CONTEXT_GROUP_SELECTNAV
           
static java.lang.String EXCEPTION_HANDLER_ID_DEFAULT
           
static java.lang.String HISTORY_PROPERTY_DATE
           
static java.lang.String HISTORY_PROPERTY_DESCRIPTION
           
static java.lang.String HISTORY_PROPERTY_REVISION
           
static java.lang.String ICON_ID_ADD
           
static java.lang.String ICON_ID_ADD_ALL
           
static java.lang.String ICON_ID_CHECK_IN
           
static java.lang.String ICON_ID_CHECK_IN_ALL
           
static java.lang.String ICON_ID_COMPARE_PREVIOUS
           
static java.lang.String ICON_ID_MERGE
           
static java.lang.String ICON_ID_PENDING_CHANGES
           
static java.lang.String ICON_ID_SYNCHRONIZE
           
static java.lang.String ICON_ID_SYNCHRONIZE_ALL
           
static java.lang.String ICON_ID_UNDO_CHECKOUT
           
static java.lang.String MENU_ID_COMPARE
           
static java.lang.String MENU_ID_CONTEXT_MAIN
           
static java.lang.String MENU_ID_CONTEXT_VERSIONING
           
static java.lang.String MENU_ID_OPERATIONS
           
static java.lang.String MENU_ID_REPLACE
           
static java.lang.String MENU_ID_VERSIONING
           
static java.lang.String OVERLAY_ICON_CHECKED_OUT_UNRESERVED
           
static java.lang.String OVERLAY_ICON_ID_ADDED
           
static java.lang.String OVERLAY_ICON_ID_CHECKED_IN
           
static java.lang.String OVERLAY_ICON_ID_CHECKED_OUT
           
static java.lang.String OVERLAY_ICON_ID_CONFLICTS
           
static java.lang.String OVERLAY_ICON_ID_IGNORED
           
static java.lang.String OVERLAY_ICON_ID_MODIFIED
           
static java.lang.String OVERLAY_ICON_ID_NOT_AUTHENTICATED
           
static java.lang.String OVERLAY_ICON_ID_REMOVED
           
static java.lang.String OVERLAY_ICON_ID_UNADDED
           
static java.lang.String OVERLAY_ICON_ID_UNMODIFIED
           
static java.lang.String OVERLAY_ICON_ID_UNVERSIONED
           
static java.lang.String STATUS_FILTER_ID_CANDIDATE
           
static java.lang.String STATUS_FILTER_ID_RECOGNIZED
           
static java.lang.String STATUS_FILTER_ID_UNRECOGNIZED
           
static java.lang.String STATUS_FILTER_ID_UNVERSIONED
           
static java.lang.String STATUS_FILTER_ID_VERSIONED
           
static java.lang.String STATUS_ID_UNRECOGNIZED
           
static java.lang.String URL_FILTER_ID_CONTROL
           
static java.lang.String URL_FILTER_ID_DEFAULT
           
 
Constructor Summary
protected VCSProfile(java.lang.String id)
           
 
Method Summary
abstract  VCSActionInfo getActionInfo(java.lang.String actionId)
           
abstract  java.lang.String getChangeListViewID()
          Gets the identifying string associated with the view containing the ChangeLists declared in the profile.
abstract  CheckOutProvider getCheckOutProvider()
          Gets the CheckOutProvider declared in the profile.
abstract  HistoryProperty getHistoryProperty(java.lang.String id)
          Gets the HistoryProperty declared in the profile with the specified id.
abstract  java.lang.String getID()
          Gets this object's unique identifier.
abstract  java.util.logging.Logger getLogger()
           
abstract  VCSOverlayItemProducer getOverlayItemProducer()
           
abstract  IconOverlayTracker getOverlayTracker()
           
abstract  PendingChangesAdapter getPendingChangesAdapter()
          Retrieves the PendingChangesAdapter associated with any ChangeList containing view declared by the profile.
abstract  VCSPreferences getPreferences()
          Gets the used for persisting common VCS preferences.
abstract  RemovedEntryLister getRemovedEntryLister()
           
abstract  VCSStatusFilter getStatusFilter(java.lang.String id)
           
abstract  VCSStatus getStatusInstance(java.lang.String id)
           
abstract  java.net.URL getSystemDirectory()
          Gets the system directory for the vcs extension represented by this VCSProfile.
abstract  URLFilter getURLFilter(java.lang.String filterId)
          Gets the URLFilter declared in the profile with the specified id.
 
Methods inherited from class oracle.jdeveloper.vcs.spi.VCSExtension
canCheckOut, canShutdown, getCheckOutCommand, getControlPrecedence, getExceptionHandler, getHistoryProvider, getId, getInformation, getPolicyStatusCache, getStatus, getStatusCache, getStatusCacheBridge, getURLFilter, getVersionName, initialize, initializeEx, initializeImpl, isConflictsStatus, isConflictsStatus, isControlled, setReadWrite, setReadWrite, setReadWrite, shutdown
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STATUS_ID_UNRECOGNIZED

public static final java.lang.String STATUS_ID_UNRECOGNIZED
See Also:
Constant Field Values

STATUS_FILTER_ID_VERSIONED

public static final java.lang.String STATUS_FILTER_ID_VERSIONED
See Also:
Constant Field Values

STATUS_FILTER_ID_UNVERSIONED

public static final java.lang.String STATUS_FILTER_ID_UNVERSIONED
See Also:
Constant Field Values

STATUS_FILTER_ID_CANDIDATE

public static final java.lang.String STATUS_FILTER_ID_CANDIDATE
See Also:
Constant Field Values

STATUS_FILTER_ID_RECOGNIZED

public static final java.lang.String STATUS_FILTER_ID_RECOGNIZED
See Also:
Constant Field Values

STATUS_FILTER_ID_UNRECOGNIZED

public static final java.lang.String STATUS_FILTER_ID_UNRECOGNIZED
See Also:
Constant Field Values

MENU_ID_VERSIONING

public static final java.lang.String MENU_ID_VERSIONING
See Also:
Constant Field Values

MENU_ID_OPERATIONS

public static final java.lang.String MENU_ID_OPERATIONS
See Also:
Constant Field Values

MENU_ID_COMPARE

public static final java.lang.String MENU_ID_COMPARE
See Also:
Constant Field Values

MENU_ID_REPLACE

public static final java.lang.String MENU_ID_REPLACE
See Also:
Constant Field Values

MENU_ID_CONTEXT_MAIN

public static final java.lang.String MENU_ID_CONTEXT_MAIN
See Also:
Constant Field Values

MENU_ID_CONTEXT_VERSIONING

public static final java.lang.String MENU_ID_CONTEXT_VERSIONING
See Also:
Constant Field Values

URL_FILTER_ID_DEFAULT

public static final java.lang.String URL_FILTER_ID_DEFAULT
See Also:
Constant Field Values

URL_FILTER_ID_CONTROL

public static final java.lang.String URL_FILTER_ID_CONTROL
See Also:
Constant Field Values

ICON_ID_ADD

public static final java.lang.String ICON_ID_ADD
See Also:
Constant Field Values

ICON_ID_ADD_ALL

public static final java.lang.String ICON_ID_ADD_ALL
See Also:
Constant Field Values

ICON_ID_UNDO_CHECKOUT

public static final java.lang.String ICON_ID_UNDO_CHECKOUT
See Also:
Constant Field Values

ICON_ID_COMPARE_PREVIOUS

public static final java.lang.String ICON_ID_COMPARE_PREVIOUS
See Also:
Constant Field Values

ICON_ID_MERGE

public static final java.lang.String ICON_ID_MERGE
See Also:
Constant Field Values

ICON_ID_SYNCHRONIZE

public static final java.lang.String ICON_ID_SYNCHRONIZE
See Also:
Constant Field Values

ICON_ID_SYNCHRONIZE_ALL

public static final java.lang.String ICON_ID_SYNCHRONIZE_ALL
See Also:
Constant Field Values

ICON_ID_CHECK_IN

public static final java.lang.String ICON_ID_CHECK_IN
See Also:
Constant Field Values

ICON_ID_CHECK_IN_ALL

public static final java.lang.String ICON_ID_CHECK_IN_ALL
See Also:
Constant Field Values

ICON_ID_PENDING_CHANGES

public static final java.lang.String ICON_ID_PENDING_CHANGES
See Also:
Constant Field Values

OVERLAY_ICON_ID_ADDED

public static final java.lang.String OVERLAY_ICON_ID_ADDED
See Also:
Constant Field Values

OVERLAY_ICON_ID_CHECKED_IN

public static final java.lang.String OVERLAY_ICON_ID_CHECKED_IN
See Also:
Constant Field Values

OVERLAY_ICON_ID_CHECKED_OUT

public static final java.lang.String OVERLAY_ICON_ID_CHECKED_OUT
See Also:
Constant Field Values

OVERLAY_ICON_CHECKED_OUT_UNRESERVED

public static final java.lang.String OVERLAY_ICON_CHECKED_OUT_UNRESERVED
See Also:
Constant Field Values

OVERLAY_ICON_ID_CONFLICTS

public static final java.lang.String OVERLAY_ICON_ID_CONFLICTS
See Also:
Constant Field Values

OVERLAY_ICON_ID_IGNORED

public static final java.lang.String OVERLAY_ICON_ID_IGNORED
See Also:
Constant Field Values

OVERLAY_ICON_ID_MODIFIED

public static final java.lang.String OVERLAY_ICON_ID_MODIFIED
See Also:
Constant Field Values

OVERLAY_ICON_ID_UNMODIFIED

public static final java.lang.String OVERLAY_ICON_ID_UNMODIFIED
See Also:
Constant Field Values

OVERLAY_ICON_ID_REMOVED

public static final java.lang.String OVERLAY_ICON_ID_REMOVED
See Also:
Constant Field Values

OVERLAY_ICON_ID_UNADDED

public static final java.lang.String OVERLAY_ICON_ID_UNADDED
See Also:
Constant Field Values

OVERLAY_ICON_ID_UNVERSIONED

public static final java.lang.String OVERLAY_ICON_ID_UNVERSIONED
See Also:
Constant Field Values

OVERLAY_ICON_ID_NOT_AUTHENTICATED

public static final java.lang.String OVERLAY_ICON_ID_NOT_AUTHENTICATED
See Also:
Constant Field Values

HISTORY_PROPERTY_DATE

public static final java.lang.String HISTORY_PROPERTY_DATE
See Also:
Constant Field Values

HISTORY_PROPERTY_REVISION

public static final java.lang.String HISTORY_PROPERTY_REVISION
See Also:
Constant Field Values

HISTORY_PROPERTY_DESCRIPTION

public static final java.lang.String HISTORY_PROPERTY_DESCRIPTION
See Also:
Constant Field Values

EXCEPTION_HANDLER_ID_DEFAULT

public static final java.lang.String EXCEPTION_HANDLER_ID_DEFAULT
See Also:
Constant Field Values

CHANGELIST_CONTEXT_GROUP_CONFLICTS

public static final java.lang.String CHANGELIST_CONTEXT_GROUP_CONFLICTS
See Also:
Constant Field Values

CHANGELIST_CONTEXT_GROUP_OPERATIONS

public static final java.lang.String CHANGELIST_CONTEXT_GROUP_OPERATIONS
See Also:
Constant Field Values

CHANGELIST_CONTEXT_GROUP_DIFF

public static final java.lang.String CHANGELIST_CONTEXT_GROUP_DIFF
See Also:
Constant Field Values

CHANGELIST_CONTEXT_GROUP_GENERAL

public static final java.lang.String CHANGELIST_CONTEXT_GROUP_GENERAL
See Also:
Constant Field Values

CHANGELIST_CONTEXT_GROUP_CLIPBOARD

public static final java.lang.String CHANGELIST_CONTEXT_GROUP_CLIPBOARD
See Also:
Constant Field Values

CHANGELIST_CONTEXT_GROUP_SELECTNAV

public static final java.lang.String CHANGELIST_CONTEXT_GROUP_SELECTNAV
See Also:
Constant Field Values
Constructor Detail

VCSProfile

protected VCSProfile(java.lang.String id)
Method Detail

getOverlayTracker

public abstract IconOverlayTracker getOverlayTracker()

getOverlayItemProducer

public abstract VCSOverlayItemProducer getOverlayItemProducer()

getID

public abstract java.lang.String getID()
Gets this object's unique identifier.

Returns:
The object's unique identifier.

getPreferences

public abstract VCSPreferences getPreferences()
Gets the used for persisting common VCS preferences.

Returns:

getStatusInstance

public abstract VCSStatus getStatusInstance(java.lang.String id)

getURLFilter

public abstract URLFilter getURLFilter(java.lang.String filterId)
Gets the URLFilter declared in the profile with the specified id. Use URL_FILTER_ID_DEFAULT to retrieve the profile's default filter.

Parameters:
filterId - the filter id as declared in the profile.
Returns:
the appropriate URLFilter.

getStatusFilter

public abstract VCSStatusFilter getStatusFilter(java.lang.String id)

getActionInfo

public abstract VCSActionInfo getActionInfo(java.lang.String actionId)

getSystemDirectory

public abstract java.net.URL getSystemDirectory()
Gets the system directory for the vcs extension represented by this VCSProfile. All VCS specific data should be stored in this location.

Returns:
the system directory used for storing VCS specific data.

getLogger

public abstract java.util.logging.Logger getLogger()

getCheckOutProvider

public abstract CheckOutProvider getCheckOutProvider()
Gets the CheckOutProvider declared in the profile.

Returns:
the CheckOutProvider instance used to perform automatic checkouts in the IDE.

getHistoryProperty

public abstract HistoryProperty getHistoryProperty(java.lang.String id)
Gets the HistoryProperty declared in the profile with the specified id. History properties useful to most systems can be accessed using the shared ids HISTORY_PROPERTY_DATE, HISTORY_PROPERTY_REVISION and HISTORY_PROPERTY_DESCRIPTION.

Parameters:
id - the history property id as declared in the profile.
Returns:
the appropriate HistoryProperty, or null if no property exists with the specified id.

getChangeListViewID

public abstract java.lang.String getChangeListViewID()
Gets the identifying string associated with the view containing the ChangeLists declared in the profile.

Returns:
the ChangeList view id, or null if no such items were declared by the profile.

getPendingChangesAdapter

public abstract PendingChangesAdapter getPendingChangesAdapter()
Retrieves the PendingChangesAdapter associated with any ChangeList containing view declared by the profile.

Returns:
the PendingChangesAdapter instance, or null if no change list containing view exists.

getRemovedEntryLister

public abstract RemovedEntryLister getRemovedEntryLister()

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.1.0)

E17493-02

Copyright © 1997, 2011, Oracle. All rights reserved.