Package com.ptc.core.command.common.bean.entity

Class RetrievePersistentEntityCommand

java.lang.Object

com.ptc.core.command.common.bean.AbstractCommand

com.ptc.core.command.common.bean.AbstractServerCommand

com.ptc.core.command.common.bean.entity.AbstractEntityCommand

com.ptc.core.command.common.bean.entity.AbstractPersistentEntityCommand

com.ptc.core.command.common.bean.entity.RetrievePersistentEntityCommand

All Implemented Interfaces:

Command, com.ptc.core.command.common.ServerCommand, Externalizable, Serializable

public class RetrievePersistentEntityCommand
extends com.ptc.core.command.common.bean.entity.AbstractPersistentEntityCommand
implements Externalizable

This command can be used to refresh the given persistent entity or retrieve one from the database. It takes as input a TypeInstance to the source of the command. It returns as output a TypeInstance that is the result of either a refresh or retrieve.

Supported API: true

Extendable: true

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RetrievePersistentEntityCommand()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	setSource(TypeInstance instance)	Overrides the inherited method to throw UnsupportedOperationException.
void	setSources(TypeInstanceIdentifier[] instanceIds)	Sets the sources [or inputs] of the command to the given TypeInstanceIdentifier[].

Methods inherited from class java.lang.Object

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

Constructor Details

RetrievePersistentEntityCommand

public RetrievePersistentEntityCommand()

Creates a new instance.

Supported API: true

Method Details

setSources

public void setSources(TypeInstanceIdentifier[] instanceIds)

Sets the sources [or inputs] of the command to the given TypeInstanceIdentifier[]. The outcome of this is that the objects represented by the TypeInstanceIdentifier[] are retrieved based upon the filter and returned as aTypeInstance[].

Supported API: true

Parameters:

instanceIds -

setSource

public void setSource(TypeInstance instance)
               throws UnsupportedOperationException

Overrides the inherited method to throw UnsupportedOperationException. Since only a TypeIdentifier makes sense to be given as the input, then nothing else should be allowed.

Supported API: true

Overrides:

setSource in class com.ptc.core.command.common.bean.entity.AbstractEntityCommand

Parameters:

instance -

Throws:

UnsupportedOperationException