|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.buildforge.services.client.dbo.TagVar
public class TagVar
A TagVar is a named variable used by build tags. For instance, a TagVar may be used to connote sequential build numbers in the case of an auto-incrementing variable. TagVars are refereced by build tags using a '$' prefix notation before the name of the TagVar, i.e.: $FOO references the TagVar named FOO.
Field Summary | |
---|---|
static java.lang.Class<TagVar> |
CLASS
|
Constructor Summary | |
---|---|
TagVar(APIClientConnection conn)
|
Method Summary | |
---|---|
TagVar |
create()
Creates this TagVar in the database |
void |
delete()
Removes this TagVar from the database |
static java.util.List<TagVar> |
findByPid(APIClientConnection conn,
int projectId)
Retrieves all tag variables by Project identifier |
static TagVar |
findByPidName(APIClientConnection conn,
int projectId,
java.lang.String tagName)
Retrieves a named tag variable by Project identifier |
static TagVar |
findByPidTid(APIClientConnection conn,
int projectId,
int tagId)
Retrives a single tag variable by Project identifier and TagVar identifier |
boolean |
getAutoInc()
Returns whether ( true ) or not (false ) a variable will be
automatically incremented on each build. |
java.lang.String |
getName()
Returns the unique (project-wide) name of this tag variable |
int |
getPadding()
|
int |
getProjectId()
Returns the identifier of the Project to which this tag variable belongs |
int |
getTagId()
Returns the unique (project-wide) identifier of this tag variable |
int |
getValue()
Returns the current value of this tag variable |
void |
setAutoInc(boolean autoInc)
Sets whether ( true ) or not (false ) a variable will be
automatically incremented on each build. |
void |
setName(java.lang.String name)
Sets the unique (project-wide) name of this tag variable |
void |
setPadding(int padding)
|
void |
setProjectId(int projectId)
Sets the identifier of the Project to which this tag variable belongs |
void |
setTagId(int tagId)
Deprecated. |
void |
setValue(int value)
Sets the current value of this tag variable |
java.lang.String |
toString()
|
TagVar |
update()
Commits the latest state of this object to the database |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.Class<TagVar> CLASS
Constructor Detail |
---|
public TagVar(APIClientConnection conn)
Method Detail |
---|
public static java.util.List<TagVar> findByPid(APIClientConnection conn, int projectId) throws java.io.IOException, ServiceException
Project
identifier
conn
- projectId
- The integer identifier of the Project whose tags will be returned
java.io.IOException
ServiceException
public static TagVar findByPidName(APIClientConnection conn, int projectId, java.lang.String tagName) throws java.io.IOException, ServiceException
Project
identifier
conn
- projectId
- The integer identifier of the Project whose tag will be returnedtagName
- The name of the TagVar to return
java.io.IOException
ServiceException
public static TagVar findByPidTid(APIClientConnection conn, int projectId, int tagId) throws java.io.IOException, ServiceException
Project
identifier and TagVar identifier
conn
- projectId
- The integer identifier of the Project whose tag will be returnedtagId
- The integer identifier of the TagVar to be returned
java.io.IOException
ServiceException
public TagVar update() throws java.io.IOException, ServiceException
java.io.IOException
ServiceException
public TagVar create() throws java.io.IOException, ServiceException
java.io.IOException
ServiceException
public void delete() throws java.io.IOException, ServiceException
java.io.IOException
ServiceException
public boolean getAutoInc()
true
) or not (false
) a variable will be
automatically incremented on each build.
public java.lang.String getName()
public int getPadding()
public int getProjectId()
Project
to which this tag variable belongs
public int getTagId()
public int getValue()
public void setAutoInc(boolean autoInc)
true
) or not (false
) a variable will be
automatically incremented on each build.
autoInc
- public void setName(java.lang.String name)
public void setPadding(int padding) throws APIException
APIException
public void setProjectId(int projectId)
Project
to which this tag variable belongs
@Deprecated public void setTagId(int tagId)
public void setValue(int value) throws APIException
APIException
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 |