com.ptc.windchill.enterprise.object.commands
Class DeleteObjectCommands

java.lang.Object
  com.ptc.windchill.enterprise.object.commands.DeleteObjectCommands

All Implemented Interfaces:

Serializable, RemoteAccess

public class DeleteObjectCommands
extends Object
implements RemoteAccess, Serializable

Delete Class used to delete objects from the object info page or a object in a table and then either refresh or redirect the page. If an error occurs event console will be launched.

Supported API: true

Extendable: true

See Also:

Serialized Form

Constructor Summary

DeleteObjectCommands()
Defaul Constructor

Supported API: true

Method Summary

FormResult	_delete(NmCommandBean cb) Will delete the selected object and return a FormResult for the next action either a page refresh, the object previsous revision or redirect to container info page of the object delete.
static FormResult	delete(NmCommandBean cb) Will delete the selected object and return a FormResult for the next action either a page refresh, the object previsous version or redirect to container info page of the object delete.
protected NmOid	getActionOid() Will return the NmOid of the object getting deleted.
protected NmOid	getContainerOid() Will return the container NmOid of the object getting deleted.
protected String	getFolderPageOfContainer() Will return the url for the folder page of the Container.
protected String	getNmOidInfoPage(NmOid oid) Will return the url for the info page of the NmOid that is passed in.
protected void	setActionOid(NmCommandBean cb) Will set the NmOid of the object getting deleted.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteObjectCommands

public DeleteObjectCommands()

Defaul Constructor

Supported API: true

Method Detail

delete

public static FormResult delete(NmCommandBean cb)
                         throws WTException

Will delete the selected object and return a FormResult for the next action either a page refresh, the object previsous version or redirect to container info page of the object delete.

Supported API: true

Parameters:

cb - The command bean for the current client

Returns:

The form result for the next action.

Throws:

WTException

_delete

public FormResult _delete(NmCommandBean cb)
                   throws WTException

Will delete the selected object and return a FormResult for the next action either a page refresh, the object previsous revision or redirect to container info page of the object delete.

Supported API: true

Parameters:

cb - The command bean for the current client

Returns:

The form result for the next action.

Throws:

WTException

getActionOid

protected NmOid getActionOid()
                      throws WTException

Will return the NmOid of the object getting deleted.

Supported API: true

Returns:

The nmoid of the object.

Throws:

WTException

setActionOid

protected void setActionOid(NmCommandBean cb)
                     throws WTException

Will set the NmOid of the object getting deleted.

Supported API: true

Parameters:

The - client data.

Throws:

WTException

getContainerOid

protected NmOid getContainerOid()
                         throws WTException

Will return the container NmOid of the object getting deleted.

Supported API: true

Returns:

The nmoid of the container oid.

Throws:

WTException

getNmOidInfoPage

protected String getNmOidInfoPage(NmOid oid)
                           throws WTException

Will return the url for the info page of the NmOid that is passed in.

Supported API: true

Parameters:

oid - The NmOid of the next action.

Returns:

The url of the info page of the oid.

Throws:

WTException

getFolderPageOfContainer

protected String getFolderPageOfContainer()
                                   throws WTException

Will return the url for the folder page of the Container.

Supported API: true

Returns:

The url of the info page of the oid.

Throws:

WTException