Package com.ptc.core.foundation.vc.wip.common

Class CheckoutFromVaultCommand

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.vc.AbstractIterationEntityCommand
com.ptc.core.command.common.bean.vc.AbstractVaultCommand
com.ptc.core.foundation.vc.wip.common.CheckoutFromVaultCommand
All Implemented Interfaces:
Command, com.ptc.core.command.common.ServerCommand, Externalizable, Serializable
public class CheckoutFromVaultCommand extends com.ptc.core.command.common.bean.vc.AbstractVaultCommand implements Externalizable


Supported API: true

Extendable: true
See Also:

  • Field Summary

    Fields inherited from class com.ptc.core.command.common.bean.AbstractServerCommand

    SERVER

    Fields inherited from interface com.ptc.core.command.common.Command

    FEEDBACK_SPEC, LOCALE

    Fields inherited from interface com.ptc.core.command.common.ServerCommand

    COMMAND_CONTEXT, CONTAINER_IDENTIFIER, FILTER

  • Constructor Summary

    Constructors
    Constructor
    Description
    CheckoutFromVaultCommand()
    Creates a new instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    TypeInstance
    getCheckoutFolder()
    Gets the value of the attribute: checkoutFolder; The folder in which to place the checked out working copy.
    TypeInstance
    getReservedCopy()
    Gets the value of the attribute: reservedCopy; The reserved [or checked-out thus locked] copy of the entity.
    TypeInstance
    getWorkingCopy()
    Gets the value of the attribute: workingCopy; The working [or new iteration] copy of the reserved entity to perform work against.
    void
    setCheckoutFolder(TypeInstance a_CheckoutFolder)
    Sets the value of the attribute: checkoutFolder; The folder in which to place the checked out working copy.
    void
    setReservedCopy(TypeInstance a_ReservedCopy)
    Sets the value of the attribute: reservedCopy; The reserved [or checked-out thus locked] copy of the entity.
    void
    setWorkingCopy(TypeInstance a_WorkingCopy)
    Sets the value of the attribute: workingCopy; The working [or new iteration] copy of the reserved entity to perform work against.

    Methods inherited from class com.ptc.core.command.common.bean.vc.AbstractVaultCommand

    getComment, getPrincipalName, readVersion, setComment, setPrincipalName

    Methods inherited from class com.ptc.core.command.common.bean.vc.AbstractIterationEntityCommand

    getTargetId, readVersion, setTargetId

    Methods inherited from class com.ptc.core.command.common.bean.entity.AbstractPersistentEntityCommand

    readVersion

    Methods inherited from class com.ptc.core.command.common.bean.entity.AbstractEntityCommand

    getRequestor, getResult, getSource, readVersion, setResult, setSource, setSource, setSource

    Methods inherited from class com.ptc.core.command.common.bean.AbstractServerCommand

    execute, getCommandContext, getContainerIdentifier, getFilter, isExecutable, putOnCommandContext, readVersion, setCommandContext, setContainerIdentifier, setFilter

    Methods inherited from class com.ptc.core.command.common.bean.AbstractCommand

    getFeedbackSpec, getLocale, getSelectorTypename, getTargetLanguage, readVersion, setFeedbackSpec, setLocale, setTargetLanguage

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.ptc.core.command.common.Command

    getFeedbackSpec, getLocale, getSelectorTypename, getTargetLanguage, setFeedbackSpec, setLocale, setTargetLanguage

  • Constructor Details

    • CheckoutFromVaultCommand

      public CheckoutFromVaultCommand()
      Creates a new instance.

      Supported API: true

  • Method Details

    • getWorkingCopy

      public TypeInstance getWorkingCopy()
      Gets the value of the attribute: workingCopy; The working [or new iteration] copy of the reserved entity to perform work against. This is derived from the inherited result.

      Supported API: true
      Returns:
      TypeInstance

    • setWorkingCopy

      public void setWorkingCopy(TypeInstance a_WorkingCopy) throws WTPropertyVetoException
      Sets the value of the attribute: workingCopy; The working [or new iteration] copy of the reserved entity to perform work against. This is derived from the inherited result.

      Supported API: true
      Parameters:
      a_WorkingCopy -
      Throws:
      WTPropertyVetoException

    • getReservedCopy

      public TypeInstance getReservedCopy()
      Gets the value of the attribute: reservedCopy; The reserved [or checked-out thus locked] copy of the entity.

      Supported API: true
      Returns:
      TypeInstance

    • setReservedCopy

      public void setReservedCopy(TypeInstance a_ReservedCopy) throws WTPropertyVetoException
      Sets the value of the attribute: reservedCopy; The reserved [or checked-out thus locked] copy of the entity.

      Supported API: true
      Parameters:
      a_ReservedCopy -
      Throws:
      WTPropertyVetoException

    • getCheckoutFolder

      public TypeInstance getCheckoutFolder()
      Gets the value of the attribute: checkoutFolder; The folder in which to place the checked out working copy.

      Supported API: true
      Returns:
      TypeInstance

    • setCheckoutFolder

      public void setCheckoutFolder(TypeInstance a_CheckoutFolder) throws WTPropertyVetoException
      Sets the value of the attribute: checkoutFolder; The folder in which to place the checked out working copy.

      Supported API: true
      Parameters:
      a_CheckoutFolder -
      Throws:
      WTPropertyVetoException