wt.ixb.conflictFramework
Class ElementImportInfo

java.lang.Object
  wt.fc.WTObject
      wt.ixb.conflictFramework.ElementImportInfo

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class ElementImportInfo

extends WTObject

implements Externalizable

Use the newElementImportInfo static factory method(s), not the ElementImportInfo 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 String	action
static String	ACTION Label for the attribute.
static String	ACTION_PARAMETERS Label for the attribute.
private static int	ACTION_PARAMETERS_UPPER_LIMIT
private static int	ACTION_UPPER_LIMIT
private String	actionParameters
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static String	FILE_XML_DISPLAY_ID Label for the attribute.
private static int	FILE_XML_DISPLAY_ID_UPPER_LIMIT
static String	FILE_XML_ID Label for the attribute.
private static int	FILE_XML_ID_UPPER_LIMIT
private String	fileXmlDisplayId
private String	fileXmlId
static String	IMPORT_SESSION Label for the attribute.
static String	IMPORT_SESSION_REFERENCE Label for the attribute.
private ObjectReference	importSessionReference
static String	MATCHING_OBJ_DISPLAY_ID Label for the attribute.
private static int	MATCHING_OBJ_DISPLAY_ID_UPPER_LIMIT
static String	MATCHING_OBJ_ID Label for the attribute.
private static int	MATCHING_OBJ_ID_UPPER_LIMIT
private String	matchingObjDisplayId
private String	matchingObjId
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	USER_DEFINED_ACTION_SET Label for the attribute.
private boolean	userDefinedActionSet

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

ElementImportInfo()

Method Summary

