Package com.redwood.scheduler.api.model.enumeration

Enum ObjectSearchConditionType

java.lang.Object

java.lang.Enum<ObjectSearchConditionType>

com.redwood.scheduler.api.model.enumeration.ObjectSearchConditionType

All Implemented Interfaces:

BaseSchedulerEnumeration<ObjectSearchConditionType,Character>, SchedulerEnumeration<ObjectSearchConditionType>, Serializable, Comparable<ObjectSearchConditionType>

public enum ObjectSearchConditionType
extends Enum<ObjectSearchConditionType>
implements SchedulerEnumeration<ObjectSearchConditionType>

The type of Object Search Conditions. (Character Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
Application	Search for objects by parent application matches
Comment	Deprecated. This enum constant is deprecated, comment search is entirely incorporated into the Documentation search and is no longer required.
Description	Search for objects by description matches
Documentation	Search for objects by documentation field matches
FileEvent	Search for objects by file event matches
Modified	Search for objects by when or who modified it
Name	Name Search
ParameterValue	Search for objects by parameter matches
Partition	Search for objects by partition matches
Source	Search for objects by source matches
SpecificField	Search for objects by matches to a specific field

Field Summary

Fields

Modifier and Type	Field	Description
static char	ApplicationCode	The char returned from Application.getCodeEx().
static char	CommentCode	Deprecated.
static char	DescriptionCode	The char returned from Description.getCodeEx().
static char	DocumentationCode	The char returned from Documentation.getCodeEx().
static char	FileEventCode	The char returned from FileEvent.getCodeEx().
static char	ModifiedCode	The char returned from Modified.getCodeEx().
static char	NameCode	The char returned from Name.getCodeEx().
static char	ParameterValueCode	The char returned from ParameterValue.getCodeEx().
static char	PartitionCode	The char returned from Partition.getCodeEx().
static char	SourceCode	The char returned from Source.getCodeEx().
static char	SpecificFieldCode	The char returned from SpecificField.getCodeEx().

Method Summary

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 ObjectSearchConditionType	safeValueOf(String value)	Helper function to return the ObjectSearchConditionType represented by value.
static ObjectSearchConditionType	valueOf(char code)	Helper function to return the ObjectSearchConditionType represented by code.
static ObjectSearchConditionType	valueOf(Character code)	Helper function to return the ObjectSearchConditionType represented by code.
static ObjectSearchConditionType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ObjectSearchConditionType	valueOfCode(String code)	Helper function to return the ObjectSearchConditionType represented by code.
static ObjectSearchConditionType[]	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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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 ObjectSearchConditionType Name

Name Search

Comment

@Deprecated
public static final ObjectSearchConditionType Comment

Deprecated.

This enum constant is deprecated, comment search is entirely incorporated into the Documentation search and is no longer required.

Search for objects by comment matches.

Description

public static final ObjectSearchConditionType Description

Search for objects by description matches

Documentation

public static final ObjectSearchConditionType Documentation

Search for objects by documentation field matches

Application

public static final ObjectSearchConditionType Application

Search for objects by parent application matches

Partition

public static final ObjectSearchConditionType Partition

Search for objects by partition matches

ParameterValue

public static final ObjectSearchConditionType ParameterValue

Search for objects by parameter matches

FileEvent

public static final ObjectSearchConditionType FileEvent

Search for objects by file event matches

Source

public static final ObjectSearchConditionType Source

Search for objects by source matches

SpecificField

public static final ObjectSearchConditionType SpecificField

Search for objects by matches to a specific field

Modified

public static final ObjectSearchConditionType Modified

Search for objects by when or who modified it

Field Detail

NameCode

public static final char NameCode

The char returned from Name.getCodeEx().

See Also:

Name, Constant Field Values

CommentCode

@Deprecated
public static final char CommentCode

Deprecated.

The char returned from Comment.getCodeEx().

See Also:

This enum constant is deprecated, comment search is entirely incorporated into the Documentation search and is no longer required., Constant Field Values

DescriptionCode

public static final char DescriptionCode

The char returned from Description.getCodeEx().

See Also:

Description, Constant Field Values

DocumentationCode

public static final char DocumentationCode

The char returned from Documentation.getCodeEx().

See Also:

Documentation, Constant Field Values

ApplicationCode

public static final char ApplicationCode

The char returned from Application.getCodeEx().

See Also:

Application, Constant Field Values

PartitionCode

public static final char PartitionCode

The char returned from Partition.getCodeEx().

See Also:

Partition, Constant Field Values

ParameterValueCode

public static final char ParameterValueCode

The char returned from ParameterValue.getCodeEx().

See Also:

ParameterValue, Constant Field Values

FileEventCode

public static final char FileEventCode

The char returned from FileEvent.getCodeEx().

See Also:

FileEvent, Constant Field Values

SourceCode

public static final char SourceCode

The char returned from Source.getCodeEx().

See Also:

Source, Constant Field Values

SpecificFieldCode

public static final char SpecificFieldCode

The char returned from SpecificField.getCodeEx().

See Also:

SpecificField, Constant Field Values

ModifiedCode

public static final char ModifiedCode

The char returned from Modified.getCodeEx().

See Also:

Modified, Constant Field Values

Method Detail

values

public static ObjectSearchConditionType[] 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 (ObjectSearchConditionType c : ObjectSearchConditionType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ObjectSearchConditionType 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

valueOfCode

public static ObjectSearchConditionType valueOfCode(String code)

Helper function to return the ObjectSearchConditionType 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 ObjectSearchConditionType

Returns:

The ObjectSearchConditionType corresponding to code, or null, if code is null, longer than one character, or not a valid code

safeValueOf

public static ObjectSearchConditionType safeValueOf(String value)

Helper function to return the ObjectSearchConditionType represented by value. If value is null, or not a valid ObjectSearchConditionType 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 invalid value, valueOf(String) will throw an IllegalArgumentException.

Parameters:

value - The string value that corresponds to the requested enumeration value

Returns:

The ObjectSearchConditionType corresponding to value, or null, if value is null, or not a valid enumeration

See Also:

valueOf(String)

valueOf

public static ObjectSearchConditionType valueOf(Character code)

Helper function to return the ObjectSearchConditionType represented by code. If code is null, or not a valid ObjectSearchConditionType code then this method will return null.

Parameters:

code - Character that is one of the codes for HandlerAction

Returns:

The ObjectSearchConditionType corresponding to code, or null, if code is null, or not a valid code

valueOf

public static ObjectSearchConditionType valueOf(char code)

Helper function to return the ObjectSearchConditionType represented by code. If code is not a valid ObjectSearchConditionType code then this method will return null.

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

The ObjectSearchConditionType 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 interface SchedulerEnumeration<ObjectSearchConditionType>

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 interface BaseSchedulerEnumeration<ObjectSearchConditionType,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 interface SchedulerEnumeration<ObjectSearchConditionType>

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 interface BaseSchedulerEnumeration<ObjectSearchConditionType,Character>

Returns:

the key.

getTranslationEN

public String getTranslationEN()

Description copied from interface: BaseSchedulerEnumeration

Get the English name of this enumeration.

Specified by:

getTranslationEN in interface BaseSchedulerEnumeration<ObjectSearchConditionType,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 interface BaseSchedulerEnumeration<ObjectSearchConditionType,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 interface SchedulerEnumeration<ObjectSearchConditionType>

Returns:

the database code for the enumeration