com.ibm.team.interop.common

Interface IExternalState

All Superinterfaces:

IAuditable, IAuditableHandle, IExternalStateHandle, IItem, IItemHandle, IManagedItem, IManagedItemHandle

public interface IExternalState
extends IExternalStateHandle, IAuditable

Class to represent the replicated state associated with a proxy for an external object.

Since:

0.5

Field Summary

Fields

Modifier and Type	Field and Description
static IItemType	ITEM_TYPE ExternalState item type.
static java.lang.String	REPLICATED_STATE_PROPERTY The replicated state 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
IContent	decodeContentDescriptor(java.lang.String contentDescriptor) Decode an encoded Content descriptor back to a Content object.
java.lang.String	encodeContentDescriptor(IContent content) Encode a Content descriptor into a String.
java.util.Map<java.lang.String,java.lang.Object>	getState() Return the state as a property map of name/value pairs.
void	setState(java.util.Map<java.lang.String,?> state) Set the state as a property name of name/value pairs.

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

ExternalState item type.

REPLICATED_STATE_PROPERTY

static final java.lang.String REPLICATED_STATE_PROPERTY

The replicated state property.

See Also:

Constant Field Values

Method Detail

getState

java.util.Map<java.lang.String,java.lang.Object> getState()

Return the state as a property map of name/value pairs.

Returns:

the external state as a map of property name/values

setState

void setState(java.util.Map<java.lang.String,?> state)

Set the state as a property name of name/value pairs.

Parameters:

state - the external state to set as a map of property name/values

encodeContentDescriptor

java.lang.String encodeContentDescriptor(IContent content)

Encode a Content descriptor into a String. This method is used by an external client when it uploads a file that is to be used as the value of a Content property for an item. The incoming value of the property corresponding to the Content should be set to the value generated by this method.

Note: only binary or unspecified line delimiter content is supported; that is, the line delimiter type must be set to LINE_DELIMITER_NONE

Parameters:

content - the Content object to encode

Returns:

a string encoding of the Content descriptor

decodeContentDescriptor

IContent decodeContentDescriptor(java.lang.String contentDescriptor)

Decode an encoded Content descriptor back to a Content object. The receiving item manager should use this method to get the Content object that was uploaded by an external client. It claims that Content by setting it as the value of some property on the item being synchronized (and then saving the item).

Parameters:

contentDescriptor - the encoded Content descriptor

Returns:

the decoded Content object