ITemplateHolder (GigaSpaces 16.2.1 API)

All Superinterfaces:

IEntryHolder, ILockedSubject, ILockObject, ISelfLockingSubject, ISpaceItem

All Known Implementing Classes:

NotifyTemplateHolder, TemplateHolder
```
public interface ITemplateHolder
extends ISpaceItem, IEntryHolder
```
Since:

7.0

Author:

Niv Ingberg

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addEntryWaitingForTemplate(IEntryHolder entry)`
`boolean`	`canFinishBatchOperation()`
`int`	`getAfterOpFilterCode()`
`EntryHolderAggregatorContext`	`getAggregatorContext()`
`AnswerHolder`	`getAnswerHolder()`
`BatchQueryOperationContext`	`getBatchOperationContext()`
`long`	`getChangeExpiration()`
`ICustomQuery`	`getCustomQuery()`
`Collection<IEntryHolder>`	`getEntriesWaitingForTemplate()`
`long`	`getExpirationTime()`
`SingleExplainPlan`	`getExplainPlan()`
`short[]`	`getExtendedMatchCodes()`
`String`	`getExternalEntryImplClassName()`
`int`	`getFifoThreadPartition()`
`long`	`getFifoXtnNumberOnSearchStart()`
`FilterManager`	`getFilterManager()`
`Object`	`getID()`
`default LockSubjectType`	`getLockSubjectType()`
`MultipleIdsContext`	`getMultipleIdsContext()`
`String[]`	`getMultipleUids()`
`Collection<SpaceEntryMutator>`	`getMutators()`
`OperationID`	`getOperationID()`
`int`	`getOperationModifiers()`
`int`	`getOrdinalForEntryByIdMultipleOperation()`
`PendingFifoSearch`	`getPendingFifoSearchObject()`
`int`	`getPreviousVersion()`
`AbstractProjectionTemplate`	`getProjectionTemplate()`
`QueryResultTypeInternal`	`getQueryResultType()`
`boolean`	`getRangeInclusion(int index)`
`Object`	`getRangeValue(int index)`
`IEntryData`	`getRejectedOperationEntry()`
`Throwable`	`getRejectedOpOriginalException()`
`IResponseContext`	`getResponseContext()`
`ServerIteratorInfo`	`getServerIteratorInfo()`
`SpaceContext`	`getSpaceContext()`
`TemplateEntryData`	`getTemplateEntryData()`
`int`	`getTemplateOperation()`
`int`	`getTokenFieldNumber()`
`IEntryHolder`	`getUpdatedEntry()`
`IEntryPacket`	`getUpdateOperationEntry()`
`UpdateOrWriteContext`	`getUpfdateOrWriteContext()`
`boolean`	`hasAnswer()`
`boolean`	`hasExtendedMatchCodes()`
`boolean`	`isAllValuesIndexSqlQuery()`
`boolean`	`isBatchOperation()`
`boolean`	`isChange()`
`boolean`	`isChangeById()`
`boolean`	`isChangeMultiple()`
`boolean`	`isChangeQuery()`
`boolean`	`isClear()`
`boolean`	`isDirtyReadRequested()`
`boolean`	`isEmptyTemplate()`
`boolean`	`isExclusiveReadLockOperation()`
`boolean`	`isExpirationTimeSet()`
`boolean`	`isExplicitInsertionToExpirationManager()`
`boolean`	`isFifoGroupPoll()`
`boolean`	`isFifoSearch()`
`boolean`	`isFifoTemplate()`
`boolean`	`isIdQuery()`
`boolean`	`isIfExist()`
`boolean`	`isInCache()`
`boolean`	`isInExpirationManager()`
`boolean`	`isInitialFifoSearchActive()`
`boolean`	`isInitialIfExistSearchActive()`
`boolean`	`isInitiatedEvictionOperation()`
`boolean`	`isMatchByID()`
`boolean`	`isMemoryOnlySearch()`
`boolean`	`isMultipleIdsOperation()`
`boolean`	`isNonBlockingRead()`
`boolean`	`isNotifyTemplate()`
`boolean`	`isOptimizedForBlobStoreOp(CacheManager cacheManager)`
`boolean`	`isReadCommittedRequested()`
`boolean`	`isReadMultiple()`
`boolean`	`isReadOperation()`
`boolean`	`isReRegisterLeaseOnUpdate()`
`boolean`	`isReturnOnlyUid()`
`boolean`	`isSecondPhase()`
`boolean`	`isServerIterator()`
`boolean`	`isSetSingleOperationExtendedErrorInfo()`
`boolean`	`isSqlQuery()`
`boolean`	`isTakeMultiple()`
`boolean`	`isTakeOperation()`
`boolean`	`isUpdateMultiple()`
`boolean`	`isUpdateOperation()`
`boolean`	`isWriteLockOperation()`
`MatchResult`	`match(CacheManager cacheManager, IEntryHolder entry, int skipAlreadyMatchedFixedPropertyIndex, String skipAlreadyMatchedIndexPath, boolean safeEntry, Context context, RegexCache regexCache)`
`boolean`	`quickReject(Context context, FifoSearch fifoSearch)`
`void`	`removeEntryWaitingForTemplate(IEntryHolder entry)`
`void`	`removePendingFifoSearchObject(boolean value)`
`void`	`resetFifoXtnNumberOnSearchStart()`
`void`	`resetInitialIfExistSearchActive()`
`void`	`setAggregatorContext(EntryHolderAggregatorContext aggregatorContext)`
`void`	`setAnswerHolder(AnswerHolder answer)`
`void`	`setBatchOperationContext(BatchQueryOperationContext batchOpContext)`
`void`	`setChangeExpiration(long expirationTime)`
`void`	`setFifoThreadPartition(int tnum)`
`void`	`setFifoXtnNumberOnSearchStart(long latestTTransactionTerminationNum)`
`void`	`setForAfterOperationFilter(int afterOpFilterCode, SpaceContext sc, FilterManager fm, IEntryPacket updateOperationEntry)`
`void`	`setID(Object id)`
`void`	`setIfExistForChange()`
`void`	`setInCache()`
`void`	`setInExpirationManager(boolean value)`
`void`	`setInitialFifoSearchActive()`
`void`	`setInitialIfExistSearchActive()`
`void`	`setMemoryOnlySearch(boolean memoryOnly)`
`void`	`setMultipleIdsContext(MultipleIdsContext multipleIdsContext)`
`void`	`setMutators(Collection<SpaceEntryMutator> mutators)`
`void`	`setNonBlockingRead(boolean val)`
`void`	`setOrdinalForEntryByIdMultipleOperation(int ordinal)`
`void`	`setPendingFifoSearchObject(PendingFifoSearch pendingFifoSearch)`
`void`	`setRejectedOpOriginalExceptionAndEntry(Throwable cause, IEntryData rejectedEntry)`
`void`	`setReRegisterLeaseOnUpdate(boolean value)`
`void`	`setSecondPhase()`
`void`	`setServerIteratorInfo(ServerIteratorInfo serverIteratorInfo)`
`void`	`setUidToOperateBy(String uid)`
`void`	`setUpdatedEntry(IEntryHolder entryHolder)`
`void`	`setUpdateOrWriteContext(UpdateOrWriteContext ctx)`
`SQLQuery<?>`	`toSQLQuery(ITypeDesc typeDesc)`

Methods inherited from interface com.gigaspaces.internal.server.storage.IEntryHolder
addReadLockOwner, addTemplateWaitingForEntry, anyReadLockXtn, clearReadLockOwners, createCopy, createDummy, getCopyOfTemplatesWaitingForEntry, getEntryId, getHandback, getMaster, getNotifyType, getOrder, getOriginalEntryHolder, getReadLockOwners, getRoutingValue, getShadow, getTemplatesWaitingForEntry, getTxnEntryData, getWriteLockOperation, getWriteLockOwner, getWriteLockTransaction, hasShadow, hasShadow, isBlobStoreEntry, isEntryUnderWriteLockXtn, isExpired, isExpired, isHollowEntry, isSameEntryInstance, isShadow, isUnstable, removeReadLockOwner, removeTemplateWaitingForEntry, resetEntryXtnInfo, resetWriteLockOwner, resetXidOriginated, restoreUpdateXtnRollback, setOrder, setOtherUpdateUnderXtnEntry, setSCN, setTransient, setUID, setunStable, setWriteLockOperation, setWriteLockOwnerAndOperation, setWriteLockOwnerAndOperation, setWriteLockOwnerOperationAndShadow, updateEntryData

Methods inherited from interface com.gigaspaces.internal.server.storage.ISpaceItem
getClassName, getEntryData, getSCN, getServerTypeDesc, getUidToOperateBy, getXidOriginated, getXidOriginatedTransaction, hasWaitingFor, isDeleted, isDummyLease, isDummyLeaseAndNotExpired, isMaybeUnderXtn, isTransient, setDeleted, setDummyLease, setExpirationTime, setHasWaitingFor, setMaybeUnderXtn, updateVersionAndExpiration

Methods inherited from interface com.j_spaces.kernel.locks.ILockObject
isLockSubject

Methods inherited from interface com.j_spaces.kernel.locks.ILockedSubject
getExternalLockObject, getUID

Method Detail

setUidToOperateBy
```
void setUidToOperateBy(String uid)
```

getMultipleUids
```
String[] getMultipleUids()
```

getTokenFieldNumber
```
int getTokenFieldNumber()
```

getTemplateOperation
```
int getTemplateOperation()
```

isFifoTemplate
```
boolean isFifoTemplate()
```

isEmptyTemplate
```
boolean isEmptyTemplate()
```

isReturnOnlyUid
```
boolean isReturnOnlyUid()
```

isInCache
```
boolean isInCache()
```

setInCache
```
void setInCache()
```

isSecondPhase
```
boolean isSecondPhase()
```

setSecondPhase
```
void setSecondPhase()
```

hasAnswer
```
boolean hasAnswer()
```

getAnswerHolder
```
AnswerHolder getAnswerHolder()
```

setAnswerHolder

void setAnswerHolder(AnswerHolder answer)

getOperationModifiers
```
int getOperationModifiers()
```

isMatchByID
```
boolean isMatchByID()
```

isReadOperation
```
boolean isReadOperation()
```

isUpdateOperation
```
boolean isUpdateOperation()
```

isFifoSearch
```
boolean isFifoSearch()
```

isIfExist
```
boolean isIfExist()
```

isNotifyTemplate
```
boolean isNotifyTemplate()
```

isTakeOperation
```
boolean isTakeOperation()
```

isInitiatedEvictionOperation
```
boolean isInitiatedEvictionOperation()
```

isFifoGroupPoll
```
boolean isFifoGroupPoll()
```

isBatchOperation
```
boolean isBatchOperation()
```

isReadMultiple
```
boolean isReadMultiple()
```

isTakeMultiple
```
boolean isTakeMultiple()
```

isChangeMultiple
```
boolean isChangeMultiple()
```

isChangeQuery
```
boolean isChangeQuery()
```

getBatchOperationContext

BatchQueryOperationContext getBatchOperationContext()

setBatchOperationContext

void setBatchOperationContext(BatchQueryOperationContext batchOpContext)

canFinishBatchOperation
```
boolean canFinishBatchOperation()
```

isMultipleIdsOperation
```
boolean isMultipleIdsOperation()
```

getMultipleIdsContext

MultipleIdsContext getMultipleIdsContext()

setMultipleIdsContext

void setMultipleIdsContext(MultipleIdsContext multipleIdsContext)

isUpdateMultiple
```
boolean isUpdateMultiple()
```

setOrdinalForEntryByIdMultipleOperation

void setOrdinalForEntryByIdMultipleOperation(int ordinal)

getOrdinalForEntryByIdMultipleOperation

int getOrdinalForEntryByIdMultipleOperation()

getUpfdateOrWriteContext

UpdateOrWriteContext getUpfdateOrWriteContext()

setUpdateOrWriteContext

void setUpdateOrWriteContext(UpdateOrWriteContext ctx)

isIdQuery
```
boolean isIdQuery()
```

getFifoThreadPartition
```
int getFifoThreadPartition()
```

setFifoThreadPartition
```
void setFifoThreadPartition(int tnum)
```

hasExtendedMatchCodes
```
boolean hasExtendedMatchCodes()
```

getExtendedMatchCodes
```
short[] getExtendedMatchCodes()
```

getRangeValue
```
Object getRangeValue(int index)
```

getRangeInclusion
```
boolean getRangeInclusion(int index)
```

isInitialIfExistSearchActive
```
boolean isInitialIfExistSearchActive()
```

setInitialIfExistSearchActive
```
void setInitialIfExistSearchActive()
```

resetInitialIfExistSearchActive
```
void resetInitialIfExistSearchActive()
```

getFifoXtnNumberOnSearchStart
```
long getFifoXtnNumberOnSearchStart()
```

setFifoXtnNumberOnSearchStart

void setFifoXtnNumberOnSearchStart(long latestTTransactionTerminationNum)

resetFifoXtnNumberOnSearchStart
```
void resetFifoXtnNumberOnSearchStart()
```

isInExpirationManager
```
boolean isInExpirationManager()
```

setInExpirationManager

void setInExpirationManager(boolean value)

isExplicitInsertionToExpirationManager

boolean isExplicitInsertionToExpirationManager()

getOperationID
```
OperationID getOperationID()
```

getUpdatedEntry
```
IEntryHolder getUpdatedEntry()
```

setUpdatedEntry

void setUpdatedEntry(IEntryHolder entryHolder)

setReRegisterLeaseOnUpdate

void setReRegisterLeaseOnUpdate(boolean value)

isReRegisterLeaseOnUpdate
```
boolean isReRegisterLeaseOnUpdate()
```

getQueryResultType

QueryResultTypeInternal getQueryResultType()

getExternalEntryImplClassName
```
String getExternalEntryImplClassName()
```

isInitialFifoSearchActive
```
boolean isInitialFifoSearchActive()
```

isExclusiveReadLockOperation
```
boolean isExclusiveReadLockOperation()
```

isWriteLockOperation
```
boolean isWriteLockOperation()
```

getResponseContext
```
IResponseContext getResponseContext()
```

isDirtyReadRequested
```
boolean isDirtyReadRequested()
```

isReadCommittedRequested
```
boolean isReadCommittedRequested()
```

setInitialFifoSearchActive
```
void setInitialFifoSearchActive()
```

getPendingFifoSearchObject

PendingFifoSearch getPendingFifoSearchObject()

setPendingFifoSearchObject

void setPendingFifoSearchObject(PendingFifoSearch pendingFifoSearch)

removePendingFifoSearchObject

void removePendingFifoSearchObject(boolean value)

setNonBlockingRead
```
void setNonBlockingRead(boolean val)
```

isNonBlockingRead
```
boolean isNonBlockingRead()
```

isMemoryOnlySearch
```
boolean isMemoryOnlySearch()
```

setMemoryOnlySearch

void setMemoryOnlySearch(boolean memoryOnly)

getCustomQuery
```
ICustomQuery getCustomQuery()
```

getExpirationTime
```
long getExpirationTime()
```

getID
```
Object getID()
```

setID
```
void setID(Object id)
```

match

MatchResult match(CacheManager cacheManager,
                  IEntryHolder entry,
                  int skipAlreadyMatchedFixedPropertyIndex,
                  String skipAlreadyMatchedIndexPath,
                  boolean safeEntry,
                  Context context,
                  RegexCache regexCache)

toSQLQuery

SQLQuery<?> toSQLQuery(ITypeDesc typeDesc)

quickReject

boolean quickReject(Context context,
                    FifoSearch fifoSearch)

getPreviousVersion
```
int getPreviousVersion()
```

getAfterOpFilterCode
```
int getAfterOpFilterCode()
```

getUpdateOperationEntry
```
IEntryPacket getUpdateOperationEntry()
```

getSpaceContext
```
SpaceContext getSpaceContext()
```

getFilterManager
```
FilterManager getFilterManager()
```

setForAfterOperationFilter

void setForAfterOperationFilter(int afterOpFilterCode,
                                SpaceContext sc,
                                FilterManager fm,
                                IEntryPacket updateOperationEntry)

isExpirationTimeSet
```
boolean isExpirationTimeSet()
```

isChange
```
boolean isChange()
```

isChangeById
```
boolean isChangeById()
```

setMutators

void setMutators(Collection<SpaceEntryMutator> mutators)

getMutators

Collection<SpaceEntryMutator> getMutators()

getAggregatorContext

EntryHolderAggregatorContext getAggregatorContext()

setAggregatorContext

void setAggregatorContext(EntryHolderAggregatorContext aggregatorContext)

setChangeExpiration

void setChangeExpiration(long expirationTime)

getChangeExpiration
```
long getChangeExpiration()
```

setIfExistForChange
```
void setIfExistForChange()
```

getRejectedOpOriginalException

Throwable getRejectedOpOriginalException()

setRejectedOpOriginalExceptionAndEntry

void setRejectedOpOriginalExceptionAndEntry(Throwable cause,
                                            IEntryData rejectedEntry)

getRejectedOperationEntry
```
IEntryData getRejectedOperationEntry()
```

isSetSingleOperationExtendedErrorInfo

boolean isSetSingleOperationExtendedErrorInfo()

addEntryWaitingForTemplate

void addEntryWaitingForTemplate(IEntryHolder entry)

removeEntryWaitingForTemplate

void removeEntryWaitingForTemplate(IEntryHolder entry)

getEntriesWaitingForTemplate

Collection<IEntryHolder> getEntriesWaitingForTemplate()

getProjectionTemplate

AbstractProjectionTemplate getProjectionTemplate()

isOptimizedForBlobStoreOp

boolean isOptimizedForBlobStoreOp(CacheManager cacheManager)

isAllValuesIndexSqlQuery
```
boolean isAllValuesIndexSqlQuery()
```

isSqlQuery
```
boolean isSqlQuery()
```

isServerIterator
```
boolean isServerIterator()
```

getServerIteratorInfo

ServerIteratorInfo getServerIteratorInfo()

setServerIteratorInfo

void setServerIteratorInfo(ServerIteratorInfo serverIteratorInfo)

isClear
```
boolean isClear()
```

getTemplateEntryData

TemplateEntryData getTemplateEntryData()

getExplainPlan
```
SingleExplainPlan getExplainPlan()
```

getLockSubjectType
```
default LockSubjectType getLockSubjectType()
```
Specified by:

getLockSubjectType in interface IEntryHolder

Specified by:

getLockSubjectType in interface ILockedSubject

Returns:

if this subject need to be locked by its uid or by itself.

Interface ITemplateHolder

Method Summary

Methods inherited from interface com.gigaspaces.internal.server.storage.IEntryHolder

Methods inherited from interface com.gigaspaces.internal.server.storage.ISpaceItem

Methods inherited from interface com.j_spaces.kernel.locks.ILockObject

Methods inherited from interface com.j_spaces.kernel.locks.ILockedSubject

Method Detail

setUidToOperateBy

getMultipleUids

getTokenFieldNumber

getTemplateOperation

isFifoTemplate

isEmptyTemplate

isReturnOnlyUid

isInCache

setInCache

isSecondPhase

setSecondPhase

hasAnswer

getAnswerHolder

setAnswerHolder

getOperationModifiers

isMatchByID

isReadOperation

isUpdateOperation

isFifoSearch

isIfExist

isNotifyTemplate

isTakeOperation

isInitiatedEvictionOperation

isFifoGroupPoll

isBatchOperation

isReadMultiple

isTakeMultiple

isChangeMultiple

isChangeQuery

getBatchOperationContext

setBatchOperationContext

canFinishBatchOperation

isMultipleIdsOperation

getMultipleIdsContext

setMultipleIdsContext

isUpdateMultiple

setOrdinalForEntryByIdMultipleOperation

getOrdinalForEntryByIdMultipleOperation

getUpfdateOrWriteContext

setUpdateOrWriteContext

isIdQuery

getFifoThreadPartition

setFifoThreadPartition

hasExtendedMatchCodes

getExtendedMatchCodes

getRangeValue

getRangeInclusion

isInitialIfExistSearchActive

setInitialIfExistSearchActive

resetInitialIfExistSearchActive

getFifoXtnNumberOnSearchStart

setFifoXtnNumberOnSearchStart

resetFifoXtnNumberOnSearchStart

isInExpirationManager

setInExpirationManager

isExplicitInsertionToExpirationManager

getOperationID

getUpdatedEntry

setUpdatedEntry

setReRegisterLeaseOnUpdate

isReRegisterLeaseOnUpdate

getQueryResultType

getExternalEntryImplClassName

isInitialFifoSearchActive

isExclusiveReadLockOperation

isWriteLockOperation

getResponseContext

isDirtyReadRequested

isReadCommittedRequested

setInitialFifoSearchActive

getPendingFifoSearchObject

setPendingFifoSearchObject

removePendingFifoSearchObject