|
Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center 11g Release 2 (11.1.2.0.0) E17494-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.alm.connector.data.RowDef oracle.alm.connector.data.WorkItemDef
public class WorkItemDef
The WorkItemDef
class holds meta data of a work item. This is the runtime structure
for the Work item tag used in the connector model or XML definition file.
RowDef
,
WorkItemFieldDef
,
WorkItem
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_TYPE_NAME
default type of a work item definition |
protected java.util.Map<java.lang.String,java.lang.String> |
webReference
|
Fields inherited from class oracle.alm.connector.data.RowDef |
---|
DEFAULT_FETCH_SIZE |
Constructor Summary | |
---|---|
WorkItemDef()
|
Method Summary | |
---|---|
void |
addWebReferenceEntry(java.lang.String name,
java.lang.String anchor)
Adds a web reference entry for a work item field. |
WorkItemDef |
createNew()
Constructs a new instance of WorkItemDef from the current instance. |
CommentDef |
getCommentDef()
Retrieves the work item comment definition. |
java.util.Map<java.lang.String,DataSourceDef> |
getDataSourceDefs()
Retrieves data sources used by the work item. |
java.lang.String |
getIdDef()
Retrieves the Id field used to uniquely identify the work item. |
java.lang.String |
getIDLabel()
Retrieves the display label for a tab on the work item detail editor window as specified by an attribute called "id-label" in the the <connector>def.xml file. |
java.lang.String |
getLabelDef()
Retrieves the display label for the Id field. |
java.lang.String |
getName()
Retrieves the name of work item. |
RepositoryDef |
getRepositoryDef()
Retrieves definition of a parent repository. |
java.lang.String |
getSubjectDef()
Retrieves the field used as subject of the work item. |
java.lang.String |
getSupportSearchByID()
Retrieves a flag to determine if the work item supports "Search by ID" feature. |
java.lang.String |
getSupportWorkItemCreation()
Retrieves a flag to determine if work item creation is supported. |
java.lang.String |
getType()
Retrieves the work item type. |
java.lang.String |
getUrlHandlerClass()
Retrieves the class name used to handle the URL construction for the fields that are configured as web reference. |
java.util.Map<java.lang.String,java.lang.String> |
getWebReferences()
Retrieves the web references used by the work item. |
void |
setCommentDef(CommentDef cDef)
Set the work item comment definition |
void |
setIdDef(java.lang.String idDef)
Sets the Id field used to uniquely identify the work item. |
void |
setIDLabel(java.lang.String sLabel)
Sets the display label for a tab on the work item detail editor window. |
void |
setLabelDef(java.lang.String labelDef)
Sets the display label for the Id field. |
void |
setName(java.lang.String name)
Sets the name of the work item |
void |
setRepositoryDef(RepositoryDef reposDef)
Sets definition of a parent repository. |
void |
setSubjectDef(java.lang.String subjectDef)
Sets the field used as subject of the work item. |
void |
setSupportSearchByID(java.lang.String supportSearchByID)
Sets a flag indicating if the work item supports "Search by ID" feature. |
void |
setSupportWorkItemCreation(java.lang.String supportWorkItemCreation)
Sets a flag indicating if a work item creation is supported. |
void |
setType(java.lang.String type)
Sets the work item type. |
void |
setUrlHandlerClass(java.lang.String urlhandler)
Sets the class name used to handle the URL construction for the fields that are configured as web reference. |
Methods inherited from class oracle.alm.connector.data.RowDef |
---|
getDataSource, getFieldDefs, getLovDefs, setDataSource |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_TYPE_NAME
protected java.util.Map<java.lang.String,java.lang.String> webReference
Constructor Detail |
---|
public WorkItemDef()
Method Detail |
---|
public void setName(java.lang.String name)
name
- work item namepublic java.lang.String getName()
public void setIdDef(java.lang.String idDef)
idDef
- the Id to setpublic java.lang.String getIdDef()
public void setLabelDef(java.lang.String labelDef)
labelDef
- the display label to usepublic java.lang.String getLabelDef()
public void setSubjectDef(java.lang.String subjectDef)
subjectDef
- the field to use as the work item subjectpublic java.lang.String getSubjectDef()
public void setType(java.lang.String type)
type
- the type of the work item.public java.lang.String getType()
public void setCommentDef(CommentDef cDef)
cDef
- work item comment definition.public CommentDef getCommentDef()
public void setUrlHandlerClass(java.lang.String urlhandler)
urlhandler
- name of the class that handles the URL constructionpublic java.lang.String getUrlHandlerClass()
public void addWebReferenceEntry(java.lang.String name, java.lang.String anchor)
name
- name of the work item fieldanchor
- the anchor on which the web reference will act on. Valid values are "value", 'label", and "icon"public java.util.Map<java.lang.String,java.lang.String> getWebReferences()
public java.util.Map<java.lang.String,DataSourceDef> getDataSourceDefs()
public RepositoryDef getRepositoryDef()
public void setRepositoryDef(RepositoryDef reposDef)
reposDef
- RepositoryDef object which may contain other work itemspublic void setSupportSearchByID(java.lang.String supportSearchByID)
supportSearchByID
- set to true if the work item supports the feature.public java.lang.String getSupportSearchByID()
public void setSupportWorkItemCreation(java.lang.String supportWorkItemCreation)
supportWorkItemCreation
- set to true if the work item creation is supported.public java.lang.String getSupportWorkItemCreation()
public void setIDLabel(java.lang.String sLabel)
sLabel
- the text to display on the tab of the work item detail editor windowpublic java.lang.String getIDLabel()
public WorkItemDef createNew()
|
Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center 11g Release 2 (11.1.2.0.0) E17494-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |