|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JobResult
Interface through which to report the result of a job.
Field Summary | |
---|---|
static int |
ABORTED
Value for getLevel() and setLevel(int) methods. |
static int |
ERROR
Value for getLevel() and setLevel(int) methods. |
static int |
SUCCESS
Value for getLevel() and setLevel(int) methods. |
static int |
WARNING
Value for getLevel() and setLevel(int) methods. |
Method Summary | |
---|---|
int |
getCode()
Get any error code associated with this result. |
int |
getLevel()
Get the level currently associated with this result. |
String |
getMessage()
Return the message associated with this result, if any. |
DirectoryObject |
getObject()
Get the directory object associated with this result, if any. |
void |
setCode(int code)
Set an error code for this result. |
void |
setLevel(int level)
Set the level for this result. |
void |
setMessage(String message)
Set the message associated with this result. |
void |
setObject(DirectoryObject object)
Set the directory object associated with this result. |
Field Detail |
---|
static final int SUCCESS
getLevel()
and setLevel(int)
methods.
Indicates all processing completed successfully.
static final int WARNING
getLevel()
and setLevel(int)
methods.
Indicates all processing completed but with non-critical problems.
static final int ERROR
getLevel()
and setLevel(int)
methods.
Indicates processing did not complete, or completed but with critical problems.
static final int ABORTED
getLevel()
and setLevel(int)
methods.
Indicates processing did not complete.
Method Detail |
---|
int getLevel()
SUCCESS
, WARNING
, ERROR
, ABORTED
void setLevel(int level) throws IllegalArgumentException
level
- SUCCESS
, WARNING
, ERROR
, ABORTED
IllegalArgumentException
- thrown if level
is not one of the listed values.int getCode()
0
) indicates
no error code is associated with the result.
0
void setCode(int code)
code
- error code (zero means no error)String getMessage()
null
.void setMessage(String message)
message
- The message String
. May be null
.DirectoryObject getObject()
DirectoryObject
instance associated with this result. May be null
.void setObject(DirectoryObject object)
object
- DirectoryObject
instance. May be null
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |