ControlBranch (WNC.X-05.0.0.00.73)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

wt.vc
Class ControlBranch

java.lang.Object
  wt.vc.ControlBranch

All Implemented Interfaces:: ArchiveInfoHolder, Externalizable, Federatable, NetFactor, ObjectMappable, Persistable, RemotelyLinkable, Serializable

public final class ControlBranch
extends Object
implements Persistable, Federatable, ArchiveInfoHolder, Externalizable

Use the newControlBranch static factory method(s), not the ControlBranch constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:: Serialized Form

Field Summary
`private static int`	`AD_HOC_STRING_IDENTIFIER_UPPER_LIMIT`
`private String`	`adHocStringIdentifier`
`private ArchiveInfo`	`archiveInfo`
`static String`	`BRANCH_POINT` Label for the attribute.
`protected static String`	`BRANCH_POINT_UFID` Label for the attribute; Ufid of node that is branchpoint for this version Supported API: false
`private static int`	`BRANCH_POINT_UFID_UPPER_LIMIT`
`private ObjectReference`	`branchPoint`
`static String`	`BRANCHPOINT_FINALIZED` A string to indicate that the desired branchpoint is set on the the ControlBranch, and no further changes in the branchpoint are needed, while inserting iterations using insertNode API.
`private String`	`branchPointUfid`
`private static String`	`CLASSNAME`
`static long`	`EXTERNALIZATION_VERSION_UID`
`private FederatableInfo`	`federatableInfo`
`static String`	`MASTER_REFERENCE` Label for the attribute.
`private ObjectReference`	`masterReference`
`static String`	`MERGE_POINT` Label for the attribute.
`private ObjectReference`	`mergePoint`
`protected static long`	`OLD_FORMAT_VERSION_UID`
`private static int`	`ONE_OFF_VERSION_ID_UPPER_LIMIT`
`private String`	`oneOffVersionId`
`static String`	`PREDECESSOR` Label for the attribute.
`static String`	`PREDECESSOR_REFERENCE` Label for the attribute.
`private ObjectReference`	`predecessorReference`
`private static String`	`RESOURCE`
`(package private) static long`	`serialVersionUID`
`private long`	`sessionOwner`
`private PersistInfo`	`thePersistInfo`
`private static int`	`VERSION_ID_UPPER_LIMIT`
`private String`	`versionId`
`private long`	`viewId`
`private static int`	`WIP_STATE_UPPER_LIMIT`
`private String`	`wipState`

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.ufid.Federatable

FEDERATABLE_INFO

Fields inherited from interface wt.fc.archive.ArchiveInfoHolder

ARCHIVE_INFO

Constructor Summary
`ControlBranch()`

