wt.occurrence
Class CombinedPathOccurrenceDocumentation

java.lang.Object
  wt.occurrence.CombinedPathOccurrenceDocumentation

All Implemented Interfaces:

CombinedPathOccurrenceData, DocumentationOccurrenceData, Externalizable, Iterated, NetFactor, ObjectMappable, OccurrenceData, Persistable, Serializable

public final class CombinedPathOccurrenceDocumentation

extends Object

implements DocumentationOccurrenceData, CombinedPathOccurrenceData, Externalizable

This DocumentationOccurrenceData allows a CombinedPathOccurrence to have an associated WTDocument version.

Use the newCombinedPathOccurrenceDocumentation static factory method(s), not the CombinedPathOccurrenceDocumentation 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: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static String	CONTEXT Label for the attribute.
private ObjectReference	contextReference
private ControlBranch	controlBranch
static String	DOC Label for the attribute.
private ObjectReference	docReference
static long	EXTERNALIZATION_VERSION_UID
private IterationInfo	iterationInfo
static String	MASTER Label for the attribute.
private ObjectReference	masterReference
static String	OCC Label for the attribute.
private ObjectReference	occReference
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo

Fields inherited from interface wt.occurrence.DocumentationOccurrenceData

DOC_REFERENCE

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.occurrence.CombinedPathOccurrenceData

CONTEXT_REFERENCE, MASTER_REFERENCE, OCC_REFERENCE

Fields inherited from interface wt.vc.Iterated

BRANCH_IDENTIFIER, CONTROL_BRANCH, CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, ITERATION_IDENTIFIER, ITERATION_INFO, ITERATION_NOTE, LATEST_ITERATION, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

Constructor Summary