private void	actionParametersValidate(String a_ActionParameters)
private void	actionValidate(String a_Action)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
private void	fileXmlDisplayIdValidate(String a_FileXmlDisplayId)
private void	fileXmlIdValidate(String a_FileXmlId)
String	getAction() Gets the value of the attribute: ACTION.
String	getActionParameters() Gets the value of the attribute: ACTION_PARAMETERS.
String	getConceptualClassname() Deprecated.
String	getFileXmlDisplayId() Gets the value of the attribute: FILE_XML_DISPLAY_ID.
String	getFileXmlId() Gets the value of the attribute: FILE_XML_ID.
ImportSession	getImportSession() Gets the object for the association that plays role: IMPORT_SESSION.
ObjectReference	getImportSessionReference() Gets the value of the attribute: IMPORT_SESSION_REFERENCE.
String	getMatchingObjDisplayId() Gets the value of the attribute: MATCHING_OBJ_DISPLAY_ID.
String	getMatchingObjId() Gets the value of the attribute: MATCHING_OBJ_ID.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private void	importSessionReferenceValidate(ObjectReference a_ImportSessionReference)
boolean	isUserDefinedActionSet() Gets the value of the attribute: USER_DEFINED_ACTION_SET.
private void	matchingObjDisplayIdValidate(String a_MatchingObjDisplayId)
private void	matchingObjIdValidate(String a_MatchingObjId)
static ElementImportInfo	newElementImportInfo() Default factory for the class.
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(ElementImportInfo thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAction(String a_Action) Sets the value of the attribute: ACTION.
void	setActionParameters(String a_ActionParameters) Sets the value of the attribute: ACTION_PARAMETERS.
void	setFileXmlDisplayId(String a_FileXmlDisplayId) Sets the value of the attribute: FILE_XML_DISPLAY_ID.
void	setFileXmlId(String a_FileXmlId) Sets the value of the attribute: FILE_XML_ID.
void	setImportSession(ImportSession a_ImportSession) Sets the object for the association that plays role: IMPORT_SESSION.
void	setImportSessionReference(ObjectReference a_ImportSessionReference) Sets the value of the attribute: IMPORT_SESSION_REFERENCE.
void	setMatchingObjDisplayId(String a_MatchingObjDisplayId) Sets the value of the attribute: MATCHING_OBJ_DISPLAY_ID.
void	setMatchingObjId(String a_MatchingObjId) Sets the value of the attribute: MATCHING_OBJ_ID.
void	setUserDefinedActionSet(boolean a_UserDefinedActionSet) Sets the value of the attribute: USER_DEFINED_ACTION_SET.
void	update(String objId, String objDisplayId, String action, String actionParams)
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

FILE_XML_ID

public static final String FILE_XML_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

FILE_XML_ID_UPPER_LIMIT

private static int FILE_XML_ID_UPPER_LIMIT

fileXmlId

private String fileXmlId

FILE_XML_DISPLAY_ID

public static final String FILE_XML_DISPLAY_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

FILE_XML_DISPLAY_ID_UPPER_LIMIT

private static int FILE_XML_DISPLAY_ID_UPPER_LIMIT

fileXmlDisplayId

private String fileXmlDisplayId

MATCHING_OBJ_ID

public static final String MATCHING_OBJ_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

MATCHING_OBJ_ID_UPPER_LIMIT

private static int MATCHING_OBJ_ID_UPPER_LIMIT

matchingObjId

private String matchingObjId

MATCHING_OBJ_DISPLAY_ID

public static final String MATCHING_OBJ_DISPLAY_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

MATCHING_OBJ_DISPLAY_ID_UPPER_LIMIT

private static int MATCHING_OBJ_DISPLAY_ID_UPPER_LIMIT

matchingObjDisplayId

private String matchingObjDisplayId

ACTION

public static final String ACTION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ACTION_UPPER_LIMIT

private static int ACTION_UPPER_LIMIT

action

private String action

ACTION_PARAMETERS

public static final String ACTION_PARAMETERS

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ACTION_PARAMETERS_UPPER_LIMIT

private static int ACTION_PARAMETERS_UPPER_LIMIT

actionParameters

private String actionParameters

USER_DEFINED_ACTION_SET

public static final String USER_DEFINED_ACTION_SET

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

userDefinedActionSet

private boolean userDefinedActionSet

IMPORT_SESSION

public static final String IMPORT_SESSION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

IMPORT_SESSION_REFERENCE

public static final String IMPORT_SESSION_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

importSessionReference

private ObjectReference importSessionReference

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

ElementImportInfo

public ElementImportInfo()

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(ElementImportInfo 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

getFileXmlId

public String getFileXmlId()

Gets the value of the attribute: FILE_XML_ID.

Supported API: false

Returns:

String

setFileXmlId

public void setFileXmlId(String a_FileXmlId)
                  throws WTPropertyVetoException

Sets the value of the attribute: FILE_XML_ID.

Supported API: false

Parameters:

a_FileXmlId -

Throws:

WTPropertyVetoException

fileXmlIdValidate

private void fileXmlIdValidate(String a_FileXmlId)
                        throws WTPropertyVetoException

Parameters:

a_FileXmlId -

Throws:

WTPropertyVetoException

getFileXmlDisplayId

public String getFileXmlDisplayId()

Gets the value of the attribute: FILE_XML_DISPLAY_ID.

Supported API: false

Returns:

String

setFileXmlDisplayId

public void setFileXmlDisplayId(String a_FileXmlDisplayId)
                         throws WTPropertyVetoException

Sets the value of the attribute: FILE_XML_DISPLAY_ID.

Supported API: false

Parameters:

a_FileXmlDisplayId -

Throws:

WTPropertyVetoException

fileXmlDisplayIdValidate

private void fileXmlDisplayIdValidate(String a_FileXmlDisplayId)
                               throws WTPropertyVetoException

Parameters:

a_FileXmlDisplayId -

Throws:

WTPropertyVetoException

getMatchingObjId

public String getMatchingObjId()

Gets the value of the attribute: MATCHING_OBJ_ID.

Supported API: false

Returns:

String

setMatchingObjId

public void setMatchingObjId(String a_MatchingObjId)
                      throws WTPropertyVetoException

Sets the value of the attribute: MATCHING_OBJ_ID.

Supported API: false

Parameters:

a_MatchingObjId -

Throws:

WTPropertyVetoException

matchingObjIdValidate

private void matchingObjIdValidate(String a_MatchingObjId)
                            throws WTPropertyVetoException

Parameters:

a_MatchingObjId -

Throws:

WTPropertyVetoException

getMatchingObjDisplayId

public String getMatchingObjDisplayId()

Gets the value of the attribute: MATCHING_OBJ_DISPLAY_ID.

Supported API: false

Returns:

String

setMatchingObjDisplayId

public void setMatchingObjDisplayId(String a_MatchingObjDisplayId)
                             throws WTPropertyVetoException

Sets the value of the attribute: MATCHING_OBJ_DISPLAY_ID.

Supported API: false

Parameters:

a_MatchingObjDisplayId -

Throws:

WTPropertyVetoException

matchingObjDisplayIdValidate

private void matchingObjDisplayIdValidate(String a_MatchingObjDisplayId)
                                   throws WTPropertyVetoException

Parameters:

a_MatchingObjDisplayId -

Throws:

WTPropertyVetoException

getAction

public String getAction()

Gets the value of the attribute: ACTION.

Supported API: false

Returns:

String

setAction

public void setAction(String a_Action)
               throws WTPropertyVetoException

Sets the value of the attribute: ACTION.

Supported API: false

Parameters:

a_Action -

Throws:

WTPropertyVetoException

actionValidate

private void actionValidate(String a_Action)
                     throws WTPropertyVetoException

Parameters:

a_Action -

Throws:

WTPropertyVetoException

getActionParameters

public String getActionParameters()

Gets the value of the attribute: ACTION_PARAMETERS.

Supported API: false

Returns:

String

setActionParameters

public void setActionParameters(String a_ActionParameters)
                         throws WTPropertyVetoException

Sets the value of the attribute: ACTION_PARAMETERS.

Supported API: false

Parameters:

a_ActionParameters -

Throws:

WTPropertyVetoException

actionParametersValidate

private void actionParametersValidate(String a_ActionParameters)
                               throws WTPropertyVetoException

Parameters:

a_ActionParameters -

Throws:

WTPropertyVetoException

isUserDefinedActionSet

public boolean isUserDefinedActionSet()

Gets the value of the attribute: USER_DEFINED_ACTION_SET.

Supported API: false

Returns:

boolean

setUserDefinedActionSet

public void setUserDefinedActionSet(boolean a_UserDefinedActionSet)
                             throws WTPropertyVetoException

Sets the value of the attribute: USER_DEFINED_ACTION_SET.

Supported API: false

Parameters:

a_UserDefinedActionSet -

Throws:

WTPropertyVetoException

getImportSession

public ImportSession getImportSession()

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

Supported API: false

Returns:

ImportSession

setImportSession

public void setImportSession(ImportSession a_ImportSession)
                      throws WTPropertyVetoException,
                             WTException

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

Supported API: false

Parameters:

a_ImportSession -

Throws:

WTPropertyVetoException

WTException

getImportSessionReference

public ObjectReference getImportSessionReference()

Gets the value of the attribute: IMPORT_SESSION_REFERENCE.

Supported API: false

Returns:

ObjectReference

setImportSessionReference

public void setImportSessionReference(ObjectReference a_ImportSessionReference)
                               throws WTPropertyVetoException

Sets the value of the attribute: IMPORT_SESSION_REFERENCE.

Supported API: false

Parameters:

a_ImportSessionReference -

Throws:

WTPropertyVetoException

importSessionReferenceValidate

private void importSessionReferenceValidate(ObjectReference a_ImportSessionReference)
                                     throws WTPropertyVetoException

Parameters:

a_ImportSessionReference -

Throws:

WTPropertyVetoException

newElementImportInfo

public static ElementImportInfo newElementImportInfo()
                                              throws WTException

Default factory for the class.

Supported API: false

Returns:

ElementImportInfo

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

update

public void update(String objId,
                   String objDisplayId,
                   String action,
                   String actionParams)
            throws WTPropertyVetoException

Throws:

WTPropertyVetoException