Method Summary
`private void`	`archiveInfoValidate(ArchiveInfo a_ArchiveInfo)`
`private void`	`branchPointUfidValidate(String a_BranchPointUfid)`
`private void`	`branchPointValidate(ObjectReference a_BranchPoint)`
`void`	`checkAttributes()` Validate the values of this Persistable object's attributes.
`boolean`	`equals(Object obj)` Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects `ObjectIdentifier`s.
`private void`	`federatableInfoValidate(FederatableInfo a_FederatableInfo)`
`ArchiveInfo`	`getArchiveInfo()` Gets the object for the association that plays role: ARCHIVE_INFO.
`long`	`getBranchIdentifier()`
`ObjectReference`	`getBranchPoint()` Gets the object for the association that plays role: BRANCH_POINT.
`protected String`	`getBranchPointUfid()` Gets the value of the attribute: BRANCH_POINT_UFID.
`ClassInfo`	`getClassInfo()` Returns the ClassInfo object for this class.
`String`	`getConceptualClassname()` Deprecated.
`FederatableInfo`	`getFederatableInfo()` Gets the object for the association that plays role: FEDERATABLE_INFO.
`String`	`getIdentity()` Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().
`ObjectReference`	`getMasterReference()` Gets the object for the association that plays role: MASTER_REFERENCE.
`ObjectReference`	`getMergePoint()` Gets the object for the association that plays role: MERGE_POINT.
`PersistInfo`	`getPersistInfo()` Gets the object for the association that plays role: PERSIST_INFO.
`ControlBranch`	`getPredecessor()` Gets the object for the association that plays role: PREDECESSOR.
`ObjectReference`	`getPredecessorReference()` Gets the value of the attribute: PREDECESSOR_REFERENCE.
`String`	`getType()` Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().
`int`	`hashCode()` Returns a hash code for this object based upon its `ObjectIdentifier`.
`protected void`	`initialize(Iterated iteration)` Supports initialization, following construction of an instance.
`private void`	`masterReferenceValidate(ObjectReference a_MasterReference)`
`private void`	`mergePointValidate(ObjectReference a_MergePoint)`
`static ControlBranch`	`newControlBranch(Iterated iteration)` Supported API: false
`private void`	`predecessorReferenceValidate(ObjectReference a_PredecessorReference)`
`void`	`readExternal(ObjectInput input)` Reads the non-transient fields of this class from an external source.
`void`	`readExternal(PersistentRetrieveIfc input)` Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
`private boolean`	`readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)` Reads the non-transient fields of this class from an external source, which is not the current version.
`protected boolean`	`readVersion(ControlBranch thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)` Reads the non-transient fields of this class from an external source.
`void`	`setArchiveInfo(ArchiveInfo a_ArchiveInfo)` Sets the object for the association that plays role: ARCHIVE_INFO.
`void`	`setBranchPoint(ObjectReference a_BranchPoint)` Sets the object for the association that plays role: BRANCH_POINT.
`protected void`	`setBranchPointUfid(String a_BranchPointUfid)` Sets the value of the attribute: BRANCH_POINT_UFID.
`void`	`setFederatableInfo(FederatableInfo a_FederatableInfo)` Sets the object for the association that plays role: FEDERATABLE_INFO.
`void`	`setMasterReference(ObjectReference a_MasterReference)` Sets the object for the association that plays role: MASTER_REFERENCE.
`void`	`setMergePoint(ObjectReference a_MergePoint)` Sets the object for the association that plays role: MERGE_POINT.
`void`	`setPersistInfo(PersistInfo a_PersistInfo)` Sets the object for the association that plays role: PERSIST_INFO.
`void`	`setPredecessor(ControlBranch a_Predecessor)` Sets the object for the association that plays role: PREDECESSOR.
`void`	`setPredecessorReference(ObjectReference a_PredecessorReference)` Sets the value of the attribute: PREDECESSOR_REFERENCE.
`void`	`setUntrustedBusinessFields(Iterated iteration)`
`String`	`toString()` Returns the conceptual (modeled) name for the class.
`void`	`writeExternal(ObjectOutput output)` Writes the non-transient fields of this class to an external source.
`void`	`writeExternal(PersistentStoreIfc output)` Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:: Constant Field Values

CLASSNAME

private static final String CLASSNAME

BRANCH_POINT_UFID

protected static final String BRANCH_POINT_UFID

Label for the attribute; Ufid of node that is branchpoint for this version

Supported API: false

See Also:: Constant Field Values

BRANCH_POINT_UFID_UPPER_LIMIT

private static int BRANCH_POINT_UFID_UPPER_LIMIT

branchPointUfid

private String branchPointUfid

BRANCHPOINT_FINALIZED

public static final String BRANCHPOINT_FINALIZED

A string to indicate that the desired branchpoint is set on the the ControlBranch, and no further changes in the branchpoint are needed, while inserting iterations using insertNode API. This is set when the node pointed by the branchPointUfid is inserted into the system. In other cases, when an iteration later than the current latest is being inserted into a version, the branchpoint of the successor version(s) is updated to the inserted iteration.

Supported API: false

See Also:: Constant Field Values

VERSION_ID_UPPER_LIMIT

private static int VERSION_ID_UPPER_LIMIT

versionId

private String versionId

ONE_OFF_VERSION_ID_UPPER_LIMIT

private static int ONE_OFF_VERSION_ID_UPPER_LIMIT

oneOffVersionId

private String oneOffVersionId

viewId

private long viewId

AD_HOC_STRING_IDENTIFIER_UPPER_LIMIT

private static int AD_HOC_STRING_IDENTIFIER_UPPER_LIMIT

adHocStringIdentifier

private String adHocStringIdentifier

WIP_STATE_UPPER_LIMIT

private static int WIP_STATE_UPPER_LIMIT

wipState

private String wipState