|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.buildforge.services.client.dbo.AdaptorLink
public class AdaptorLink
An object representing and adaptor link within the Build Forge
system. An adaptor link connects an Adaptor
(adaptor)
to a Project
.
Constructor Summary | |
---|---|
AdaptorLink(APIClientConnection conn)
Define a new adaptor link object. |
Method Summary | |
---|---|
void |
activate()
Activates the AdaptorLink . |
void |
activate(ScopeDBO.Active active)
Sets the AdaptorLink into the activated, deactivated, or
debug state. |
AdaptorLink |
create()
Creates this new AdaptorLink in the database. |
void |
deactivate()
Deactivates the AdaptorLink . |
void |
debug()
Sets the AdaptorLink into debug mode. |
void |
delete()
Removes this AdaptorLink for the database. |
static java.util.List<AdaptorLink> |
findAll(APIClientConnection conn)
Finds all adaptor links to which the user has access. |
static java.util.List<AdaptorLink> |
findByAdaptorName(APIClientConnection conn,
java.lang.String adaptorName)
Finds all adaptor links to which the user has access that make use of the specified interface. |
static AdaptorLink |
findById(APIClientConnection conn,
int scopeId)
Finds an adaptor link by its system-generated ID. |
static AdaptorLink |
findByName(APIClientConnection conn,
java.lang.String name)
Locates an AdaptorLink based using its display name |
static java.util.List<AdaptorLink> |
findByProjectId(APIClientConnection conn,
int projectId)
Finds all adaptor links to which the user has access that are linked to the specified project. |
static AdaptorLink |
findByProjectIdAndAdaptorName(APIClientConnection conn,
int projectId,
java.lang.String adaptorName)
Locates an AdaptorLink based using its Adaptor name and its
Project ID. |
ScopeDBO.Active |
getActive()
Returns the activation state of this AdaptorLink |
int |
getAdaptorLinkId()
Returns the Id of this AdaptorLink |
java.lang.String |
getAdaptorName()
Returns the display name of the Adaptor to which this
AdaptorLink is bound. |
int |
getEnvironmentGroupId()
The Environment Group ID to which this AdaptorLink is attached. |
int |
getJobId()
|
java.lang.String |
getName()
Gets the display name of this AdaptorLink . |
int |
getProjectId()
Returns the ID of the Project to which this AdaptorLink is attached. |
int |
getStamp()
|
java.lang.String |
getStatus()
|
void |
setActive(ScopeDBO.Active active)
Sets the activation state for this AdaptorLink |
void |
setAdaptorName(java.lang.String adaptorName)
Sets the associated Adaptor or Adaptor Template by name that is associated with this AdaptorLink. |
void |
setEnvironmentGroupId(int environmentGroupId)
Sets the ID of the Environment to be referenced by this
AdaptorLink. |
void |
setJobId(int jobId)
|
void |
setName(java.lang.String name)
Sets the display name of this AdaptorLink . |
void |
setProjectId(int projectId)
|
void |
setStamp(int stamp)
|
void |
setStatus(java.lang.String status)
|
java.lang.String |
toString()
|
AdaptorLink |
update()
Commits all changes to this AdaptorLink to the database. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AdaptorLink(APIClientConnection conn)
create()
method.
conn
- the services layer connection that the adaptor link
object should use when submitting requestsMethod Detail |
---|
public static final java.util.List<AdaptorLink> findAll(APIClientConnection conn) throws java.io.IOException, ServiceException
Adaptor
and the Project
that it links.
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 final java.util.List<AdaptorLink> findByProjectId(APIClientConnection conn, int projectId) throws java.io.IOException, ServiceException
Adaptor
and
the Project
that it links. A APIException
will be
thrown if the given Project doesn't exist.
conn
- the API client connection to use for the requestprojectId
- the project ID
of
the project for which adaptor links should be found
ServiceException
java.io.IOException
public static final java.util.List<AdaptorLink> findByAdaptorName(APIClientConnection conn, java.lang.String adaptorName) throws java.io.IOException, ServiceException
Adaptor
and the Project
that it links. A APIException
will be
thrown if the given Adaptor doesn't exist.
conn
- the API client connection to use for the requestadaptorName
- the name
of the adaptor
for which links should be found
java.io.IOException
ServiceException
public static final AdaptorLink findById(APIClientConnection conn, int scopeId) throws java.io.IOException, ServiceException
conn
- the API client connection to use for the requestscopeId
- the getAdaptorLinkId()
java.io.IOException
ServiceException
public static final AdaptorLink findByName(APIClientConnection conn, java.lang.String name) throws java.io.IOException, ServiceException
conn
- the API client connection to use for the requestname
- the AdaptorLink's display name, found by getName()
java.io.IOException
ServiceException
public static final AdaptorLink findByProjectIdAndAdaptorName(APIClientConnection conn, int projectId, java.lang.String adaptorName) throws java.io.IOException, ServiceException
Adaptor
name and its
Project
ID. If a AdaptorLink doesn't exist with those values,
null is returned.
conn
- the API client connection to use for the requestprojectId
- the Project
IDadaptorName
- the Adaptor
name
java.io.IOException
ServiceException
public AdaptorLink create() throws java.io.IOException, ServiceException
AdaptorLink
in the database.
java.io.IOException
ServiceException
public void delete() throws java.io.IOException, ServiceException
AdaptorLink
for the database.
java.io.IOException
ServiceException
public AdaptorLink update() throws java.io.IOException, ServiceException
AdaptorLink
to the database.
java.io.IOException
ServiceException
public void deactivate() throws java.io.IOException, ServiceException
Deactivates the AdaptorLink
.
This convenience method is exactly equivalent to calling
activate(ScopeDBO.Active.NO)
.
java.io.IOException
ServiceException
public void debug() throws java.io.IOException, ServiceException
Sets the AdaptorLink
into debug mode.
This convenience method is exactly equivalent to calling
activate(ScopeDBO.Active.DEBUG)
.
java.io.IOException
ServiceException
public void activate() throws java.io.IOException, ServiceException
Activates the AdaptorLink
.
This convenience method is exactly equivalent to calling
activate(ScopeDBO.Active.YES)
.
java.io.IOException
ServiceException
public void activate(ScopeDBO.Active active) throws java.io.IOException, ServiceException
AdaptorLink
into the activated, deactivated, or
debug state. Note that while setActive(ScopeDBO.Active)
requires an explicit call to update()
, this method takes
effect immediately.
active
- the activation state to set
java.io.IOException
ServiceException
public ScopeDBO.Active getActive()
AdaptorLink
public int getAdaptorLinkId()
AdaptorLink
public java.lang.String getAdaptorName()
Adaptor
to which this
AdaptorLink
is bound.
public int getEnvironmentGroupId()
environment group
is assigned; otherwise,
Environment.findById(APIClientConnection, int)
may be
used to load the environment group.
public int getJobId()
public java.lang.String getName()
AdaptorLink
.
name
- public int getProjectId()
Project
to which this AdaptorLink
is attached.
public int getStamp()
public java.lang.String getStatus()
public void setActive(ScopeDBO.Active active)
AdaptorLink
active
- public void setAdaptorName(java.lang.String adaptorName)
adaptorName
- the name of the Adaptor
public void setEnvironmentGroupId(int environmentGroupId)
Environment
to be referenced by this
AdaptorLink. Passing 0 indicates that no Environment should be
associated with this AdaptorLink
environmentUuid
- the id of the Environment
public void setJobId(int jobId)
public void setName(java.lang.String name)
AdaptorLink
.
name
- public void setProjectId(int projectId)
public void setStamp(int stamp)
public void setStatus(java.lang.String status)
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 |