Class System.TMWInstance 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class System.TMWInstance 

java.lang.Object
   |
   +----System.TMWInstance
public class TMWInstance
extends Object
Performs manipulations of Teamware objects at the Instance level. Instances are Specifications with certain fields filled in with default data. Instances inherit their behaviors from the parent Category and field data from the Specifications. Instances usually are created by the Teamware Interpreter.
See Also:
TMWFoundation, TMWTypes, TMWCategory, TMWSpecification, TMWValue

Variable Index

o ClassInstance
o Families
o Multi
o Shared
o Single

Constructor Index

o TMWInstance()

Method Index

o AddValueToMultiField(Integer, String, String)
Add a value to a multple element field.
o AssignMultiField(Integer, String, Vector)
Assign the values of a multiple element field.
o AssignSharedFieldValue(Integer, String, String)
Assign a single value to a field shared across a category.
o AssignSingleFieldValue(Integer, String, String)
Assign a value to a single value field.
o CreateInstance(Integer)
Create a new activity Instance based on a Specification.
o GetMultiFieldNames(Integer)
Get the names of all the multiple fields in an instance.
o GetMultiFieldValues(Integer, String)
Get a value from a multiple element field.
o RetrieveFieldFamilyValues(Integer, String)
Retrieve a list of all values across a family.
o RetrieveSharedFieldValue(Integer, String)
Retrieve a single value from a field shared across a category.
o RetrieveSingleFieldValue(Integer, String)
Retrieve a value from a single value field.
o SendEvent(Integer, String, Vector)
Send an event to an instance not requiring a return value.
o SendRequest(Integer, String, Vector)
Send a request for a value to an object.
o SendRequest(Integer, String, Vector, String)
Send a request for a list of values to an object.

Variables

o Shared 
  public static String Shared
o Single 
  public static String Single
o Multi 
  public static String Multi
o Families 
  public static String Families
o ClassInstance 
  public final static String ClassInstance

Constructors

o TMWInstance 
  public TMWInstance()

Methods

o CreateInstance 
  public static Integer CreateInstance(Integer SpecId)
Create a new activity Instance based on a Specification.
Parameters:
SpecId - is the id of the Specification to base the Instance on.
Returns:
s the id of the new instance.
o GetMultiFieldValues 
  public static Vector GetMultiFieldValues(Integer Inst,
                                           String FieldName)
Get a value from a multiple element field.
Parameters:
Inst - is the id of the object.
FieldName - is the name of the field.
o GetMultiFieldNames 
  public static Vector GetMultiFieldNames(Integer Inst)
Get the names of all the multiple fields in an instance.
Parameters:
Inst - is the id of the object.
o AssignMultiField 
  public static void AssignMultiField(Integer Inst,
                                      String FieldName,
                                      Vector FieldValue)
Assign the values of a multiple element field.
Parameters:
Inst - is the id of the object.
FieldName - is the name of the field to set.
FieldValue - is the list of values to assign to the field.
o AddValueToMultiField 
  public static void AddValueToMultiField(Integer Inst,
                                          String FieldName,
                                          String FieldValue)
Add a value to a multple element field.
Parameters:
Inst - is the id of the object.
FieldName - is the name of the field to set.
FieldValue - is the value to add.
o RetrieveSingleFieldValue 
  public static String RetrieveSingleFieldValue(Integer Inst,
                                                String FieldName)
Retrieve a value from a single value field.
Parameters:
Inst - is the id of the object.
FieldName - is the name of the field to set.
Returns:
s a single value.
o AssignSingleFieldValue 
  public static void AssignSingleFieldValue(Integer Inst,
                                            String FieldName,
                                            String FieldValue)
Assign a value to a single value field.
Parameters:
Inst - is the id of the object.
FieldName - is the name of the field to set.
FieldValue - is the value to assign.
o RetrieveSharedFieldValue 
  public static String RetrieveSharedFieldValue(Integer Inst,
                                                String FieldName)
Retrieve a single value from a field shared across a category.
Parameters:
Inst - is the id of the object.
FieldName - is the name of the field to set.
Returns:
s a shared, single value.
o AssignSharedFieldValue 
  public static void AssignSharedFieldValue(Integer Inst,
                                            String FieldName,
                                            String FieldValue)
Assign a single value to a field shared across a category.
Parameters:
Inst - is the id of the object.
FieldName - is the name of the field to set.
FieldValue - is the value to assign.
o RetrieveFieldFamilyValues 
  public static Vector RetrieveFieldFamilyValues(Integer Inst,
                                                 String FieldFamily)
Retrieve a list of all values across a family.
Parameters:
Inst - is the id of the object.
FieldFamily - is the name of the family of fields.
Returns:
s a listing of all the values, for each field that is listed in the family.
o SendEvent 
  public static void SendEvent(Integer Inst,
                               String EventName,
                               Vector Parameters)
Send an event to an instance not requiring a return value.
Parameters:
Inst - is the object id.
EventName - is the name of the event.
Parameters - are the values to send to the object.
o SendRequest 
  public static String SendRequest(Integer Inst,
                                   String EventName,
                                   Vector Parameters)
Send a request for a value to an object.
Parameters:
Inst - is the object id.
EventName - is the name of the event.
Parameters - are the values to send to the object.
Returns:
s the requested value from the object after executing the event.
o SendRequest 
  public static Vector SendRequest(Integer Inst,
                                   String EventName,
                                   Vector Parameters,
                                   String IsList)
Send a request for a list of values to an object.
Parameters:
Inst - is the object id.
EventName - is the name of the event.
Parameters - are the values to send to the object.
Returns:
s the requested list of values after executing the event. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index