wt.query
Class SavedQuery

java.lang.Object
  wt.fc.WTObject
      wt.query.SavedQuery

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public final class SavedQuery

extends WTObject

implements Externalizable

Use the newSavedQuery static factory method(s), not the SavedQuery 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
private WTPrincipalReference	creator
static String	CREATOR Label for the attribute.
private Map	criteria
static String	CRITERIA Label for the attribute.
private String	description
static String	DESCRIPTION Label for the attribute.
private static int	DESCRIPTION_UPPER_LIMIT
static long	EXTERNALIZATION_VERSION_UID
private String	name
static String	NAME Label for the attribute.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
static String	OWNING_CLIENT Label for the attribute.
private static int	OWNING_CLIENT_UPPER_LIMIT
private String	owningClient
static String	PRINCIPAL Label for the attribute.
static String	PRINCIPAL_REFERENCE Label for the attribute.
private ObjectReference	principalReference
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

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

SavedQuery()

Method Summary

private void	creatorValidate(WTPrincipalReference a_Creator)
private void	descriptionValidate(String a_Description)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getConceptualClassname() Deprecated.
WTPrincipalReference	getCreator() Gets the value of the attribute: CREATOR.
Map	getCriteria() Gets the value of the attribute: CRITERIA.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
String	getName() Gets the value of the attribute: NAME.
String	getOwningClient() Gets the value of the attribute: OWNING_CLIENT.
WTPrincipal	getPrincipal() Gets the object for the association that plays role: PRINCIPAL.
ObjectReference	getPrincipalReference() Gets the value of the attribute: PRINCIPAL_REFERENCE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private void	nameValidate(String a_Name)
static SavedQuery	newSavedQuery() Default factory for the class.
private void	owningClientValidate(String a_OwningClient)
private void	principalReferenceValidate(ObjectReference a_PrincipalReference)
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(SavedQuery thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCreator(WTPrincipalReference a_Creator) Sets the value of the attribute: CREATOR.
void	setCriteria(Map a_Criteria) Sets the value of the attribute: CRITERIA.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setOwningClient(String a_OwningClient) Sets the value of the attribute: OWNING_CLIENT.
void	setPrincipal(WTPrincipal a_Principal) Sets the object for the association that plays role: PRINCIPAL.
void	setPrincipalReference(ObjectReference a_PrincipalReference) Sets the value of the attribute: PRINCIPAL_REFERENCE.
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 wt.fc.WTObject

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

Methods inherited from class java.lang.Object

clone, 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

NAME

public static final String NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

CRITERIA

public static final String CRITERIA

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

criteria

private Map criteria

OWNING_CLIENT

public static final String OWNING_CLIENT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

OWNING_CLIENT_UPPER_LIMIT

private static int OWNING_CLIENT_UPPER_LIMIT

owningClient

private String owningClient

CREATOR

public static final String CREATOR

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

creator

private WTPrincipalReference creator

PRINCIPAL

public static final String PRINCIPAL

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

PRINCIPAL_REFERENCE

public static final String PRINCIPAL_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

principalReference

private ObjectReference principalReference

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

SavedQuery

public SavedQuery()

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

Overrides:

writeExternal in class WTObject

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

Overrides:

readExternal in class WTObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(SavedQuery 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

Overrides:

writeExternal in class WTObject

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

Overrides:

readExternal in class WTObject

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

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: false

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION.

Supported API: false

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getCriteria

public Map getCriteria()

Gets the value of the attribute: CRITERIA.

Supported API: false

Returns:

Map

setCriteria

public void setCriteria(Map a_Criteria)
                 throws WTPropertyVetoException

Sets the value of the attribute: CRITERIA.

Supported API: false

Parameters:

a_Criteria -

Throws:

WTPropertyVetoException

getOwningClient

public String getOwningClient()

Gets the value of the attribute: OWNING_CLIENT.

Supported API: false

Returns:

String

setOwningClient

public void setOwningClient(String a_OwningClient)
                     throws WTPropertyVetoException

Sets the value of the attribute: OWNING_CLIENT.

Supported API: false

Parameters:

a_OwningClient -

Throws:

WTPropertyVetoException

owningClientValidate

private void owningClientValidate(String a_OwningClient)
                           throws WTPropertyVetoException

Parameters:

a_OwningClient -

Throws:

WTPropertyVetoException

getCreator

public WTPrincipalReference getCreator()

Gets the value of the attribute: CREATOR.

Supported API: false

Returns:

WTPrincipalReference

setCreator

public void setCreator(WTPrincipalReference a_Creator)
                throws WTPropertyVetoException

Sets the value of the attribute: CREATOR.

Supported API: false

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

creatorValidate

private void creatorValidate(WTPrincipalReference a_Creator)
                      throws WTPropertyVetoException

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

getPrincipal

public WTPrincipal getPrincipal()

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

Supported API: false

Returns:

WTPrincipal

setPrincipal

public void setPrincipal(WTPrincipal a_Principal)
                  throws WTPropertyVetoException,
                         WTException

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

Supported API: false

Parameters:

a_Principal -

Throws:

WTPropertyVetoException

WTException

getPrincipalReference

public ObjectReference getPrincipalReference()

Gets the value of the attribute: PRINCIPAL_REFERENCE.

Supported API: false

Returns:

ObjectReference

setPrincipalReference

public void setPrincipalReference(ObjectReference a_PrincipalReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: PRINCIPAL_REFERENCE.

Supported API: false

Parameters:

a_PrincipalReference -

Throws:

WTPropertyVetoException

principalReferenceValidate

private void principalReferenceValidate(ObjectReference a_PrincipalReference)
                                 throws WTPropertyVetoException

Parameters:

a_PrincipalReference -

Throws:

WTPropertyVetoException

newSavedQuery

public static SavedQuery newSavedQuery()
                                throws WTException

Default factory for the class.

Supported API: false

Returns:

SavedQuery

Throws:

WTException

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

Overrides:

equals in class WTObject

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

Overrides:

hashCode in class WTObject

Returns:

int