CombinedPathOccurrenceDocumentation()

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
private void	contextReferenceValidate(ObjectReference a_ContextReference)
private void	docReferenceValidate(ObjectReference a_DocReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
long	getBranchIdentifier() Gets the value of the attribute: BRANCH_IDENTIFIER.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
PathOccurrenceContext	getContext() Gets the object for the association that plays role: CONTEXT.
ObjectReference	getContextReference() Gets the value of the attribute: CONTEXT_REFERENCE.
ControlBranch	getControlBranch() Gets the value of the attribute: CONTROL_BRANCH.
WTPrincipalReference	getCreator() Gets the value of the attribute: CREATOR.
String	getCreatorEMail() Gets the value of the attribute: CREATOR_EMAIL.
String	getCreatorFullName() Gets the value of the attribute: CREATOR_FULL_NAME.
String	getCreatorName() Gets the value of the attribute: CREATOR_NAME.
WTDocument	getDoc() Gets the object for the association that plays role: DOC.
ObjectReference	getDocReference() Gets the value of the attribute: DOC_REFERENCE.
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().
IterationIdentifier	getIterationIdentifier() Gets the value of the attribute: ITERATION_IDENTIFIER.
IterationInfo	getIterationInfo() Gets the object for the association that plays role: ITERATION_INFO.
String	getIterationNote() Gets the value of the attribute: ITERATION_NOTE.
Mastered	getMaster() Gets the object for the association that plays role: MASTER.
ObjectReference	getMasterReference() Gets the value of the attribute: MASTER_REFERENCE.
WTPrincipalReference	getModifier() Gets the value of the attribute: MODIFIER.
String	getModifierEMail() Gets the value of the attribute: MODIFIER_EMAIL.
String	getModifierFullName() Gets the value of the attribute: MODIFIER_FULL_NAME.
String	getModifierName() Gets the value of the attribute: MODIFIER_NAME.
CombinedPathOccurrence	getOcc() Gets the object for the association that plays role: OCC.
ObjectReference	getOccReference() Gets the value of the attribute: OCC_REFERENCE.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
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(CombinedPathOccurrence occurrence, PathOccurrenceContext context, WTDocument document) Supports initialization, following construction of an instance.
boolean	isLatestIteration() Gets the value of the attribute: LATEST_ITERATION.
private void	iterationInfoValidate(IterationInfo a_IterationInfo)
private void	masterReferenceValidate(ObjectReference a_MasterReference)
static CombinedPathOccurrenceDocumentation	newCombinedPathOccurrenceDocumentation(CombinedPathOccurrence occurrence, PathOccurrenceContext context, WTDocument document) Supported API: false
private void	occReferenceValidate(ObjectReference a_OccReference)
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(CombinedPathOccurrenceDocumentation thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setContext(PathOccurrenceContext a_Context) Sets the object for the association that plays role: CONTEXT.
void	setContextReference(ObjectReference a_ContextReference) Sets the value of the attribute: CONTEXT_REFERENCE.
void	setControlBranch(ControlBranch a_ControlBranch) Sets the value of the attribute: CONTROL_BRANCH.
void	setDoc(WTDocument a_Doc) Sets the object for the association that plays role: DOC.
void	setDocReference(ObjectReference a_DocReference) Sets the value of the attribute: DOC_REFERENCE.
void	setIterationInfo(IterationInfo a_IterationInfo) Sets the object for the association that plays role: ITERATION_INFO.
void	setMaster(Mastered a_Master) Sets the object for the association that plays role: MASTER.
void	setMasterReference(ObjectReference a_MasterReference) Sets the value of the attribute: MASTER_REFERENCE.
void	setOcc(CombinedPathOccurrence a_Occ) Sets the object for the association that plays role: OCC.
void	setOccReference(ObjectReference a_OccReference) Sets the value of the attribute: OCC_REFERENCE.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
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

DOC

public static final String DOC

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

docReference

private ObjectReference docReference

thePersistInfo

private PersistInfo thePersistInfo

OCC

public static final String OCC

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

occReference

private ObjectReference occReference

CONTEXT

public static final String CONTEXT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

contextReference

private ObjectReference contextReference

MASTER

public static final String MASTER

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

masterReference

private ObjectReference masterReference

controlBranch

private ControlBranch controlBranch

iterationInfo

private IterationInfo iterationInfo

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

CombinedPathOccurrenceDocumentation

public CombinedPathOccurrenceDocumentation()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(CombinedPathOccurrenceDocumentation thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

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.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

newCombinedPathOccurrenceDocumentation

public static CombinedPathOccurrenceDocumentation newCombinedPathOccurrenceDocumentation(CombinedPathOccurrence occurrence,
                                                                                         PathOccurrenceContext context,
                                                                                         WTDocument document)
                                                                                  throws WTException

Supported API: false

Parameters:

occurrence -

context -

document -

Returns:

CombinedPathOccurrenceDocumentation

Throws:

WTException

initialize

protected void initialize(CombinedPathOccurrence occurrence,
                          PathOccurrenceContext context,
                          WTDocument document)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

occurrence -

context -

document -

Throws:

WTException

getDoc

public WTDocument getDoc()

Gets the object for the association that plays role: DOC.

Supported API: false

Specified by:

getDoc in interface DocumentationOccurrenceData

Returns:

WTDocument

setDoc

public void setDoc(WTDocument a_Doc)
            throws WTPropertyVetoException,
                   WTException

Sets the object for the association that plays role: DOC.

Supported API: false

Specified by:

setDoc in interface DocumentationOccurrenceData

Parameters:

a_Doc -

Throws:

WTPropertyVetoException

WTException

getDocReference

public ObjectReference getDocReference()

Gets the value of the attribute: DOC_REFERENCE.

Supported API: false

Specified by:

getDocReference in interface DocumentationOccurrenceData

Returns:

ObjectReference

setDocReference

public void setDocReference(ObjectReference a_DocReference)
                     throws WTPropertyVetoException

Sets the value of the attribute: DOC_REFERENCE.

Supported API: false

Specified by:

setDocReference in interface DocumentationOccurrenceData

Parameters:

a_DocReference -

Throws:

WTPropertyVetoException

docReferenceValidate

private void docReferenceValidate(ObjectReference a_DocReference)
                           throws WTPropertyVetoException

Parameters:

a_DocReference -

Throws:

WTPropertyVetoException

getIdentity

public 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().

Gets the value of the attribute: IDENTITY. Supplies the identity of the object for business purposes. The identity is composed of name, number or possibly other attributes. The identity does not include the type of the object.

Supported API: false

Specified by:

getIdentity in interface Persistable

Returns:

String

getType

public String getType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: TYPE. Identifies the type of the object for business purposes. This is typically the class name of the object but may be derived from some other attribute of the object.

Supported API: false

Specified by:

getType in interface Persistable

Returns:

String

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Throws:

InvalidAttributeException

getPersistInfo

public PersistInfo getPersistInfo()

Gets the object for the association that plays role: PERSIST_INFO.

Supported API: false

Specified by:

getPersistInfo in interface Persistable

Returns:

PersistInfo

setPersistInfo

public void setPersistInfo(PersistInfo a_PersistInfo)

Sets the object for the association that plays role: PERSIST_INFO.

Supported API: false

Specified by:

setPersistInfo in interface Persistable

Parameters:

a_PersistInfo -

getOcc

public CombinedPathOccurrence getOcc()

Gets the object for the association that plays role: OCC.

Supported API: true

Specified by:

getOcc in interface CombinedPathOccurrenceData

Returns:

CombinedPathOccurrence

setOcc

public void setOcc(CombinedPathOccurrence a_Occ)
            throws WTPropertyVetoException,
                   WTException

Sets the object for the association that plays role: OCC.

Supported API: true

Specified by:

setOcc in interface CombinedPathOccurrenceData

Parameters:

a_Occ -

Throws:

WTPropertyVetoException

WTException

getOccReference

public ObjectReference getOccReference()

Gets the value of the attribute: OCC_REFERENCE.

Supported API: true

Specified by:

getOccReference in interface CombinedPathOccurrenceData

Returns:

ObjectReference

setOccReference

public void setOccReference(ObjectReference a_OccReference)
                     throws WTPropertyVetoException

Sets the value of the attribute: OCC_REFERENCE.

Supported API: true

Specified by:

setOccReference in interface CombinedPathOccurrenceData

Parameters:

a_OccReference -

Throws:

WTPropertyVetoException

occReferenceValidate

private void occReferenceValidate(ObjectReference a_OccReference)
                           throws WTPropertyVetoException

Parameters:

a_OccReference -

Throws:

WTPropertyVetoException

getContext

public PathOccurrenceContext getContext()

Gets the object for the association that plays role: CONTEXT.

Supported API: false

Specified by:

getContext in interface CombinedPathOccurrenceData

Returns:

PathOccurrenceContext

setContext

public void setContext(PathOccurrenceContext a_Context)
                throws WTPropertyVetoException,
                       WTException

Sets the object for the association that plays role: CONTEXT.

Supported API: false

Specified by:

setContext in interface CombinedPathOccurrenceData

Parameters:

a_Context -

Throws:

WTPropertyVetoException

WTException

getContextReference

public ObjectReference getContextReference()

Gets the value of the attribute: CONTEXT_REFERENCE.

Supported API: false

Specified by:

getContextReference in interface CombinedPathOccurrenceData

Returns:

ObjectReference

setContextReference

public void setContextReference(ObjectReference a_ContextReference)
                         throws WTPropertyVetoException

Sets the value of the attribute: CONTEXT_REFERENCE.

Supported API: false

Specified by:

setContextReference in interface CombinedPathOccurrenceData

Parameters:

a_ContextReference -

Throws:

WTPropertyVetoException

contextReferenceValidate

private void contextReferenceValidate(ObjectReference a_ContextReference)
                               throws WTPropertyVetoException

Parameters:

a_ContextReference -

Throws:

WTPropertyVetoException

getMaster

public Mastered getMaster()

Gets the object for the association that plays role: MASTER.

Supported API: true

Specified by:

getMaster in interface CombinedPathOccurrenceData

Returns:

Mastered

setMaster

public void setMaster(Mastered a_Master)
               throws WTPropertyVetoException,
                      WTException

Sets the object for the association that plays role: MASTER.

Supported API: true

Specified by:

setMaster in interface CombinedPathOccurrenceData

Parameters:

a_Master -

Throws:

WTPropertyVetoException

WTException

getMasterReference

public ObjectReference getMasterReference()

Gets the value of the attribute: MASTER_REFERENCE.

Supported API: true

Specified by:

getMasterReference in interface CombinedPathOccurrenceData

Returns:

ObjectReference

setMasterReference

public void setMasterReference(ObjectReference a_MasterReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: MASTER_REFERENCE.

Supported API: true

Specified by:

setMasterReference in interface CombinedPathOccurrenceData

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

masterReferenceValidate

private void masterReferenceValidate(ObjectReference a_MasterReference)
                              throws WTPropertyVetoException

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

getIterationNote

public String getIterationNote()

Gets the value of the attribute: ITERATION_NOTE. Derived attribute for displaying the iteration's note in query results.

Supported API: true

Specified by:

getIterationNote in interface Iterated

Returns:

String

getCreatorEMail

public String getCreatorEMail()

Gets the value of the attribute: CREATOR_EMAIL. Derived attribute for displaying the iteration creator's E-Mail address in query results.

Supported API: true

Specified by:

getCreatorEMail in interface Iterated

Returns:

String

getCreatorName

public String getCreatorName()

Gets the value of the attribute: CREATOR_NAME. Derived attribute for displaying the iteration creator's name in query results.

Supported API: true

Specified by:

getCreatorName in interface Iterated

Returns:

String

getCreatorFullName

public String getCreatorFullName()

Gets the value of the attribute: CREATOR_FULL_NAME. Derived attribute for displaying the iteration creator's fullname in query results.

Supported API: true

Specified by:

getCreatorFullName in interface Iterated

Returns:

String

getModifier

public WTPrincipalReference getModifier()

Gets the value of the attribute: MODIFIER. Derived attribute for displaying the iteration's modifier in query results.

Supported API: true

Specified by:

getModifier in interface Iterated

Returns:

WTPrincipalReference

getModifierEMail

public String getModifierEMail()

Gets the value of the attribute: MODIFIER_EMAIL. Derived attribute for displaying the iteration modifier's E-Mail address in query results.

Supported API: true

Specified by:

getModifierEMail in interface Iterated

Returns:

String

getModifierName

public String getModifierName()

Gets the value of the attribute: MODIFIER_NAME. Derived attribute for displaying the iteration modifier's name in query results.

Supported API: true

Specified by:

getModifierName in interface Iterated

Returns:

String

getModifierFullName

public String getModifierFullName()

Gets the value of the attribute: MODIFIER_FULL_NAME. Derived attribute for displaying the iteration modifier's fullname in query results.

Supported API: true

Specified by:

getModifierFullName in interface Iterated

Returns:

String

getIterationIdentifier

public IterationIdentifier getIterationIdentifier()

Gets the value of the attribute: ITERATION_IDENTIFIER. Derived attribute for displaying the iteration identifier in query results.

Supported API: true

Specified by:

getIterationIdentifier in interface Iterated

Returns:

IterationIdentifier

getBranchIdentifier

public long getBranchIdentifier()

Gets the value of the attribute: BRANCH_IDENTIFIER. Derived attribute for displaying the iteration's branch identifier in query results.

Supported API: false

Specified by:

getBranchIdentifier in interface Iterated

Returns:

long

isLatestIteration

public boolean isLatestIteration()

Gets the value of the attribute: LATEST_ITERATION. Derived attribute for displaying the iteration "latest" flag in query results.

Supported API: true

Specified by:

isLatestIteration in interface Iterated

Returns:

boolean

getCreator

public WTPrincipalReference getCreator()

Gets the value of the attribute: CREATOR. Derived attribute for displaying the Version Creator. Will be the same for each iteration of a Version. A Version corresponds to all iterations for a given branchId

Supported API: false

Specified by:

getCreator in interface Iterated

Returns:

WTPrincipalReference

getControlBranch

public ControlBranch getControlBranch()

Gets the value of the attribute: CONTROL_BRANCH.

Supported API: true

Specified by:

getControlBranch in interface Iterated

Returns:

ControlBranch

setControlBranch

public void setControlBranch(ControlBranch a_ControlBranch)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTROL_BRANCH.

Supported API: true

Specified by:

setControlBranch in interface Iterated

Parameters:

a_ControlBranch -

Throws:

WTPropertyVetoException

getIterationInfo

public IterationInfo getIterationInfo()

Gets the object for the association that plays role: ITERATION_INFO. The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Specified by:

getIterationInfo in interface Iterated

Returns:

IterationInfo

See Also:

IterationInfo

setIterationInfo

public void setIterationInfo(IterationInfo a_IterationInfo)
                      throws WTPropertyVetoException

Sets the object for the association that plays role: ITERATION_INFO. The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Specified by:

setIterationInfo in interface Iterated

Parameters:

a_IterationInfo -

Throws:

WTPropertyVetoException

See Also:

IterationInfo

iterationInfoValidate

private void iterationInfoValidate(IterationInfo a_IterationInfo)
                            throws WTPropertyVetoException

Parameters:

a_IterationInfo -

Throws:

WTPropertyVetoException

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Returns:

int