step.repository.alm.otaclient

Interface IReqFactory

All Superinterfaces:

com4j.Com4jObject, IBaseFactory, IBaseFactoryEx

All Known Subinterfaces:

IReqFactory2, IReqFactory3, IReqFactory4

public interface IReqFactory
extends IBaseFactoryEx

Services for managing requirements.

Method Summary

Modifier and Type	Method and Description
com4j.Com4jObject	buildPerfGraph(String groupByField, String sumOfField, int maxCols, Object filter, Object frDate, boolean forceRefresh, boolean showFullPath) Builds Performance Graph.
com4j.Com4jObject	buildPerfGraphEx(String groupByField, String sumOfField, int maxCols, Object filter, Object frDate, boolean forceRefresh, boolean showFullPath, boolean showNullParents) Builds Performance Graph.
com4j.Com4jObject	buildProgressGraph(String groupByField, String sumOfField, boolean byHistory, int majorSkip, int minorSkip, int maxCols, Object filter, Object frDate, boolean forceRefresh, boolean showFullPath) Builds Req progress graph.
com4j.Com4jObject	buildProgressGraphEx(String groupByField, String sumOfField, boolean byHistory, int majorSkip, int minorSkip, int maxCols, Object filter, Object frDate, boolean forceRefresh, boolean showFullPath, boolean showNullParents) Builds Requirement progress graph.
com4j.Com4jObject	buildSummaryGraph(String xAxisField, String groupByField, String sumOfField, int maxCols, Object filter, boolean forceRefresh, boolean showFullPath) Builds Req summary graph.
com4j.Com4jObject	buildSummaryGraphEx(String xAxisField, String groupByField, String sumOfField, int maxCols, Object filter, boolean forceRefresh, boolean showFullPath, boolean showNullParents) Builds Req summary graph.
com4j.Com4jObject	buildTrendGraph(String groupByField, String sumOfField, int maxCols, Object filter, Object frDate, boolean forceRefresh, boolean showFullPath) Creates graph that shows the number of defect status changes over time.
com4j.Com4jObject	buildTrendGraphEx(String groupByField, String sumOfField, int maxCols, Object filter, Object frDate, boolean forceRefresh, boolean showFullPath, boolean showNullParents) Creates graph that shows the number of defect status changes over time.
IList	find(int startRootID, String fieldName, String pattern, int mode, int limit) Gets a list of requirements containing the Pattern value in specified field.
IList	getChildrenList(int fatherID) Gets list of child requirements.

Methods inherited from interface step.repository.alm.otaclient.IBaseFactoryEx

mail

Methods inherited from interface step.repository.alm.otaclient.IBaseFactory

addItem, fetchLevel, fetchLevel, fields, fields, filter, history, item, newList, removeItem

Methods inherited from interface com4j.Com4jObject

advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

Method Detail

getChildrenList

IList getChildrenList(int fatherID)

Gets list of child requirements.

Parameters:

fatherID - Mandatory int parameter.

Returns:

Returns a value of type otaclient.IList

find

IList find(int startRootID,
           String fieldName,
           String pattern,
           @DefaultValue(value="0")
           int mode,
           @DefaultValue(value="100")
           int limit)

Gets a list of requirements containing the Pattern value in specified field.

Parameters:

startRootID - Mandatory int parameter.

fieldName - Mandatory java.lang.String parameter.

pattern - Mandatory java.lang.String parameter.

mode - Optional parameter. Default value is 0

limit - Optional parameter. Default value is 100

Returns:

Returns a value of type otaclient.IList

buildSummaryGraph

com4j.Com4jObject buildSummaryGraph(@DefaultValue(value="")
                                    String xAxisField,
                                    @DefaultValue(value="")
                                    String groupByField,
                                    @DefaultValue(value="")
                                    String sumOfField,
                                    @DefaultValue(value="0")
                                    int maxCols,
                                    Object filter,
                                    @DefaultValue(value="0")
                                    boolean forceRefresh,
                                    @DefaultValue(value="0")
                                    boolean showFullPath)

Builds Req summary graph.

Parameters:

xAxisField - Optional parameter. Default value is ""

groupByField - Optional parameter. Default value is ""

