Enum SAPRecipientType
- java.lang.Object
-
- java.lang.Enum<SAPRecipientType>
-
- com.redwood.scheduler.api.model.enumeration.SAPRecipientType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<SAPRecipientType,Character>
,SchedulerEnumeration<SAPRecipientType>
,Serializable
,Comparable<SAPRecipientType>
public enum SAPRecipientType extends Enum<SAPRecipientType> implements SchedulerEnumeration<SAPRecipientType>
SAP recipient types. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ExternalAddress
External addressFaxNumber
Fax numberInternetUser
SAP internet userName
NameOfficeUser
SAP office userOrganizationalUnit
Organizational unit/positionOrganizationObject
Organization object/IDPrivateList
Private folderRemoteUser
SAP user in another SAP SystemSAPObject
SAP objectSharedList
Shared folderTelexNumber
Telex numberUser
SAP userX400Address
X.400 addressX500Address
X.500 Address
-
Field Summary
Fields Modifier and Type Field Description static char
ExternalAddressCode
The char returned from ExternalAddress.getCodeEx().static char
FaxNumberCode
The char returned from FaxNumber.getCodeEx().static char
InternetUserCode
The char returned from InternetUser.getCodeEx().static char
NameCode
The char returned from Name.getCodeEx().static char
OfficeUserCode
The char returned from OfficeUser.getCodeEx().static char
OrganizationalUnitCode
The char returned from OrganizationalUnit.getCodeEx().static char
OrganizationObjectCode
The char returned from OrganizationObject.getCodeEx().static char
PrivateListCode
The char returned from PrivateList.getCodeEx().static char
RemoteUserCode
The char returned from RemoteUser.getCodeEx().static char
SAPObjectCode
The char returned from SAPObject.getCodeEx().static char
SharedListCode
The char returned from SharedList.getCodeEx().static char
TelexNumberCode
The char returned from TelexNumber.getCodeEx().static char
UserCode
The char returned from User.getCodeEx().static char
X400AddressCode
The char returned from X400Address.getCodeEx().static char
X500AddressCode
The char returned from X500Address.getCodeEx().
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description char
getCodeEx()
Get the code that is used to represent this enumeration in the database.Character
getCodeExCharacter()
Get the code that is used to represent this enumeration in the database.String
getCodeExString()
Get the code that is used to represent this enumeration in the database.Character
getCodeExValue()
Return the code for the enumeration item as the database type of this enumeration.String
getDescriptionKey()
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.String
getTranslationEN()
Get the English name of this enumeration.String
getTranslationKey()
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.static SAPRecipientType
safeValueOf(String value)
Helper function to return the SAPRecipientType represented byvalue
.static SAPRecipientType
valueOf(char code)
Helper function to return the SAPRecipientType represented by code.static SAPRecipientType
valueOf(Character code)
Helper function to return the SAPRecipientType represented by code.static SAPRecipientType
valueOf(String name)
Returns the enum constant of this type with the specified name.static SAPRecipientType
valueOfCode(String code)
Helper function to return the SAPRecipientType represented by code.static SAPRecipientType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.-
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration
name, ordinal
-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Enum Constant Detail
-
Name
public static final SAPRecipientType Name
Name
-
PrivateList
public static final SAPRecipientType PrivateList
Private folder
-
SharedList
public static final SAPRecipientType SharedList
Shared folder
-
OfficeUser
public static final SAPRecipientType OfficeUser
SAP office user
-
User
public static final SAPRecipientType User
SAP user
-
InternetUser
public static final SAPRecipientType InternetUser
SAP internet user
-
X400Address
public static final SAPRecipientType X400Address
X.400 address
-
RemoteUser
public static final SAPRecipientType RemoteUser
SAP user in another SAP System
-
ExternalAddress
public static final SAPRecipientType ExternalAddress
External address
-
FaxNumber
public static final SAPRecipientType FaxNumber
Fax number
-
X500Address
public static final SAPRecipientType X500Address
X.500 Address
-
TelexNumber
public static final SAPRecipientType TelexNumber
Telex number
-
OrganizationalUnit
public static final SAPRecipientType OrganizationalUnit
Organizational unit/position
-
SAPObject
public static final SAPRecipientType SAPObject
SAP object
-
OrganizationObject
public static final SAPRecipientType OrganizationObject
Organization object/ID
-
-
Field Detail
-
NameCode
public static final char NameCode
The char returned from Name.getCodeEx().- See Also:
Name
, Constant Field Values
-
PrivateListCode
public static final char PrivateListCode
The char returned from PrivateList.getCodeEx().- See Also:
PrivateList
, Constant Field Values
-
SharedListCode
public static final char SharedListCode
The char returned from SharedList.getCodeEx().- See Also:
SharedList
, Constant Field Values
-
OfficeUserCode
public static final char OfficeUserCode
The char returned from OfficeUser.getCodeEx().- See Also:
OfficeUser
, Constant Field Values
-
UserCode
public static final char UserCode
The char returned from User.getCodeEx().- See Also:
User
, Constant Field Values
-
InternetUserCode
public static final char InternetUserCode
The char returned from InternetUser.getCodeEx().- See Also:
InternetUser
, Constant Field Values
-
X400AddressCode
public static final char X400AddressCode
The char returned from X400Address.getCodeEx().- See Also:
X400Address
, Constant Field Values
-
RemoteUserCode
public static final char RemoteUserCode
The char returned from RemoteUser.getCodeEx().- See Also:
RemoteUser
, Constant Field Values
-
ExternalAddressCode
public static final char ExternalAddressCode
The char returned from ExternalAddress.getCodeEx().- See Also:
ExternalAddress
, Constant Field Values
-
FaxNumberCode
public static final char FaxNumberCode
The char returned from FaxNumber.getCodeEx().- See Also:
FaxNumber
, Constant Field Values
-
X500AddressCode
public static final char X500AddressCode
The char returned from X500Address.getCodeEx().- See Also:
X500Address
, Constant Field Values
-
TelexNumberCode
public static final char TelexNumberCode
The char returned from TelexNumber.getCodeEx().- See Also:
TelexNumber
, Constant Field Values
-
OrganizationalUnitCode
public static final char OrganizationalUnitCode
The char returned from OrganizationalUnit.getCodeEx().- See Also:
OrganizationalUnit
, Constant Field Values
-
SAPObjectCode
public static final char SAPObjectCode
The char returned from SAPObject.getCodeEx().- See Also:
SAPObject
, Constant Field Values
-
OrganizationObjectCode
public static final char OrganizationObjectCode
The char returned from OrganizationObject.getCodeEx().- See Also:
OrganizationObject
, Constant Field Values
-
-
Method Detail
-
values
public static SAPRecipientType[] 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 (SAPRecipientType c : SAPRecipientType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SAPRecipientType 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 nameNullPointerException
- if the argument is null
-
valueOfCode
public static SAPRecipientType valueOfCode(String code)
Helper function to return the SAPRecipientType 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 SAPRecipientType- Returns:
- The SAPRecipientType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static SAPRecipientType safeValueOf(String value)
Helper function to return the SAPRecipientType represented byvalue
. Ifvalue
is null, or not a valid SAPRecipientType 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 SAPRecipientType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static SAPRecipientType valueOf(Character code)
Helper function to return the SAPRecipientType represented by code. If code is null, or not a valid SAPRecipientType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The SAPRecipientType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static SAPRecipientType valueOf(char code)
Helper function to return the SAPRecipientType represented by code. If code is not a valid SAPRecipientType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The SAPRecipientType corresponding to code, or null, if code is not a valid code
-
getCodeEx
public char getCodeEx()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeEx
in interfaceSchedulerEnumeration<SAPRecipientType>
- Returns:
- the database code for the enumeration
-
getCodeExValue
public Character getCodeExValue()
Description copied from interface:BaseSchedulerEnumeration
Return the code for the enumeration item as the database type of this enumeration.- Specified by:
getCodeExValue
in interfaceBaseSchedulerEnumeration<SAPRecipientType,Character>
- Returns:
- the enumeration code
-
getCodeExCharacter
public Character getCodeExCharacter()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExCharacter
in interfaceSchedulerEnumeration<SAPRecipientType>
- Returns:
- the database code for the enumeration
-
getTranslationKey
public String getTranslationKey()
Description copied from interface:BaseSchedulerEnumeration
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.- Specified by:
getTranslationKey
in interfaceBaseSchedulerEnumeration<SAPRecipientType,Character>
- Returns:
- the key.
-
getTranslationEN
public String getTranslationEN()
Description copied from interface:BaseSchedulerEnumeration
Get the English name of this enumeration.- Specified by:
getTranslationEN
in interfaceBaseSchedulerEnumeration<SAPRecipientType,Character>
- Returns:
- the English name of this enumeration.
-
getDescriptionKey
public String getDescriptionKey()
Description copied from interface:BaseSchedulerEnumeration
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.- Specified by:
getDescriptionKey
in interfaceBaseSchedulerEnumeration<SAPRecipientType,Character>
- Returns:
- the key that can be passed to
SchedulerSession.translateField(String)
to retrieve the translated description.
-
getCodeExString
public String getCodeExString()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExString
in interfaceSchedulerEnumeration<SAPRecipientType>
- Returns:
- the database code for the enumeration
-
-