Package com.ptc.core.components.forms

Class DynamicRefreshInfo

java.lang.Object

com.ptc.core.components.forms.DynamicRefreshInfo

All Implemented Interfaces:

Serializable

public class DynamicRefreshInfo
extends Object
implements Serializable

Contains the information needed to dynamically refresh a portion of the parent window after a form has been processed.

Supported API: true

Extendable: false

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DynamicRefreshInfo.Action	Enumeration of all the possible action values for the DynamicRefreshInfo object.

Constructor Summary

Constructors

Constructor	Description
DynamicRefreshInfo()	Supported API: true
DynamicRefreshInfo(NmOid oid, NmOid locationOid, DynamicRefreshInfo.Action action)	Used to specify which rows in the table/tree need to be created/updated/deleted.
DynamicRefreshInfo(Persistable obj, Persistable locationObj, DynamicRefreshInfo.Action action)	Constructor that takes persistables instead of oids.

Method Summary

Modifier and Type	Method	Description
DynamicRefreshInfo.Action	getActionEnum()	Supported API: true
NmOid	getLocation()	Supported API: true
NmOid	getOid()	Supported API: true
void	setAction(DynamicRefreshInfo.Action action)	Set the action to the correct value from the enum of possible values.
void	setLocation(NmOid oid)	Supported API: true
void	setOid(NmOid oid)	Supported API: true
String	toString()	Supported API: true

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

DynamicRefreshInfo

public DynamicRefreshInfo()

Supported API: true

DynamicRefreshInfo

public DynamicRefreshInfo(NmOid oid,
 NmOid locationOid,
 DynamicRefreshInfo.Action action)

Used to specify which rows in the table/tree need to be created/updated/deleted. If the oid and parent oid are not enough to uniquely identify the row to create/update/delete (this may happen for trees that have multiple rows with the same oid) then then a DynamicNmContextRefreshInfo must be used instead of this class to supply the full context.

Parameters:

oid - - the oid that was just created/updated/deleted. (the new oid in the case of update)

locationOid - - the oid of the parent location where the object was just created/deleted in a tree, or the oid of the original in the case of update, or just null otherwise

action - - one of the available constants in the Action Enumeration

Supported API: true

DynamicRefreshInfo

public DynamicRefreshInfo(Persistable obj,
 Persistable locationObj,
 DynamicRefreshInfo.Action action)

Constructor that takes persistables instead of oids.

See Also:

• 

Supported API: true


Method Details

setOid

public void setOid(NmOid oid)

Supported API: true

Parameters:

oid -

getOid

public NmOid getOid()

Supported API: true

Returns:

setLocation

public void setLocation(NmOid oid)

Supported API: true

Parameters:

oid -

getLocation

public NmOid getLocation()

Supported API: true

Returns:

setAction

public void setAction(DynamicRefreshInfo.Action action)

Set the action to the correct value from the enum of possible values.

Parameters:

action - One of the Entries in the Action enum, UPDATE, ADD, DELETE

Supported API: true

getActionEnum

public DynamicRefreshInfo.Action getActionEnum()

Supported API: true

Returns:

toString

public String toString()

Supported API: true

Overrides:

toString in class Object