Package com.ptc.core.command.common

Interface Command

All Superinterfaces:
Externalizable, Serializable
All Known Implementing Classes:
com.ptc.core.command.common.bean.AbstractCommand, com.ptc.core.command.common.bean.entity.AbstractEntityCommand, AbstractGetAttributesCommand, com.ptc.core.command.common.bean.vc.AbstractIterationEntityCommand, AbstractPagingRepositoryCommand, com.ptc.core.command.common.bean.entity.AbstractPersistentEntityCommand, AbstractQueryCommand, AbstractReportQueryCommand, AbstractRepositoryCommand, com.ptc.core.command.common.bean.AbstractServerCommand, AbstractTypeModelCommand, com.ptc.core.command.common.bean.vc.AbstractVaultCommand, AttributeContainerQueryCommand, BasicClosePagingRepositoryCommand, BasicFetchPagingRepositoryCommand, BasicQueryCommand, BasicReportQueryCommand, CheckinToVaultCommand, CheckinToVaultFirstTimeCommand, CheckoutFromVaultCommand, ContainsCommand, CreatePersistentEntityCommand, DeletePersistentEntityCommand, FindPersistentEntityCommand, GetAllClassificationAssociationsCommand, GetAncestorsCommand, GetAttributeChildrenCommand, GetAttributeCommand, GetChildrenCommand, GetClassificationAssociationCommand, GetClassificationChildrenCommand, GetClassificationTemplateCommand, GetClosestInstantiableDescendantsCommand, GetDescendantsCommand, GetFilteredChildrenCommand, GetFilteredDescendantsCommand, GetFilteredInstantiableChildrenCommand, GetFilteredInstantiableDescendantsCommand, GetHardSchemaAttributesCommand, GetInstantiableChildrenCommand, GetInstantiableDescendantsCommand, GetInterfacesCommand, GetParentCommand, GetSchemaAttributesCommand, GetSoftSchemaAttributesCommand, GetTypeIdentifierCommand, IsACommand, NewEntityCommand, NewIterationCommand, NewVersionCommand, PersistedReportQueryCommand, PrepareEntityCommand, RetrievePersistentEntityCommand, ReviseEntityCommand, SavePersistentEntityCommand, SavePersistentEntitySubCommand, SupersedeIterationCommand, UndoCheckoutFromVaultCommand, UpdatePersistentEntityCommand
public interface Command extends Externalizable
Provides the general notion of a command bean. All specialized command beans either directly or indirectly assert that they implement this interface.

The main API of interest on this interface is the execute method. It is the way and only way to execute a command.

It is conceivable to think that in the very near future a Command would establish an AttributeContainer as the input and output. Then specialized commands could either override those inherited specifications with subtypes, or specify unique and perhaps multiple inputs and outputs for a command. It would then be recommended that the specialized inputs and outputs would map to the inherited attribute containers.



Supported API: true

Extendable: false

  • Method Details

    • execute

      Command execute() throws CommandException
      Carries out the execution of this command. This method employs the CommandDelegateFactory to get the appropriate CommandDelegate, and then executes it passing the instance of the Command.

      If for any reason there was erroneous, unrecoverable behavior then an applicable instance of the CommandException is thrown.



      Supported API: true
      Returns:
      Command
      Throws:
      CommandException