ParticipantRecord (Red Hat JBoss Enterprise Application Platform 7.0.0.GA public API)

java.lang.Object
- com.arjuna.ats.arjuna.StateManager
- - com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - - com.arjuna.mwlabs.wscf.model.sagas.arjunacore.ParticipantRecord

```
public class ParticipantRecord
extends com.arjuna.ats.arjuna.coordinator.AbstractRecord
```
Arjuna abstract record to handle two-phase participants.

Version:

$Id: ParticipantRecord.java,v 1.6 2005/05/19 12:13:37 nmcl Exp $

Author:

Mark Little (mark.little@arjuna.com)

Field Summary
- Fields inherited from class com.arjuna.ats.arjuna.StateManager
  modifyingActions, objectModel, objectUid, usingActions

Constructor Summary

Constructors
Constructor and Description

ParticipantRecord()

ParticipantRecord(Participant theResource, com.arjuna.ats.arjuna.common.Uid id)
Constructor.

Constructors
Constructor and Description
`ParticipantRecord()`
`ParticipantRecord(Participant theResource, com.arjuna.ats.arjuna.common.Uid id)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`alter(com.arjuna.ats.arjuna.coordinator.AbstractRecord a)`
`boolean`	`complete()`
`void`	`completed()` record the fact that this participant has completed
`static com.arjuna.ats.arjuna.coordinator.AbstractRecord`	`create()`
`void`	`delist(boolean failed)` record the fact that this participant has exited
`boolean`	`doSave()`
`boolean`	`forgetHeuristic()` The record generated a heuristic and can now forget about it.
`boolean`	`isActive()` is the participant is still able to be sent a complete request
`boolean`	`isParticipantCompletion()` is this a ParticipantCompletion participant
`void`	`merge(com.arjuna.ats.arjuna.coordinator.AbstractRecord a)`
`int`	`nestedAbort()` The record is being driven through nested rollback.
`int`	`nestedCommit()` The record is being driven through nested commit.
`int`	`nestedOnePhaseCommit()` The record is being driven through nested commit and is the only resource.
`int`	`nestedPrepare()` The record is being driven through nested prepare.
`void`	`print(PrintWriter strm)`
`boolean`	`propagateOnCommit()` Override AbstractRecord.propagateOnCommit
`boolean`	`restore_state(com.arjuna.ats.arjuna.state.InputObjectState os, int t)`
`boolean`	`save_state(com.arjuna.ats.arjuna.state.OutputObjectState os, int t)`
`void`	`setValue(Object o)` Set the internal value.
`boolean`	`shouldAdd(com.arjuna.ats.arjuna.coordinator.AbstractRecord a)`
`boolean`	`shouldAlter(com.arjuna.ats.arjuna.coordinator.AbstractRecord a)`
`boolean`	`shouldMerge(com.arjuna.ats.arjuna.coordinator.AbstractRecord a)`
`boolean`	`shouldReplace(com.arjuna.ats.arjuna.coordinator.AbstractRecord rec)`
`int`	`topLevelAbort()` The record is being driven through top-level rollback.
`int`	`topLevelCommit()` The record is being driven through top-level commit.
`int`	`topLevelOnePhaseCommit()` The record is being driven through top-level commit and is the only resource.
`int`	`topLevelPrepare()` The record is being driven through top-level prepare.
`String`	`type()`
`int`	`typeIs()` The type of this abstract record.
`Object`	`value()` The internal value.

Methods inherited from class com.arjuna.ats.arjuna.coordinator.AbstractRecord
create, equals, getNext, getPrevious, getTypeOfObject, greaterThan, lessThan, nestedCleanup, order, propagateOnAbort, replace, setNext, setPrevious, topLevelCleanup

Methods inherited from class com.arjuna.ats.arjuna.StateManager
activate, activate, cleanup, createLists, deactivate, deactivate, deactivate, destroy, disable, forgetAction, get_uid, getMutex, getObjectModel, getStore, getStoreRoot, loadObjectState, lockMutex, modified, objectType, packHeader, persist, rememberAction, setStatus, setupStore, setupStore, setupStore, status, terminate, tryLockMutex, unlockMutex, unpackHeader

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ParticipantRecord
```
public ParticipantRecord(Participant theResource,
                         com.arjuna.ats.arjuna.common.Uid id)
