public interface IFileOperationResult extends IServerResource
IFileOperationResult is the base interface for the IFileSpec family of interfaces, and is used to signal and store the synchronous error returns from methods that return file specs and lists of file specs. This is needed due to the Perforce server's penchant for returning info and error messages intertwined with "normal" file specs; this interface can be used to determine the status of a specific returned file spec.
In general, if an IFileOperationResult object has been returned from a server or client (etc.) method, the getOpStatus() method will indicate whether the associated values are "valid" (i.e. were filled-in or whatever by the underlying server) or represent an error or informational event. In the latter cases, the getStatusMessage() method returns the associated server message, and the other fields in the file spec are not guaranteed to contain useful values.
Note that although IFileOperationResult extends the IServerResource interface, current implementations are not refreshable, updateable, or completable through that interface, and isComplete() will currently always return true.
Modifier and Type | Method and Description |
---|---|
int |
getGenericCode()
Get the Perforce generic code associated with the operation result.
|
FileSpecOpStatus |
getOpStatus()
Return the particular Perforce operation status associated with the
specific Perforce file spec operation.
|
int |
getRawCode()
Get the Perforce raw code associated with the operation result.
|
int |
getSeverityCode()
Get the Perforce severity code associated with the operation result.
|
java.lang.String |
getStatusMessage()
Return the status message associated with the operation (this may be an
error or informational message, depending on the operation).
|
int |
getSubCode()
Get the Perforce 'sub' code associated with the operation result.
|
int |
getSubSystem()
Get the Perforce sub system code associated with the operation result.
|
int |
getUniqueCode()
Get the Perforce 'unqieu' code associated with the operation result.
|
canRefresh, canUpdate, clearRawFields, complete, getRawField, getRawFields, hasRawField, refresh, setRawField, setRawFields, setServer, update, update, update
FileSpecOpStatus getOpStatus()
java.lang.String getStatusMessage()
int getSeverityCode()
int getGenericCode()
int getRawCode()
int getUniqueCode()
int getSubSystem()
int getSubCode()