Enum JobFileAccessMethod
- java.lang.Object
- 
- java.lang.Enum<JobFileAccessMethod>
- 
- com.redwood.scheduler.api.model.enumeration.JobFileAccessMethod
 
 
- 
- All Implemented Interfaces:
- BaseSchedulerEnumeration<JobFileAccessMethod,Character>,- SchedulerEnumeration<JobFileAccessMethod>,- Serializable,- Comparable<JobFileAccessMethod>
 
 public enum JobFileAccessMethod extends Enum<JobFileAccessMethod> implements SchedulerEnumeration<JobFileAccessMethod> The method being called to access a job file contents. (Character Enumeration)
- 
- 
Enum Constant SummaryEnum Constants Enum Constant Description GetInputStreamThe user is calling getInputStream().SearchRemoteIntThe user is calling searchRemoteInt()
 - 
Field SummaryFields Modifier and Type Field Description static charGetInputStreamCodeThe char returned from GetInputStream.getCodeEx().static charSearchRemoteIntCodeThe char returned from SearchRemoteInt.getCodeEx().
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description chargetCodeEx()Get the code that is used to represent this enumeration in the database.CharactergetCodeExCharacter()Get the code that is used to represent this enumeration in the database.StringgetCodeExString()Get the code that is used to represent this enumeration in the database.CharactergetCodeExValue()Return the code for the enumeration item as the database type of this enumeration.StringgetDescriptionKey()Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.StringgetTranslationEN()Get the English name of this enumeration.StringgetTranslationKey()Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.static JobFileAccessMethodsafeValueOf(String value)Helper function to return the JobFileAccessMethod represented byvalue.static JobFileAccessMethodvalueOf(char code)Helper function to return the JobFileAccessMethod represented by code.static JobFileAccessMethodvalueOf(Character code)Helper function to return the JobFileAccessMethod represented by code.static JobFileAccessMethodvalueOf(String name)Returns the enum constant of this type with the specified name.static JobFileAccessMethodvalueOfCode(String code)Helper function to return the JobFileAccessMethod represented by code.static JobFileAccessMethod[]values()Returns an array containing the constants of this enum type, in the order they are declared.- 
Methods inherited from class java.lang.Enumclone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 - 
Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumerationname, ordinal
 - 
Methods inherited from interface java.lang.ComparablecompareTo
 
- 
 
- 
- 
- 
Enum Constant Detail- 
SearchRemoteIntpublic static final JobFileAccessMethod SearchRemoteInt The user is calling searchRemoteInt()
 - 
GetInputStreampublic static final JobFileAccessMethod GetInputStream The user is calling getInputStream().
 
- 
 - 
Field Detail- 
SearchRemoteIntCodepublic static final char SearchRemoteIntCode The char returned from SearchRemoteInt.getCodeEx().- See Also:
- SearchRemoteInt, Constant Field Values
 
 - 
GetInputStreamCodepublic static final char GetInputStreamCode The char returned from GetInputStream.getCodeEx().- See Also:
- GetInputStream, Constant Field Values
 
 
- 
 - 
Method Detail- 
valuespublic static JobFileAccessMethod[] values() Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (JobFileAccessMethod c : JobFileAccessMethod.values()) System.out.println(c); - Returns:
- an array containing the constants of this enum type, in the order they are declared
 
 - 
valueOfpublic static JobFileAccessMethod valueOf(String name) Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
- name- the name of the enum constant to be returned.
- Returns:
- the enum constant with the specified name
- Throws:
- IllegalArgumentException- if this enum type has no constant with the specified name
- NullPointerException- if the argument is null
 
 - 
valueOfCodepublic static JobFileAccessMethod valueOfCode(String code) Helper function to return the JobFileAccessMethod represented by code. code must be a single character. If code is null, longer than one character, empty, or not a valid code then this method will return null.- Parameters:
- code- A string with one character that is one of the codes for JobFileAccessMethod
- Returns:
- The JobFileAccessMethod corresponding to code, or null, if code is null, longer than one character, or not a valid code
 
 - 
safeValueOfpublic static JobFileAccessMethod safeValueOf(String value) Helper function to return the JobFileAccessMethod represented byvalue. Ifvalueis null, or not a valid JobFileAccessMethod enumeration then this method will return null.The main difference between this method and valueOf(String), is that this method will return null when passed an invalidvalue,valueOf(String)will throw anIllegalArgumentException.- Parameters:
- value- The string value that corresponds to the requested enumeration value
- Returns:
- The JobFileAccessMethod corresponding to value, or null, ifvalueis null, or not a valid enumeration
- See Also:
- valueOf(String)
 
 - 
valueOfpublic static JobFileAccessMethod valueOf(Character code) Helper function to return the JobFileAccessMethod represented by code. If code is null, or not a valid JobFileAccessMethod code then this method will return null.- Parameters:
- code- Character that is one of the codes for HandlerAction
- Returns:
- The JobFileAccessMethod corresponding to code, or null, if code is null, or not a valid code
 
 - 
valueOfpublic static JobFileAccessMethod valueOf(char code) Helper function to return the JobFileAccessMethod represented by code. If code is not a valid JobFileAccessMethod code then this method will return null.- Parameters:
- code- char that is one of the codes for HandlerAction
- Returns:
- The JobFileAccessMethod corresponding to code, or null, if code is not a valid code
 
 - 
getCodeExpublic char getCodeEx() Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExin interface- SchedulerEnumeration<JobFileAccessMethod>
- Returns:
- the database code for the enumeration
 
 - 
getCodeExValuepublic Character getCodeExValue() Description copied from interface:BaseSchedulerEnumerationReturn the code for the enumeration item as the database type of this enumeration.- Specified by:
- getCodeExValuein interface- BaseSchedulerEnumeration<JobFileAccessMethod,Character>
- Returns:
- the enumeration code
 
 - 
getCodeExCharacterpublic Character getCodeExCharacter() Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExCharacterin interface- SchedulerEnumeration<JobFileAccessMethod>
- Returns:
- the database code for the enumeration
 
 - 
getTranslationKeypublic String getTranslationKey() Description copied from interface:BaseSchedulerEnumerationGet the translation-key that must be used to retrieve the locale-specific name of this enumeration.- Specified by:
- getTranslationKeyin interface- BaseSchedulerEnumeration<JobFileAccessMethod,Character>
- Returns:
- the key.
 
 - 
getTranslationENpublic String getTranslationEN() Description copied from interface:BaseSchedulerEnumerationGet the English name of this enumeration.- Specified by:
- getTranslationENin interface- BaseSchedulerEnumeration<JobFileAccessMethod,Character>
- Returns:
- the English name of this enumeration.
 
 - 
getDescriptionKeypublic String getDescriptionKey() Description copied from interface:BaseSchedulerEnumerationGet the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.- Specified by:
- getDescriptionKeyin interface- BaseSchedulerEnumeration<JobFileAccessMethod,Character>
- Returns:
- the key that can be passed to
         SchedulerSession.translateField(String)to retrieve the translated description.
 
 - 
getCodeExStringpublic String getCodeExString() Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExStringin interface- SchedulerEnumeration<JobFileAccessMethod>
- Returns:
- the database code for the enumeration
 
 
- 
 
-