wt.eff.format
Class EffState

java.lang.Object
  wt.eff.format.EffState

All Implemented Interfaces:

Serializable

public final class EffState
extends Object
implements Serializable

A class that is designed to hold the state associated while processing one or many effectivity statements.

Instances of EffState are designed and treated as immutable, once initialized during construction (where the class invariant is established). Hence they can be safely shared and are thread-safe.


Supported API: true

Extendable: false

Since:

Windchill 9.0

See Also:

EffRangeValues, EffFormat, EffFormatService, Serialized Form

Field Summary

WTContainerRef	containerRef Reference to the windchill WTContainer the current use case or the its context occurs/resides in.
ObjectReference	contextObjRef (Optional) An object reference to the effectivity context object if supported by the effectivity type.
wt.eff.format.EffType	effType The effectivity type being considered as part of the transaction.

Constructor Summary

EffState(wt.eff.format.EffType effType, ObjectReference contextObjRef, WTContainerRef containerRef)
Constructs an EffState instance with the provided arguments.

Method Summary

WTContainerRef	getContainerRef() Gets the value of the attribute: containerRef; Reference to the windchill WTContainer the current use case or the its context occurs/resides in.
ObjectReference	getContextObjRef() Gets the value of the attribute: contextObjRef; (Optional) An object reference to the effectivity context object if supported by the effectivity type.
wt.eff.format.EffType	getEffType() Gets the value of the attribute: effType; The effectivity type being considered as part of the transaction.

Methods inherited from class java.lang.Object

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

Field Detail

effType

public final wt.eff.format.EffType effType

The effectivity type being considered as part of the transaction.

Supported API: true

contextObjRef

public final ObjectReference contextObjRef

(Optional) An object reference to the effectivity context object if supported by the effectivity type. In the case of creating part instances, the context object is the traceable part identified with the part instance.

Supported API: true

containerRef

public final WTContainerRef containerRef

Reference to the windchill WTContainer the current use case or the its context occurs/resides in.

Supported API: true

Constructor Detail

EffState

public EffState(wt.eff.format.EffType effType,
                ObjectReference contextObjRef,
                WTContainerRef containerRef)

Constructs an EffState instance with the provided arguments.

Supported API: true

Parameters:

effType - (Required) The effectivity type being considered as part of the transaction.

contextObjRef - (Optional) An object reference to the effectivity context object if supported by the effectivity type. In the case of creating part instances, the context object is the traceable part identified with the part instance.

containerRef - (Required) Reference to the windchill container the current use case or the its context occurs/resides in.

Throws:

NullPointerException - if either the required effType or containerRef arguments are null.

Method Detail

getEffType

public final wt.eff.format.EffType getEffType()

Gets the value of the attribute: effType; The effectivity type being considered as part of the transaction.

Supported API: true

Returns:

EffType

getContextObjRef

public final ObjectReference getContextObjRef()

Gets the value of the attribute: contextObjRef; (Optional) An object reference to the effectivity context object if supported by the effectivity type. In the case of creating part instances, the context object is the traceable part identified with the part instance.

Supported API: true

Returns:

ObjectReference

getContainerRef

public final WTContainerRef getContainerRef()

Gets the value of the attribute: containerRef; Reference to the windchill WTContainer the current use case or the its context occurs/resides in.

Supported API: true

Returns:

WTContainerRef