com.sapportals.portal.pcd.gl

Interface IVersionControlInfo

Deprecated. version-control not fully supported; changes expected in future releases

public interface IVersionControlInfo

Provides information on the version-control-status of the unit.

This interface only provides the version-control information for the point in time when the IUnit.getVersionControlInfo() method was called. The implementation does not refresh this information from the version-control repository for subsequent calls of methods declared in this interface.

This interface is not intended to be implemented by clients.

Field Summary

static int	CHECKED_IN Deprecated. The object is checked-in, editing impossible
static int	CHECKED_OUT_FOR_ADD Deprecated. The object is checked-out for add.
static int	CHECKED_OUT_FOR_EDIT Deprecated. The object is checked-out for edit.
static int	DI_ACTIVE Deprecated. NWDI environment is active, DTR-related actions are possible, objects can run out of sync.
static int	DI_LOCAL_REPAIR Deprecated. "Production" mode for the DC of the current object.
static int	DI_NOT_ACTIVE Deprecated. NWDI environment is not active, all objects are regarded as local, version-control-related actions are not possible.
static int	DI_UNCHANGEABLE Deprecated. "Production" mode for the DC of the current object.
static int	IN_SYNC Deprecated. Version-controlled object is in sync and can be treated in a regular way.
static int	LOCAL Deprecated. The object is local, checkout for add is possible (when NWDI is active), as well as editing.
static int	LOCAL_GENERATED Deprecated. The object is generated, which makes checkout for add impossible.
static int	NO_OBJECTIONS_FOR_CHANGE Deprecated. The object is changeable without any further action in respect to version-control.
static int	OUT_OF_SYNC Deprecated. Version-controlled object is out of sync and cannot be treated in a regular way.

Method Summary

Object[]	getActivities() Deprecated. Returns the activities for which the object is checked out.
String[]	getCheckedOutBy() Deprecated. Return an array of users (ids) who have this object checked-out, an empty array if the object is version-controlled but not checked-out, or null if the object is not version-controlled.
int	getDiState() Deprecated. Returns DI_NOT_ACTIVE if NWDI is not active in the current system, or DI_ACTIVE if NWDI is active in the current system.
int	getObjectionForChange() Deprecated. Indicates if and why the object is unmodifiable.
String[]	getRemoteLocations() Deprecated. Gets the location in the version control system for the resources mapped to this object.
int	getRepositoryState() Deprecated. Return the repository-related state of the object; may be one of LOCAL, LOCAL_GENERATED, CHECKED_IN, CHECKED_OUT_FOR_EDIT, CHECKED_OUT_FOR_ADD, DI_UNCHANGEABLE or DI_LOCAL_REPAIR.
boolean	isExclusivelyCheckedOut() Deprecated. Determines wether the object is checked-out exclusively, i.e. cannot be checked-out by other users.
boolean	isForeignCheckedOut() Deprecated. Determines wether the object is checked-out by one (or more) other users.
boolean	isGenerated() Deprecated. Returns true if the object is in repository-state LOCAL_GENERATED, false otherwise.
boolean	isInSync() Deprecated. Return the sync state of the object.
boolean	isVersionControlled() Deprecated. Returns true if the object is under version-control in this system.

Field Detail

NO_OBJECTIONS_FOR_CHANGE

static final int NO_OBJECTIONS_FOR_CHANGE

Deprecated.

The object is changeable without any further action in respect to version-control.

See Also:

Constant Field Values

DI_NOT_ACTIVE

static final int DI_NOT_ACTIVE

Deprecated.

NWDI environment is not active, all objects are regarded as local, version-control-related actions are not possible.

See Also:

Constant Field Values

DI_ACTIVE

static final int DI_ACTIVE

Deprecated.

NWDI environment is active, DTR-related actions are possible, objects can run out of sync.

See Also:

Constant Field Values

DI_LOCAL_REPAIR

static final int DI_LOCAL_REPAIR

Deprecated.

"Production" mode for the DC of the current object. NWDI works one-way, syncing from DTR is possible but updating to DTR is impossible. The objects behave like LOCAL_GENERATED, but can run out of sync.

See Also:

Constant Field Values

DI_UNCHANGEABLE

static final int DI_UNCHANGEABLE

Deprecated.

"Production" mode for the DC of the current object. NWDI works one-way, syncing from DTR is possible but updating to DTR is impossible. The objects cannot be edited, but can run out of sync.

See Also:

Constant Field Values

LOCAL

static final int LOCAL

Deprecated.

The object is local, checkout for add is possible (when NWDI is active), as well as editing.

See Also:

Constant Field Values

LOCAL_GENERATED

static final int LOCAL_GENERATED

Deprecated.

The object is generated, which makes checkout for add impossible. Generated object should normally not be edited manually; users should at least be discouraged.

See Also:

Constant Field Values

CHECKED_IN

static final int CHECKED_IN

Deprecated.

The object is checked-in, editing impossible

See Also:

Constant Field Values

