|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IClient
This interface defines the view which is visible through the PC2 API of a PC2 "Client". "Client" in this context refers to a piece of code logged in to a PC2 server via an account which has been created by the Contest Administrator; for example, an instance of a PC2 Team, Judge, Administrator, or Scoreboard, or a separate user-written client which logs in using a contest account.
This documentation describes the current draft of the PC2 API, which is subject to change.
Nested Class Summary | |
---|---|
static class |
IClient.ClientType
This enumerates the Client types defined in the system (that is, the types of Clients visible through the PC2 API). |
Method Summary | |
---|---|
boolean |
equals(Object obj)
Check whether this client is the same as some other client. |
int |
getAccountNumber()
Get the client account number for this client. |
String |
getDisplayName()
Get the client's "display name". |
String |
getLoginName()
Get the client's login name. |
int |
getSiteNumber()
Get the site number for this client. |
IClient.ClientType |
getType()
Get the client Type. |
int |
hashCode()
Get the hashcode associated with this client. |
boolean |
isDisplayableOnScoreboard()
Return a boolean indicating whether this client should be displayed on the scoreboard or not. |
Method Detail |
---|
String getLoginName()
IClient.ClientType getType()
IClient.ClientType
enum elementString getDisplayName()
int getSiteNumber()
int getAccountNumber()
boolean equals(Object obj)
Determination of whether two clients are equal is based on whether they refer to the
same client account as originally created in PC2 by the Contest Administrator.
Note in particular that subsequent changes to a client account
made by the Contest Administrator (for example,
changes to the account display name, password, etc.) do not affect the result of the
equals()
method; if this client refers to the same client as the one indicated by the
specified parameter, this method will return true regardless of whether the internal contents of the two
client objects is identical or not.
equals
in class Object
obj
- the Client which is to be compared with this client for equality.
int hashCode()
hashCode
in class Object
boolean isDisplayableOnScoreboard()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |