public interface IVersionControlInfo
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.
| Modifier and Type | Field and Description |
|---|---|
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.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
static final int NO_OBJECTIONS_FOR_CHANGE
static final int DI_NOT_ACTIVE
static final int DI_ACTIVE
static final int DI_LOCAL_REPAIR
static final int DI_UNCHANGEABLE
static final int LOCAL
static final int LOCAL_GENERATED
static final int CHECKED_IN
static final int CHECKED_OUT_FOR_EDIT
static final int CHECKED_OUT_FOR_ADD
static final int IN_SYNC
static final int OUT_OF_SYNC
boolean isGenerated()
LOCAL_GENERATED,
false otherwise.boolean isVersionControlled()
int getRepositoryState()
LOCAL, LOCAL_GENERATED, CHECKED_IN,
CHECKED_OUT_FOR_EDIT, CHECKED_OUT_FOR_ADD, DI_UNCHANGEABLE or DI_LOCAL_REPAIR.int getDiState()
DI_NOT_ACTIVE if NWDI is not active in the current system,
or DI_ACTIVE if NWDI is active in the current system.boolean isInSync()
throws NamingException
NamingException - is the sync state cannot be determinedIllegalStateException - if Nwdi is inactive or if the object is
LOCAL or LOCAL_GENERATED,String[] getCheckedOutBy()
int getObjectionForChange()
This method must be called both when calculating the read-only flag for the editor, and before saving modifications.
| 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. |
Object[] getActivities() throws NamingException
null is returned.NamingException - if the activities cannot be retrievedString[] getRemoteLocations()
null
if this is a local objectboolean isExclusivelyCheckedOut()
false is returned.true if the object is exclusively checked-out, false otherwiseboolean isForeignCheckedOut()
false is returned.true if the object is checked-out by other users, false otherwise| Access Rights |
|---|
| SC | DC | Public Part | ACH |
|---|---|---|---|
[sap.com] EP-BASIS
|
[sap.com]
|
api
|
BC-PIN-PCD
|
[sap.com] EP-BASIS-API
|
[sap.com] tc/epbc/pcd/gl/api
|
-
|
EP-PIN
|
[sap.com] EP-BASIS-API
|
[sap.com] tc/epbc/pcd/gl/api
|
api
|
EP-PIN
|
[sap.com] EP-RUNTIME
|
[sap.com] tc/ep/semantics/api
|
api
|
EP-PIN
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2021 SAP SE Complete Copyright Notice