com.ptc.core.command.common.bean.entity
Class NewEntityCommand

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.NewEntityCommand

All Implemented Interfaces:

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

public class NewEntityCommand
extends com.ptc.core.command.common.bean.entity.AbstractEntityCommand
implements Externalizable

This command can be used to make a new in-memory instance of either a transient or persistent entity (i.e., object). It takes as input a TypeIdentifier playing the role of the requestor of the command. It returns as output an AttributeContainer inherited as the result.

Supported API: true

Extendable: true

See Also:

Serialized Form

Constructor Summary

NewEntityCommand()
Creates a new instance.

Method Summary

TypeIdentifier	getIdentifier() Gets the value of the attribute: identifier; The input TypeIdentifier.
TypeInstance	getSource() Overrides the inherited method to throw UnsupportedOperationException.
void	setIdentifier(TypeIdentifier a_Identifier) Sets the value of the attribute: identifier; The input TypeIdentifier.
void	setSource(TypeInstance instance) Overrides the inherited method to throw UnsupportedOperationException.
void	setSource(TypeInstanceIdentifier instanceId) Overrides inherited method to throw UnsupportedOperationException.
void	setSource(TypeInstanceIdentifier instanceId, AttributeContainer instanceData) Overrides 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 Detail

NewEntityCommand

public NewEntityCommand()

Creates a new instance.

Supported API: true

Method Detail

getIdentifier

public TypeIdentifier getIdentifier()

Gets the value of the attribute: identifier; The input TypeIdentifier.

Supported API: true

Returns:

TypeIdentifier

setIdentifier

public void setIdentifier(TypeIdentifier a_Identifier)
                   throws WTPropertyVetoException

Sets the value of the attribute: identifier; The input TypeIdentifier.

Supported API: true

Parameters:

a_Identifier -

Throws:

WTPropertyVetoException

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

getSource

public TypeInstance getSource()
                       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:

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

Returns:

TypeInstance

Throws:

UnsupportedOperationException

setSource

public void setSource(TypeInstanceIdentifier instanceId)
               throws UnsupportedOperationException

Overrides 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:

instanceId -

Throws:

UnsupportedOperationException

setSource

public void setSource(TypeInstanceIdentifier instanceId,
                      AttributeContainer instanceData)
               throws UnsupportedOperationException

Overrides 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:

instanceId -

instanceData -

Throws:

UnsupportedOperationException

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 prepared based upon the filter and returned as aTypeInstance[].

Supported API: true

Parameters:

instanceIds -