com.endeca.portal.data
Class IncompleteCollectionState

java.lang.Object
  com.endeca.portal.data.IncompleteCollectionState

All Implemented Interfaces:

java.io.Serializable

public class IncompleteCollectionState
extends java.lang.Object
implements java.io.Serializable

Class to represent Data Sets that have still not been completed. These are the data sets started in the Self Service wizard but still not completed

See Also:

Serialized Form

Nested Class Summary

static class	IncompleteCollectionState.IncompleteCollectionStatus Status of Incomplete Collections DATA_INGEST_NOT_STARTED - Data ingest is not started yet. outerTransactionId is null when status is DATA_INGEST_NOT_STARTED DATA_INGEST_IN_PROGRESS - User has completed the creation process via wizard, data ingest is still in progress.
static class	IncompleteCollectionState.LastOperation

Field Summary

protected java.lang.String	dataSourceState
protected java.lang.String	dataSourceType
protected boolean	defaultPageCreated
protected java.lang.String	key
protected IncompleteCollectionState.LastOperation	lastOperation
protected java.lang.String	outerTransactionId
protected IncompleteCollectionState.IncompleteCollectionStatus	status
protected long	workFlowId

Constructor Summary

IncompleteCollectionState()

IncompleteCollectionState(long workFlowId, java.lang.String dataSourceType, java.lang.String dataSourceState, java.lang.String collectionKey)

IncompleteCollectionState(java.lang.String collectionKey, java.lang.String pipelineName)

Method Summary

java.lang.String	getDataSourceState()
java.lang.String	getDataSourceType()
boolean	getDefaultPageCreated()
java.lang.String	getKey() Collection key.
IncompleteCollectionState.LastOperation	getLastOperation()
java.lang.String	getOuterTransactionId() Outer Transaction Id to be used for all requests for corresponding MDEXState.
java.lang.String	getPipelineName()
IncompleteCollectionState.IncompleteCollectionStatus	getStatus() Status of Incomplete Collections DATA_INGEST_NOT_STARTED - Data ingest is not started yet. outerTransactionId is null when status is DATA_INGEST_NOT_STARTED DATA_CONFIG_IN_PROGRESS - Data ingest is not started yet but user has completed the wizard steps. outerTransactionId is null when status is DATA_CONFIG_IN_PROGRESS DATA_INGEST_IN_PROGRESS - User has completed the creation process via wizard, data ingest is still in progress.
long	getWorkFlowId()
void	setDataSourceState(java.lang.String state)
void	setDataSourceType(java.lang.String type)
void	setDefaultPageCreated(boolean defaultPageCreated)
void	setKey(java.lang.String key) Collection key.
void	setLastOperation(IncompleteCollectionState.LastOperation lastOperation)
void	setOuterTransactionId(java.lang.String transactionId)
void	setPipelineName(java.lang.String pipelineName)
void	setStatus(IncompleteCollectionState.IncompleteCollectionStatus status)
void	setWorkFlowId(long id)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

workFlowId

protected long workFlowId

dataSourceType

protected java.lang.String dataSourceType

dataSourceState

protected java.lang.String dataSourceState

outerTransactionId

protected java.lang.String outerTransactionId

key

protected java.lang.String key

status

protected IncompleteCollectionState.IncompleteCollectionStatus status

lastOperation

protected IncompleteCollectionState.LastOperation lastOperation

defaultPageCreated

protected boolean defaultPageCreated

Constructor Detail

IncompleteCollectionState

public IncompleteCollectionState()

IncompleteCollectionState

public IncompleteCollectionState(java.lang.String collectionKey,
                                 java.lang.String pipelineName)

IncompleteCollectionState

public IncompleteCollectionState(long workFlowId,
                                 java.lang.String dataSourceType,
                                 java.lang.String dataSourceState,
                                 java.lang.String collectionKey)

Method Detail

setDataSourceType

public void setDataSourceType(java.lang.String type)

getDataSourceType

public java.lang.String getDataSourceType()

setDataSourceState

public void setDataSourceState(java.lang.String state)

getDataSourceState

public java.lang.String getDataSourceState()

setWorkFlowId

public void setWorkFlowId(long id)

getWorkFlowId

public long getWorkFlowId()

setStatus

public void setStatus(IncompleteCollectionState.IncompleteCollectionStatus status)

getStatus

public IncompleteCollectionState.IncompleteCollectionStatus getStatus()

Status of Incomplete Collections DATA_INGEST_NOT_STARTED - Data ingest is not started yet. outerTransactionId is null when status is DATA_INGEST_NOT_STARTED DATA_CONFIG_IN_PROGRESS - Data ingest is not started yet but user has completed the wizard steps. outerTransactionId is null when status is DATA_CONFIG_IN_PROGRESS DATA_INGEST_IN_PROGRESS - User has completed the creation process via wizard, data ingest is still in progress. When status is DATA_INGEST_IN_PROGRESS, outerTransactionId is to be used for all requests for the corresponding MDEXState. DATA_INGEST_ERROR - There was an error during Data Ingest and the operation was rolled back. The outerTransactionId will be invalid for this status.

setOuterTransactionId

public void setOuterTransactionId(java.lang.String transactionId)

getOuterTransactionId

public java.lang.String getOuterTransactionId()

Outer Transaction Id to be used for all requests for corresponding MDEXState. This is to be used only when the status is DATA_INGEST_IN_PROGRESS

setKey

public void setKey(java.lang.String key)

Collection key. For incomplete collections, this key might change. So, it should be not be relied upon if the status is DATA_INGEST_NOT_STARTED Once, the status changes to DATA_INGEST_IN_PROGRESS, the key cannot be changed.

Parameters:

key -

getKey

public java.lang.String getKey()

Collection key. For incomplete collections, this key might change. So, it should be not be relied upon if the status is DATA_INGEST_NOT_STARTED Once, the status changes to DATA_INGEST_IN_PROGRESS, the key cannot be changed.

setLastOperation

public void setLastOperation(IncompleteCollectionState.LastOperation lastOperation)

getLastOperation

public IncompleteCollectionState.LastOperation getLastOperation()

setDefaultPageCreated

public void setDefaultPageCreated(boolean defaultPageCreated)

getDefaultPageCreated

public boolean getDefaultPageCreated()

getPipelineName

public java.lang.String getPipelineName()

setPipelineName

public void setPipelineName(java.lang.String pipelineName)