Package com.sun.grid.jsv
Class MailSpecifier
java.lang.Object
com.sun.grid.jsv.MailSpecifier
- All Implemented Interfaces:
Serializable
,Cloneable
The MailSpecifier class represents the occasions when an email notification
should be sent to the mail recipients list about the state of this job.
- Since:
- 6.2u5
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
String representing that email should never be set.static final int
Code representing that email should be sent if the job is abourted.static final String
String representing that email should be sent if the job is abourted.static final int
Code representing that email should be sent when the job is started.static final String
String representing that email should be sent when the job is started.static final int
Code representing that email should be sent when the job ends.static final String
String representing that email should be sent when the job ends.static final int
Code representing that email should be sent if the job is suspended.static final String
String representing that email should be sent if the job is suspended. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
byte
Return a byte value that represents the occasions when email should be sent about a job.Return a String value that represents the occasions when email should be sent about a job.int
hashCode()
byte
never()
Indicate that email should never be sent about a job.boolean
onAbort
(boolean set) Set whether email should be sent if the job is aborted.boolean
onBegin
(boolean set) Set whether email should be sent when the job is started.boolean
onEnd
(boolean set) Set whether email should be sent when the job end.boolean
onSuspend
(boolean set) Set whether email should be sent if the job is suspended.void
setOccasion
(String value) Set the occasions when email should be sent for a job according to a String composed of the string identifiers for the occasions when email should be sent.toString()
-
Field Details
-
NEVER_STR
String representing that email should never be set.- See Also:
-
ON_ABORT
public static final int ON_ABORTCode representing that email should be sent if the job is abourted.- See Also:
-
ON_ABORT_STR
String representing that email should be sent if the job is abourted.- See Also:
-
ON_BEGIN
public static final int ON_BEGINCode representing that email should be sent when the job is started.- See Also:
-
ON_BEGIN_STR
String representing that email should be sent when the job is started.- See Also:
-
ON_END
public static final int ON_ENDCode representing that email should be sent when the job ends.- See Also:
-
ON_END_STR
String representing that email should be sent when the job ends.- See Also:
-
ON_SUSPEND
public static final int ON_SUSPENDCode representing that email should be sent if the job is suspended.- See Also:
-
ON_SUSPEND_STR
String representing that email should be sent if the job is suspended.- See Also:
-
-
Constructor Details
-
MailSpecifier
public MailSpecifier()
-
-
Method Details
-
onBegin
public boolean onBegin(boolean set) Set whether email should be sent when the job is started.- Parameters:
set
- whether email should be sent- Returns:
- the previous value
-
onEnd
public boolean onEnd(boolean set) Set whether email should be sent when the job end.- Parameters:
set
- whether email should be sent- Returns:
- the previous value
-
onAbort
public boolean onAbort(boolean set) Set whether email should be sent if the job is aborted.- Parameters:
set
- whether email should be sent- Returns:
- the previous value
-
onSuspend
public boolean onSuspend(boolean set) Set whether email should be sent if the job is suspended.- Parameters:
set
- whether email should be sent- Returns:
- the previous value
-
never
public byte never()Indicate that email should never be sent about a job. This method effectively clears the flags for all the other occasions. Susequent calls to other methods may add or set the occasions when email is sent.- Returns:
- the previous occasion value, as would be returned from getOccasion().
- See Also:
-
getOccasion
public byte getOccasion()Return a byte value that represents the occasions when email should be sent about a job. The byte value is composed by ORing together the code values for all of the occasions when email should be sent.- Returns:
- the occasion value
- See Also:
-
setOccasion
Set the occasions when email should be sent for a job according to a String composed of the string identifiers for the occasions when email should be sent.- Parameters:
value
- the occasion string- See Also:
-
getOccasionString
Return a String value that represents the occasions when email should be sent about a job. The String value is composed by combining the string identifiers for all of the occasions when email should be sent.- Returns:
- the occasion string
- See Also:
-
equals
-
hashCode
public int hashCode() -
clone
-
toString
-