sumOfField - Optional parameter. Default value is ""

maxCols - Optional parameter. Default value is 0

filter - Optional parameter. Default value is com4j.Variant.getMissing()

forceRefresh - Optional parameter. Default value is false

showFullPath - Optional parameter. Default value is false

Returns:

Returns a value of type com4j.Com4jObject

buildProgressGraph

com4j.Com4jObject buildProgressGraph(@DefaultValue(value="")
                                     String groupByField,
                                     @DefaultValue(value="")
                                     String sumOfField,
                                     @DefaultValue(value="-1")
                                     boolean byHistory,
                                     @DefaultValue(value="0")
                                     int majorSkip,
                                     @DefaultValue(value="1")
                                     int minorSkip,
                                     @DefaultValue(value="0")
                                     int maxCols,
                                     Object filter,
                                     Object frDate,
                                     @DefaultValue(value="0")
                                     boolean forceRefresh,
                                     @DefaultValue(value="0")
                                     boolean showFullPath)

Builds Req progress graph.

Parameters:

groupByField - Optional parameter. Default value is ""

sumOfField - Optional parameter. Default value is ""

byHistory - Optional parameter. Default value is false

majorSkip - Optional parameter. Default value is 0

minorSkip - Optional parameter. Default value is 1

maxCols - Optional parameter. Default value is 0

filter - Optional parameter. Default value is com4j.Variant.getMissing()

frDate - Optional parameter. Default value is com4j.Variant.getMissing()

forceRefresh - Optional parameter. Default value is false

showFullPath - Optional parameter. Default value is false

Returns:

Returns a value of type com4j.Com4jObject

buildTrendGraph

com4j.Com4jObject buildTrendGraph(@DefaultValue(value="")
                                  String groupByField,
                                  @DefaultValue(value="")
                                  String sumOfField,
                                  @DefaultValue(value="0")
                                  int maxCols,
                                  Object filter,
                                  Object frDate,
                                  @DefaultValue(value="0")
                                  boolean forceRefresh,
                                  @DefaultValue(value="0")
                                  boolean showFullPath)

Creates graph that shows the number of defect status changes over time.

Parameters:

groupByField - Optional parameter. Default value is ""

sumOfField - Optional parameter. Default value is ""

maxCols - Optional parameter. Default value is 0

filter - Optional parameter. Default value is com4j.Variant.getMissing()

frDate - Optional parameter. Default value is com4j.Variant.getMissing()

forceRefresh - Optional parameter. Default value is false

showFullPath - Optional parameter. Default value is false

Returns:

Returns a value of type com4j.Com4jObject

buildPerfGraph

com4j.Com4jObject buildPerfGraph(@DefaultValue(value="")
                                 String groupByField,
                                 @DefaultValue(value="")
                                 String sumOfField,
                                 @DefaultValue(value="0")
                                 int maxCols,
                                 Object filter,
                                 Object frDate,
                                 @DefaultValue(value="0")
                                 boolean forceRefresh,
                                 @DefaultValue(value="0")
                                 boolean showFullPath)

Builds Performance Graph.

Parameters:

groupByField - Optional parameter. Default value is ""

sumOfField - Optional parameter. Default value is ""

maxCols - Optional parameter. Default value is 0

filter - Optional parameter. Default value is com4j.Variant.getMissing()

frDate - Optional parameter. Default value is com4j.Variant.getMissing()

forceRefresh - Optional parameter. Default value is false

showFullPath - Optional parameter. Default value is false

Returns:

Returns a value of type com4j.Com4jObject

buildSummaryGraphEx

com4j.Com4jObject buildSummaryGraphEx(@DefaultValue(value="")
                                      String xAxisField,
                                      @DefaultValue(value="")
                                      String groupByField,
                                      @DefaultValue(value="")
                                      String sumOfField,
                                      @DefaultValue(value="0")
                                      int maxCols,
                                      Object filter,
                                      @DefaultValue(value="0")
                                      boolean forceRefresh,
                                      @DefaultValue(value="0")
                                      boolean showFullPath,
                                      @DefaultValue(value="0")
                                      boolean showNullParents)

Builds Req summary graph. Extends BuildSummaryGraph with ability to display Null parent folders.