CHECKED_OUT_FOR_EDIT

static final int CHECKED_OUT_FOR_EDIT

Deprecated.

The object is checked-out for edit. If it's checked-out by the current user, editing is possible.

See Also:

Constant Field Values

CHECKED_OUT_FOR_ADD

static final int CHECKED_OUT_FOR_ADD

Deprecated.

The object is checked-out for add. If it's checked-out by the current user, editing is possible.

See Also:

Constant Field Values

IN_SYNC

static final int IN_SYNC

Deprecated.

Version-controlled object is in sync and can be treated in a regular way.

See Also:

Constant Field Values

OUT_OF_SYNC

static final int OUT_OF_SYNC

Deprecated.

Version-controlled object is out of sync and cannot be treated in a regular way. If the object is currently checked-in, it cannot be checked out. If the object is checked-out, it cannot be checked-in, but only reverted. If the object is being edited (in local repair mode), it cannot be saved.

See Also:

Constant Field Values

Method Detail

isGenerated

boolean isGenerated()

Deprecated.

Returns true if the object is in repository-state LOCAL_GENERATED, false otherwise.

Returns:

true if the object is in repository-state

isVersionControlled

boolean isVersionControlled()

Deprecated.

Returns true if the object is under version-control in this system. This is true if the object is assigned to a real DC and if NWDI is configured for this system.

Returns:

true if the object is under version-control in this system

getRepositoryState

int getRepositoryState()

Deprecated.

Return the repository-related state of the object; may be one of LOCAL, LOCAL_GENERATED, CHECKED_IN, CHECKED_OUT_FOR_EDIT, CHECKED_OUT_FOR_ADD, DI_UNCHANGEABLE or DI_LOCAL_REPAIR.

Returns:

the repository-related state of the object

getDiState

int getDiState()

Deprecated.

Returns DI_NOT_ACTIVE if NWDI is not active in the current system, or DI_ACTIVE if NWDI is active in the current system.

Returns:

int

isInSync

boolean isInSync()
                 throws NamingException

Deprecated.

Return the sync state of the object.

Returns:

boolean

Throws:

NamingException - is the sync state cannot be determined

IllegalStateException - if Nwdi is inactive or if the object is LOCAL or LOCAL_GENERATED,

getCheckedOutBy

String[] getCheckedOutBy()

Deprecated.

Return an array of users (ids) who have this object checked-out, an empty array if the object is version-controlled but not checked-out, or null if the object is not version-controlled.

Returns:

String[]

getObjectionForChange

int getObjectionForChange()

Deprecated.

Indicates if and why the object is unmodifiable.

This method must be called both when calculating the read-only flag for the editor, and before saving modifications.

Returns:

Return value	Meaning
NO_OBJECTIONS_FOR_CHANGE	No objections from version control side to modify the object
DI_NOT_ACTIVE	Object can be edited without any interaction with NWDI.
DI_LOCAL_REPAIR	The object belongs to an imported DC and can be edited without any interaction with NWDI, but the user should see a message that these changes remain local and can be overridden by future imports.
DI_UNCHANGEABLE	The object belongs to an imported DC and cannot be edited. The user should see a corresponding message.
CHECKED_IN	Object must be checked out before it can be edited.
CHECKED_OUT_FOR_EDIT	Object is exclusively checked out by somebody else.
CHECKED_OUT_FOR_ADD	Object is exclusively checked out for add by somebody else. (It may depend on the implementation if we can detect this state; if not, we return CHECKED_OUT_FOR_EDIT).
OUT_OF_SYNC	The object cannot be edited because it is out-of-sync and will be updated externally.

getActivities

Object[] getActivities()
                       throws NamingException

Deprecated.

Returns the activities for which the object is checked out. Typically the object[] has one entry. If the object is not checked-out, an empty array is returned. If the object is not version-controlled, null is returned.

Returns:

Object[]

Throws:

NamingException - if the activities cannot be retrieved

getRemoteLocations

String[] getRemoteLocations()

Deprecated.

Gets the location in the version control system for the resources mapped to this object. Since it is possible that one local object is mapped to several resources in the version control system, the method returns an array. The remote location of a resource is typically a URL.

Returns:

the remote locations of the resources mapped to this object or null if this is a local object

isExclusivelyCheckedOut

boolean isExclusivelyCheckedOut()

Deprecated.

Determines wether the object is checked-out exclusively, i.e. cannot be checked-out by other users. If the object is not checked-out, false is returned.

Returns:

true if the object is exclusively checked-out, false otherwise

isForeignCheckedOut

boolean isForeignCheckedOut()

Deprecated.

Determines wether the object is checked-out by one (or more) other users. If the object is not checked-out, false is returned.

Returns:

true if the object is checked-out by other users, false otherwise

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/pcd/gl/api	api	EP-PIN
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/pcd/gl/api	-	EP-PIN
[sap.com] EP-BASIS	[sap.com] tc/epbc/pcd/pars/srvgldeprecated	api	BC-PIN-PCD