|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.buildforge.services.client.dbo.Register
public class Register
Build and project registers. These registers are shared, named values bound to projects or builds.
Field Summary | |
---|---|
static java.lang.Class<Register> |
CLASS
|
Constructor Summary | |
---|---|
Register(APIClientConnection conn)
|
Method Summary | |
---|---|
Register |
create()
Creates a new register in the database |
void |
delete()
Removes this Register from the database |
static void |
deleteAllRegistersByBuild(APIClientConnection conn,
int buildId)
Removes all Registers associated with the provided Build from the database |
static void |
deleteAllRegistersByProject(APIClientConnection conn,
int projectId)
Removes all Registers associated with the provided Project from the database |
static java.util.List<Register> |
findAllRegistersByBuild(APIClientConnection conn,
int buildId)
Retrieves all registers bound to a particular build |
static java.util.List<Register> |
findAllRegistersByProject(APIClientConnection conn,
int projectId)
Retrieves all registers bound to a particular project |
static Register |
findBuildRegisterById(APIClientConnection conn,
int buildId,
java.lang.String registerName)
Retrieves a specific build register by name |
static Register |
findProjectRegisterById(APIClientConnection conn,
int projectId,
java.lang.String registerName)
Retrieves a specific project register by name |
int |
getBuildId()
Returns the identifier of the Build to which this Register is associated. |
java.lang.String |
getDataText()
Returns the value of this register |
int |
getProjectId()
Returns the identifier of the Project to which this Register is associated. |
java.lang.String |
getRegister()
Returns the name of the Register |
int |
getStamp()
Returns the timestamp of the last register update in seconds since epoch (not millis) |
int |
getUserId()
Returns the identifier of the user that created this Register with a build, for Registers created with projects, it will return 0 |
void |
setBuildId(int buildId)
Sets the identifier of the Build to which this Register is associated. |
void |
setDataText(java.lang.String newText)
Sets the value of this register |
void |
setProjectId(int projectId)
Sets the identifier of the Project to which this Register is associated. |
void |
setRegister(java.lang.String register)
Sets the name of the Register |
void |
setStamp(int stamp)
Sets the timestamp of the last register update |
java.lang.String |
toString()
|
Register |
update()
Commits the new 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<Register> CLASS
Constructor Detail |
---|
public Register(APIClientConnection conn)
Method Detail |
---|
public static java.util.List<Register> findAllRegistersByBuild(APIClientConnection conn, int buildId) throws java.io.IOException, ServiceException
conn
- buildId
-
java.io.IOException
ServiceException
public static java.util.List<Register> findAllRegistersByProject(APIClientConnection conn, int projectId) throws java.io.IOException, ServiceException
conn
- projectId
-
java.io.IOException
ServiceException
public static Register findBuildRegisterById(APIClientConnection conn, int buildId, java.lang.String registerName) throws java.io.IOException, ServiceException
conn
- buildId
- registerName
-
java.io.IOException
ServiceException
public static Register findProjectRegisterById(APIClientConnection conn, int projectId, java.lang.String registerName) throws java.io.IOException, ServiceException
conn
- projectId
- registerName
-
java.io.IOException
ServiceException
public Register create() throws java.io.IOException, ServiceException
java.io.IOException
ServiceException
public Register update() throws java.io.IOException, ServiceException
java.io.IOException
ServiceException
public void delete() throws java.io.IOException, ServiceException
java.io.IOException
ServiceException
public static void deleteAllRegistersByBuild(APIClientConnection conn, int buildId) throws java.io.IOException, ServiceException
conn
- buildId
-
java.io.IOException
ServiceException
public static void deleteAllRegistersByProject(APIClientConnection conn, int projectId) throws java.io.IOException, ServiceException
conn
- projectId
-
java.io.IOException
ServiceException
public int getBuildId()
public java.lang.String getDataText()
public int getProjectId()
public java.lang.String getRegister()
public int getStamp()
public int getUserId()
public void setBuildId(int buildId)
buildId
- The new build identifierpublic void setDataText(java.lang.String newText)
newText
- The new valuepublic void setRegister(java.lang.String register)
register
- The register's new namepublic void setStamp(int stamp)
stamp
- The new timestamp in seconds since epoch (not millis)public void setProjectId(int projectId)
projectId
- 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 |