Parameters:

xAxisField - Optional parameter. Default value is ""

groupByField - Optional parameter. Default value is ""

sumOfField - Optional parameter. Default value is ""

maxCols - Optional parameter. Default value is 0

filter - Optional parameter. Default value is com4j.Variant.getMissing()

forceRefresh - Optional parameter. Default value is false

showFullPath - Optional parameter. Default value is false

showNullParents - Optional parameter. Default value is false

Returns:

Returns a value of type com4j.Com4jObject

buildProgressGraphEx

com4j.Com4jObject buildProgressGraphEx(@DefaultValue(value="")
                                       String groupByField,
                                       @DefaultValue(value="")
                                       String sumOfField,
                                       @DefaultValue(value="-1")
                                       boolean byHistory,
                                       @DefaultValue(value="0")
                                       int majorSkip,
                                       @DefaultValue(value="1")
                                       int minorSkip,
                                       @DefaultValue(value="0")
                                       int maxCols,
                                       Object filter,
                                       Object frDate,
                                       @DefaultValue(value="0")
                                       boolean forceRefresh,
                                       @DefaultValue(value="0")
                                       boolean showFullPath,
                                       @DefaultValue(value="0")
                                       boolean showNullParents)

Builds Requirement progress graph. Extends BuildProgressGraph with ability to display Null parent folders.

Parameters:

groupByField - Optional parameter. Default value is ""

sumOfField - Optional parameter. Default value is ""

byHistory - Optional parameter. Default value is false

majorSkip - Optional parameter. Default value is 0

minorSkip - Optional parameter. Default value is 1

maxCols - Optional parameter. Default value is 0

filter - Optional parameter. Default value is com4j.Variant.getMissing()

frDate - Optional parameter. Default value is com4j.Variant.getMissing()

forceRefresh - Optional parameter. Default value is false

showFullPath - Optional parameter. Default value is false

showNullParents - Optional parameter. Default value is false

Returns:

Returns a value of type com4j.Com4jObject

buildTrendGraphEx

com4j.Com4jObject buildTrendGraphEx(@DefaultValue(value="")
                                    String groupByField,
                                    @DefaultValue(value="")
                                    String sumOfField,
                                    @DefaultValue(value="0")
                                    int maxCols,
                                    Object filter,
                                    Object frDate,
                                    @DefaultValue(value="0")
                                    boolean forceRefresh,
                                    @DefaultValue(value="0")
                                    boolean showFullPath,
                                    @DefaultValue(value="0")
                                    boolean showNullParents)

Creates graph that shows the number of defect status changes over time.

Parameters:

groupByField - Optional parameter. Default value is ""

sumOfField - Optional parameter. Default value is ""

maxCols - Optional parameter. Default value is 0

filter - Optional parameter. Default value is com4j.Variant.getMissing()

frDate - Optional parameter. Default value is com4j.Variant.getMissing()

forceRefresh - Optional parameter. Default value is false

showFullPath - Optional parameter. Default value is false

showNullParents - Optional parameter. Default value is false

Returns:

Returns a value of type com4j.Com4jObject

buildPerfGraphEx

com4j.Com4jObject buildPerfGraphEx(@DefaultValue(value="")
                                   String groupByField,
                                   @DefaultValue(value="")
                                   String sumOfField,
                                   @DefaultValue(value="0")
                                   int maxCols,
                                   Object filter,
                                   Object frDate,
                                   @DefaultValue(value="0")
                                   boolean forceRefresh,
                                   @DefaultValue(value="0")
                                   boolean showFullPath,
                                   @DefaultValue(value="0")
                                   boolean showNullParents)

Builds Performance Graph.

Parameters:

groupByField - Optional parameter. Default value is ""

sumOfField - Optional parameter. Default value is ""

maxCols - Optional parameter. Default value is 0

filter - Optional parameter. Default value is com4j.Variant.getMissing()

frDate - Optional parameter. Default value is com4j.Variant.getMissing()

forceRefresh - Optional parameter. Default value is false

showFullPath - Optional parameter. Default value is false

showNullParents - Optional parameter. Default value is false

Returns:

Returns a value of type com4j.Com4jObject