```
    Constructor.
    
    Parameters:
    
    theResource - is the proxy that allows us to call out to the object.
  - ParticipantRecord
```
public ParticipantRecord()
```
- Method Detail
  - propagateOnCommit
```
public boolean propagateOnCommit()
```
    Override AbstractRecord.propagateOnCommit
    
    Overrides:
    
    propagateOnCommit in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - typeIs
```
public int typeIs()
```
    The type of this abstract record.
    
    Specified by:
    
    typeIs in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - value
```
public Object value()
```
    The internal value.
    
    Specified by:
    
    value in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - setValue
```
public void setValue(Object o)
```
    Set the internal value. Not allowed for this class.
    
    Specified by:
    
    setValue in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - nestedAbort
```
public int nestedAbort()
```
    The record is being driven through nested rollback.
    
    Specified by:
    
    nestedAbort in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - nestedCommit
```
public int nestedCommit()
```
    The record is being driven through nested commit.
    
    Specified by:
    
    nestedCommit in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - nestedPrepare
```
public int nestedPrepare()
```
    The record is being driven through nested prepare.
    
    Specified by:
    
    nestedPrepare in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - topLevelAbort
```
public int topLevelAbort()
```
    The record is being driven through top-level rollback.
    
    Specified by:
    
    topLevelAbort in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - topLevelCommit
```
public int topLevelCommit()
```
    The record is being driven through top-level commit.
    
    Specified by:
    
    topLevelCommit in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - topLevelPrepare
```
public int topLevelPrepare()
```
    The record is being driven through top-level prepare.
    
    Specified by:
    
    topLevelPrepare in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - nestedOnePhaseCommit
```
public int nestedOnePhaseCommit()
```
    The record is being driven through nested commit and is the only resource.
    
    Overrides:
    
    nestedOnePhaseCommit in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - topLevelOnePhaseCommit
```
public int topLevelOnePhaseCommit()
```
    The record is being driven through top-level commit and is the only resource.
    
    Overrides:
    
    topLevelOnePhaseCommit in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - forgetHeuristic
```
public boolean forgetHeuristic()
```
    The record generated a heuristic and can now forget about it.
    
    Overrides:
    
    forgetHeuristic in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - complete
```
public boolean complete()
```
  - create
```
public static com.arjuna.ats.arjuna.coordinator.AbstractRecord create()
```
  - print
```
public void print(PrintWriter strm)
```
    Overrides:
    
    print in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - restore_state
```
public boolean restore_state(com.arjuna.ats.arjuna.state.InputObjectState os,
                             int t)
```
    Overrides:
    
    restore_state in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - save_state
```
public boolean save_state(com.arjuna.ats.arjuna.state.OutputObjectState os,
                          int t)
```
    Overrides:
    
    save_state in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - type
```
public String type()
```
    Overrides:
    
    type in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - doSave
```
public boolean doSave()
```
    Overrides:
    
    doSave in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - merge
```
public void merge(com.arjuna.ats.arjuna.coordinator.AbstractRecord a)
```
    Specified by:
    
    merge in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - alter
```
public void alter(com.arjuna.ats.arjuna.coordinator.AbstractRecord a)
```
    Specified by:
    
    alter in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - shouldAdd
```
public boolean shouldAdd(com.arjuna.ats.arjuna.coordinator.AbstractRecord a)
```
    Specified by:
    
    shouldAdd in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - shouldAlter
```
public boolean shouldAlter(com.arjuna.ats.arjuna.coordinator.AbstractRecord a)
```
    Specified by:
    
    shouldAlter in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - shouldMerge
```
public boolean shouldMerge(com.arjuna.ats.arjuna.coordinator.AbstractRecord a)
```
    Specified by:
    
    shouldMerge in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - shouldReplace
```
public boolean shouldReplace(com.arjuna.ats.arjuna.coordinator.AbstractRecord rec)
```
    Specified by:
    
    shouldReplace in class com.arjuna.ats.arjuna.coordinator.AbstractRecord
  - delist
```
public final void delist(boolean failed)
```
    record the fact that this participant has exited
    
    Parameters:
    
    failed - true if the exit was because of a failure i.e. the participant may be in an unclean state
  - completed
```
public final void completed()
```
    record the fact that this participant has completed
  - isActive
```
public final boolean isActive()
```
    is the participant is still able to be sent a complete request
    
    Returns:
    
    true if the participant is still able to be sent a complete request otherwise false
  - isParticipantCompletion
```
public final boolean isParticipantCompletion()
```
    is this a ParticipantCompletion participant
    
    Returns:
    
    true if this is a ParticipantCompletion participant otherwise false

Class ParticipantRecord

Field Summary

Fields inherited from class com.arjuna.ats.arjuna.StateManager

Constructor Summary

Method Summary

Methods inherited from class com.arjuna.ats.arjuna.coordinator.AbstractRecord

Methods inherited from class com.arjuna.ats.arjuna.StateManager

Methods inherited from class java.lang.Object

Constructor Detail

ParticipantRecord

ParticipantRecord

Method Detail

propagateOnCommit

typeIs

value

setValue

nestedAbort

nestedCommit

nestedPrepare

topLevelAbort

topLevelCommit

topLevelPrepare

nestedOnePhaseCommit

topLevelOnePhaseCommit

forgetHeuristic

complete

create

print

restore_state

save_state

type

doSave

merge

alter

shouldAdd

shouldAlter

shouldMerge

shouldReplace

delist

completed

isActive

isParticipantCompletion