Package com.piketec.tpt.api

Interface TestCaseAttribute

All Superinterfaces:

IdentifiableRemote, java.rmi.Remote, TptRemote

public interface TestCaseAttribute
extends IdentifiableRemote

A TestCaseAttribute represents a row in the Test Case Details view. It consists of a name and a type.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TestCaseAttribute.TestCaseAttributeType	Different types of test case attributes.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	STRING_TYPE	Deprecated. Will be removed in TPT-21.

Method Summary

Modifier and Type	Method	Description
TestCaseAttributeOption	createOption(java.lang.String optionName)	Creates an option for this test case attribute.
TestCaseAttribute.TestCaseAttributeType	getAttributeType()	Returns the type of this attribute; it can be either TEXT, CHECKBOX, ENUM_ONE, ENUM_MANY or FILE.
java.lang.String	getName()	Get the name of this TestCaseAttribute
RemoteIndexedList<java.lang.String,TestCaseAttributeOption>	getOptions()	Get the available options for this test case attribute.
java.lang.String	getType()	Deprecated. will be removed in TPT-21.
boolean	isCopyable()	Indicates whether the value of a TestCaseAttribute will be copied with the test case it is assigned to.
void	setAttributeType(TestCaseAttribute.TestCaseAttributeType type)	Sets the type of this attribute.
void	setCopyable(boolean on)	Set a TestCaseAttribute to be "copyable".
void	setName(java.lang.String newName)	Set the name for this TestCaseAttribute

Methods inherited from interface com.piketec.tpt.api.IdentifiableRemote

getIdentifier

Field Detail

STRING_TYPE

@Deprecated
static final java.lang.String STRING_TYPE

Deprecated.

Will be removed in TPT-21.

Type String for String Test Case Attribute

See Also:

Constant Field Values

Method Detail

getType

@Deprecated
java.lang.String getType()
                  throws java.rmi.RemoteException

Deprecated.

will be removed in TPT-21. Use getAttributeType() instead.

Returns the type of this attribute.

Returns:

The type as a String.

Throws:

java.rmi.RemoteException - remote communication problem

getName

java.lang.String getName()
                  throws java.rmi.RemoteException

Get the name of this TestCaseAttribute

Returns:

Returns the name of this TestCaseAttribute

Throws:

java.rmi.RemoteException - remote communication problem

setName

void setName(java.lang.String newName)
      throws ApiException,
             java.rmi.RemoteException

Set the name for this TestCaseAttribute

Parameters:

newName - The new name.

Throws:

ApiException - If newName is null or does already exist.

java.rmi.RemoteException - remote communication problem

isCopyable

boolean isCopyable()
            throws java.rmi.RemoteException

Indicates whether the value of a TestCaseAttribute will be copied with the test case it is assigned to. In the TPT GUI this setting corresponds to the check box in the TestCaseAttribute definition dialog.

Returns:

true, if the TestCaseAttribute will be automatically copied

Throws:

java.rmi.RemoteException - remote communication problem

setCopyable

void setCopyable(boolean on)
          throws java.rmi.RemoteException

Set a TestCaseAttribute to be "copyable". The values of a "copyable" TestCaseAttribute are automatically copied into the new test case, when the corresponding test case is copied or duplicated.

Parameters:

on - true, if TestCaseAttribute should be "copyable".

Throws:

java.rmi.RemoteException - remote communication problem

getAttributeType

TestCaseAttribute.TestCaseAttributeType getAttributeType()
                                                  throws java.rmi.RemoteException

Returns the type of this attribute; it can be either TEXT, CHECKBOX, ENUM_ONE, ENUM_MANY or FILE.

Returns:

The type of the TestCaseAttribute

Throws:

java.rmi.RemoteException - remote communication problem

setAttributeType

void setAttributeType(TestCaseAttribute.TestCaseAttributeType type)
               throws ApiException,
                      java.rmi.RemoteException

Sets the type of this attribute.

Parameters:

type - TestCaseAttributeType.TEXT, TestCaseAttributeType.CHECKBOX, TestCaseAttributeType.ENUM_ONE, TestCaseAttributeType.ENUM_MANY or TestCaseAttributeType.FILE.

Throws:

ApiException - If given type is null

java.rmi.RemoteException - remote communication problem

createOption

TestCaseAttributeOption createOption(java.lang.String optionName)
                              throws java.rmi.RemoteException

Creates an option for this test case attribute. Note that the options are only relevant for test case attriutes of type ENUM_ONE or ENUM_MANY.

Parameters:

optionName - The name of the option to be created

Returns:

The created option

Throws:

java.rmi.RemoteException - remote communication problem

getOptions

RemoteIndexedList<java.lang.String,TestCaseAttributeOption> getOptions()
                                                                      throws java.rmi.RemoteException

Get the available options for this test case attribute. Note that the options are only relevant for test case attriutes of type ENUM_ONE or ENUM_MANY.

Returns:

List of options for this test case attribute.

Throws:

java.rmi.RemoteException - remote communication problem