|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.buildforge.services.client.dbo.Adaptor
public class Adaptor
An object representing an adaptor within the Build Forge system. Adaptors consist of XML documents that specify the integration behavior between Build Forge and other systems, such as Source Control Management (SCM) software like Rational ClearCase or defect tracking software like Rational ClearQuest.
Constructor Summary | |
---|---|
Adaptor(APIClientConnection conn)
Define a new adaptor object. |
Method Summary | |
---|---|
Adaptor |
create()
Creates a new adaptor as defined by this object. |
void |
delete()
Deletes this adaptor from the system. |
static void |
deleteById(APIClientConnection conn,
java.lang.String interfaceId)
Deletes the adaptor with the specified name from the system. |
static java.util.List<Adaptor> |
findAll(APIClientConnection conn)
Finds all adaptors defined within the system to which the user has access. |
static Adaptor |
findById(APIClientConnection conn,
java.lang.String adaptorName)
Finds the adaptor with the specified name. |
java.lang.String |
getAdaptorName()
Returns the descriptive name of this adaptor. |
java.lang.String |
getDataText()
Returns the XML document that describes the logic flow of this adaptor. |
int |
getLevel()
Returns the access level assigned to this interface. |
int |
getLineId()
|
java.lang.String |
getTemplate()
|
InterfaceDBO.Type |
getType()
|
static java.util.List<java.lang.String> |
listTemplateIds(APIClientConnection conn)
Finds all adaptor templates that are installed in the system. |
void |
setAdaptorName(java.lang.String adaptorName)
|
void |
setDataText(java.lang.String dataText)
|
void |
setLevel(int level)
|
void |
setTemplate(java.lang.String template)
Sets the template identifier for this Interface. |
void |
setType(InterfaceDBO.Type type)
|
java.lang.String |
toString()
|
Adaptor |
update()
Updates this existing adaptor to use the modified values in this object. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Adaptor(APIClientConnection conn)
create()
method.
conn
- the services layer connection that the adaptor
object should use when submitting requestsMethod Detail |
---|
public static java.util.List<Adaptor> findAll(APIClientConnection conn) throws java.io.IOException, ServiceException
access group
.
conn
- the API client connection to use for the request
java.io.IOException
- if an I/O error occurs
ServiceException
- if the request failspublic static Adaptor findById(APIClientConnection conn, java.lang.String adaptorName) throws java.io.IOException, ServiceException
conn
- the API client connection to use for the requestadaptorName
- the name of the adaptor to find
access group
.
java.io.IOException
- if an I/O error occurs
ServiceException
- if the request failspublic static java.util.List<java.lang.String> listTemplateIds(APIClientConnection conn) throws java.io.IOException, ServiceException
conn
- the API client connection to use for the request
java.io.IOException
- if an I/O error occurs
ServiceException
- if the request failspublic Adaptor create() throws java.io.IOException, ServiceException
Restrictions: Requires Permission.AddInterface
and direct
or indirect membership in the access group
.
The adaptor name
must be unique.
java.io.IOException
- if an I/O error occurs
ServiceException
- if the request failspublic Adaptor update() throws java.io.IOException, ServiceException
Restrictions: Requires Permission.EditInterface
and direct
or indirect membership in the access group
.
The adaptor name
must be unique.
java.io.IOException
- if an I/O error occurs
ServiceException
- if the request failspublic void delete() throws java.io.IOException, ServiceException
Restrictions: Requires Permission.DeleteInterface
.
The adaptor may not be referenced by any existing
AdaptorLink
.
java.io.IOException
ServiceException
public static void deleteById(APIClientConnection conn, java.lang.String interfaceId) throws java.io.IOException, ServiceException
Restrictions: Requires Permission.DeleteInterface
.
The adaptor may not be referenced by any existing
AdaptorLink
.
java.io.IOException
ServiceException
public java.lang.String getDataText()
public java.lang.String getAdaptorName()
public int getLevel()
public int getLineId()
public java.lang.String getTemplate()
public InterfaceDBO.Type getType()
public void setDataText(java.lang.String dataText)
public void setAdaptorName(java.lang.String adaptorName)
public void setLevel(int level)
public void setTemplate(java.lang.String template)
listTemplateIds(APIClientConnection)
template
- public void setType(InterfaceDBO.Type type)
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |