wt.index
Class IndexPolicy

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          wt.index.IndexPolicy

All Implemented Interfaces:

AccessControlled, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class IndexPolicy

extends Item

implements Externalizable

IndexPolicy objects hold the name of the domain to which they belong.

Use the newIndexPolicy static factory method(s), not the IndexPolicy 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 String	CLASSNAME Deprecated.
static long	EXTERNALIZATION_VERSION_UID Deprecated.
private static int	NRETRIES Deprecated.
protected static long	OLD_FORMAT_VERSION_UID Deprecated.
static String	POLICY_OWNER_REF Deprecated.
private ObjectReference	policyOwnerRef Deprecated.
private static String	RESOURCE Deprecated.
(package private) static long	serialVersionUID Deprecated.
private static int	SLEEPTIME Deprecated.
private static boolean	VERBOSE_POLICY Deprecated.

Fields inherited from class wt.fc.Item

VERSION_40_UID, VERSION_51_UID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

IndexPolicy()
Deprecated.

Method Summary

boolean	equals(Object obj) Deprecated.
String	getConceptualClassname() Deprecated.
ObjectReference	getPolicyOwnerRef() Deprecated.
int	hashCode() Deprecated.
protected void	initialize(AdministrativeDomain domain) Deprecated.
protected void	initialize(ObjectReference owner_ref) Deprecated.
static IndexPolicy	newIndexPolicy(AdministrativeDomain domain) Deprecated.
static IndexPolicy	newIndexPolicy(ObjectReference owner_ref) Deprecated.
void	readExternal(ObjectInput input) Deprecated.
void	readExternal(PersistentRetrieveIfc input) Deprecated.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated. Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(IndexPolicy thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Deprecated.
void	setPolicyOwnerRef(ObjectReference a_PolicyOwnerRef) Deprecated.
String	toString() Deprecated.
void	writeExternal(ObjectOutput output) Deprecated.
void	writeExternal(PersistentStoreIfc output) Deprecated.

Methods inherited from class wt.fc.Item

getDomainRef, initialize, isInheritedDomain, readVersion, setDomainRef, setInheritedDomain

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

Deprecated.

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Deprecated.

POLICY_OWNER_REF

public static final String POLICY_OWNER_REF

Deprecated.

Label for the attribute; reference to the domain that "owns" the policy.

Supported API: false

See Also:

Constant Field Values

policyOwnerRef

private ObjectReference policyOwnerRef

Deprecated.

serialVersionUID

static final long serialVersionUID

Deprecated.

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

Deprecated.

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

Deprecated.

See Also:

Constant Field Values

VERBOSE_POLICY

private static boolean VERBOSE_POLICY

Deprecated.

NRETRIES

private static final int NRETRIES

Deprecated.

See Also:

Constant Field Values

SLEEPTIME

private static final int SLEEPTIME

Deprecated.

See Also:

Constant Field Values

Constructor Detail

IndexPolicy

public IndexPolicy()

Deprecated.

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Deprecated.

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

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class Item

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Deprecated.

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

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class Item

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Overrides:

writeExternal in class Item

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Deprecated.

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

Overrides:

readExternal in class Item

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

getPolicyOwnerRef

public ObjectReference getPolicyOwnerRef()

Deprecated.

Gets the value of the attribute: POLICY_OWNER_REF. reference to the domain that "owns" the policy.

Supported API: false

Returns:

ObjectReference

setPolicyOwnerRef

public void setPolicyOwnerRef(ObjectReference a_PolicyOwnerRef)

Deprecated.

Sets the value of the attribute: POLICY_OWNER_REF. reference to the domain that "owns" the policy.

Supported API: false

Parameters:

a_PolicyOwnerRef -

newIndexPolicy

public static IndexPolicy newIndexPolicy(AdministrativeDomain domain)
                                  throws WTException

Deprecated.

Constructs an index policy given its domain.

Supported API: false

Parameters:

domain -

Returns:

IndexPolicy

Throws:

WTException

initialize

protected void initialize(AdministrativeDomain domain)
                   throws WTException

Deprecated.

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

Supported API: false

Parameters:

domain -

Throws:

WTException

newIndexPolicy

public static IndexPolicy newIndexPolicy(ObjectReference owner_ref)
                                  throws WTException

Deprecated.

Constructs an index policy given a reference to its domain.

Supported API: false

Parameters:

owner_ref -

Returns:

IndexPolicy

Throws:

WTException

initialize

protected void initialize(ObjectReference owner_ref)
                   throws WTException

Deprecated.

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

Supported API: false

Parameters:

owner_ref -

Throws:

WTException

toString

public String toString()

Deprecated.

Creates a string representation of the object.

Supported API: false

Overrides:

toString in class WTObject

Returns:

String

equals

public boolean equals(Object obj)

Deprecated.

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

Overrides:

equals in class Item

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Deprecated.

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

Overrides:

hashCode in class Item

Returns:

int