com.ibm.team.interop.common

Interface IExternalProxy

All Superinterfaces:

IAuditable, IAuditableHandle, IExternalProxyHandle, IItem, IItemHandle, IManagedItem, IManagedItemHandle

public interface IExternalProxy
extends IExternalProxyHandle, IAuditable

Class to represent a proxy for an external object that is being replicated in the Jazz repository, and possibly synchronized with a Jazz item.

Since:

0.5

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IExternalProxy.SynchronizationDirection Possible values for the LAST_SYNC_DIRECTION property.
static class	IExternalProxy.SynchronizationStatus Possible values for the SYNC_STATUS_PROPERTY.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CYCLE_COUNT_PROPERTY The cycle count property.
static java.lang.String	EXTERNAL_STATE_PROPERTY The external state property.
static IItemType	ITEM_TYPE ExternalProxy item type.
static java.lang.String	LAST_ERROR_STRING_PROPERTY The last error string property.
static java.lang.String	LAST_SYNC_DIRECTION_PROPERTY The last sync direction property.
static java.lang.String	LAST_SYNC_RULE_STATE_ID_PROPERTY The last-sync-rule state ID property.
static java.lang.String	LAST_SYNCED_IN_EXTERNAL_STATE_ID_PROPERTY The last-synced-in external state ID property.
static java.lang.String	LAST_SYNCED_IN_ITEM_STATE_ID_PROPERTY The last-synced-in item state ID property.
static java.lang.String	LAST_SYNCED_OUT_EXTERNAL_STATE_ID_PROPERTY The last-synced-out external state ID property.
static java.lang.String	LAST_SYNCED_OUT_ITEM_STATE_ID_PROPERTY The last-synced-out item state ID property.
static java.lang.String	SYNC_RULE_PROPERTY The synchronization rule property.
static java.lang.String	SYNC_STATUS_PROPERTY The sync status property.

Fields inherited from interface com.ibm.team.repository.common.IAuditable

MERGE_PREDECESSOR_STATE_PROPERTY, PREDECESSOR_STATE_PROPERTY

Fields inherited from interface com.ibm.team.repository.common.IItem

CONTEXT_ID_PROPERTY, ITEM_ID_PROPERTY, MAX_LARGE_STRING_BYTES, MAX_MEDIUM_STRING_BYTES, MAX_SMALL_STRING_BYTES, MODIFIED_BY_PROPERTY, MODIFIED_PROPERTY, STATE_ID_PROPERTY

Method Summary

Methods

Modifier and Type	Method and Description
int	getCycleCount()
java.lang.String	getExternalIdHint() Get any "hint" for the identifier of the external object that this proxy may be linked to.
IExternalStateHandle	getExternalStateItemHandle() Get an item handle for the external state associated with this proxy, if any.
java.lang.String	getLastErrorString()
IExternalProxy.SynchronizationDirection	getLastSynchronizationDirection() Get the direction of the last attempted synchronization.
IExternalProxy.SynchronizationStatus	getSynchronizationStatus() Get the synchronization status for this proxy.
ISyncRuleHandle	getSyncRuleHandle() Get a handle to the synchronization rule associated with this proxy, if any.
void	setExternalState(IExternalStateHandle value) Set the external state associated with this proxy.
void	setSynchronizationStatus(IExternalProxy.SynchronizationStatus status) Set the synchronization status for this proxy.
void	setSyncRule(ISyncRuleHandle syncRule) Set the synchronization rule to use for this proxy (if none specified otherwise).

Methods inherited from interface com.ibm.team.repository.common.IAuditable

getMergePredecessorState, getPredecessorState

Methods inherited from interface com.ibm.team.repository.common.IManagedItem

isNewItem

Methods inherited from interface com.ibm.team.repository.common.IItem

getContextId, getItemHandle, getModifiedBy, getRedactedCopy, getRequestedModified, getRequestedStateId, getStateHandle, getWorkingCopy, hasHistory, isComplete, isPropertySet, isRedactedCopy, isWorkingCopy, modified, setContextId, setRequestedModified, setRequestedStateId

Methods inherited from interface com.ibm.team.repository.common.IItemHandle

equals, getAdapter, getFullState, getItemId, getItemType, getOrigin, getStateId, hasFullState, hasStateId, isAuditable, isConfigurationAware, isImmutable, isSimple, isUnmanaged, makeImmutable, protect, sameItemId, sameStateId, size

Field Detail

ITEM_TYPE

static final IItemType ITEM_TYPE

ExternalProxy item type.

SYNC_STATUS_PROPERTY

static final java.lang.String SYNC_STATUS_PROPERTY

The sync status property.

See Also:

#getSyncStatus()

LAST_SYNC_DIRECTION_PROPERTY

static final java.lang.String LAST_SYNC_DIRECTION_PROPERTY

The last sync direction property.

See Also:

getLastSynchronizationDirection()

LAST_ERROR_STRING_PROPERTY

static final java.lang.String LAST_ERROR_STRING_PROPERTY

The last error string property.

See Also:

getLastErrorString()()

LAST_SYNCED_IN_ITEM_STATE_ID_PROPERTY

static final java.lang.String LAST_SYNCED_IN_ITEM_STATE_ID_PROPERTY

The last-synced-in item state ID property.

See Also:

#getLastSyncedInItemStateId()()

LAST_SYNCED_IN_EXTERNAL_STATE_ID_PROPERTY

static final java.lang.String LAST_SYNCED_IN_EXTERNAL_STATE_ID_PROPERTY

The last-synced-in external state ID property.

See Also:

#getLastSyncedInExternalStateId()()

LAST_SYNCED_OUT_ITEM_STATE_ID_PROPERTY

static final java.lang.String LAST_SYNCED_OUT_ITEM_STATE_ID_PROPERTY

The last-synced-out item state ID property.

See Also:

#getLastSyncedOutItemStateId()()

LAST_SYNCED_OUT_EXTERNAL_STATE_ID_PROPERTY

static final java.lang.String LAST_SYNCED_OUT_EXTERNAL_STATE_ID_PROPERTY

The last-synced-out external state ID property.

See Also:

#getLastSyncedOutExternalStateId()()

EXTERNAL_STATE_PROPERTY

static final java.lang.String EXTERNAL_STATE_PROPERTY

The external state property.

See Also:

#getExternalStateHandle()

SYNC_RULE_PROPERTY

static final java.lang.String SYNC_RULE_PROPERTY

The synchronization rule property.

See Also:

getSyncRuleHandle()()

LAST_SYNC_RULE_STATE_ID_PROPERTY

static final java.lang.String LAST_SYNC_RULE_STATE_ID_PROPERTY

The last-sync-rule state ID property.

See Also:

#getLastSyncRuleStateId()()

CYCLE_COUNT_PROPERTY

static final java.lang.String CYCLE_COUNT_PROPERTY

The cycle count property.

See Also:

getCycleCount()

Method Detail

getSynchronizationStatus

IExternalProxy.SynchronizationStatus getSynchronizationStatus()

Get the synchronization status for this proxy.

Returns:

the current sychronization status

setSynchronizationStatus

void setSynchronizationStatus(IExternalProxy.SynchronizationStatus status)

Set the synchronization status for this proxy.

Parameters:

status - the new synchronization status

getLastSynchronizationDirection

IExternalProxy.SynchronizationDirection getLastSynchronizationDirection()

Get the direction of the last attempted synchronization.

Returns:

the direction of the last synchronization attempt

getLastErrorString

java.lang.String getLastErrorString()

Returns:

any error information collected from the last operation; only valid when #getSyncStatus() returns an error status; may be null

getExternalStateItemHandle

IExternalStateHandle getExternalStateItemHandle()

Get an item handle for the external state associated with this proxy, if any.

Returns:

item handle for IExternalState (i.e. a handle with no state ID), or null if none yet associated with proxy

setExternalState

void setExternalState(IExternalStateHandle value)

Set the external state associated with this proxy.

Parameters:

value - handle for an IExternalState item, or null to remove any associated external state

Since:

0.6

getSyncRuleHandle

ISyncRuleHandle getSyncRuleHandle()

Get a handle to the synchronization rule associated with this proxy, if any.

Clients can explicitly set the rule to use for subsequent synchronization attempts on a proxy, or it can be specified as an argument to a method that invokes synchronization. Whenever synchronization is attempted, the state of the sync rule (which is an Auditable) that was referenced is recorded. Therefore, if synchronization has been attempted, this routine will return a state handle, identifying the state of the sync rule that was used. Otherwise, it will return an item handle (i.e. one with no state ID), or null if there is no associated sync rule at all.

Note that even when a state handle is returned, the caller can always ignore the state ID and get the latest state of the item.

Returns:

item or state handle for the sync rule associated with this proxy, or null if there is none

setSyncRule

void setSyncRule(ISyncRuleHandle syncRule)

Set the synchronization rule to use for this proxy (if none specified otherwise).

Parameters:

syncRule - the synchronization rule to use, or null to remove any associated rule

getCycleCount

int getCycleCount()

Returns:

the current value of the incoming/outgoing cycle counter

getExternalIdHint

java.lang.String getExternalIdHint()

Get any "hint" for the identifier of the external object that this proxy may be linked to. The hint may not be set, or may not be valid (the object may have been renamed).

Returns:

any stored hint for the identifier of the external item represented by this proxy; may be null