java.lang.Object
- java.lang.Enum<PermaLinkPurpose>
- - com.redwood.scheduler.api.model.enumeration.PermaLinkPurpose

All Implemented Interfaces:

BaseSchedulerEnumeration<PermaLinkPurpose,Integer>, SchedulerIntegerEnumeration<PermaLinkPurpose>, Serializable, Comparable<PermaLinkPurpose>
```
public enum PermaLinkPurpose
extends Enum<PermaLinkPurpose>
implements SchedulerIntegerEnumeration<PermaLinkPurpose>
```
The page type to be opened by a perma link. (Integer Enumeration)

Enum Constant Summary

Enum Constants
Enum Constant	Description
`AuditTrail`	Link will open a show page with the audit trail visible
`Create`	Link will open a create page
`Diagram`	Link will open diagram
`Documentation`	Link will open a page in the product documentation
`Edit`	Link will open an edit page
`Execute`	Link will execute an action
`List`	Link will open a overview page
`Output`	Link will open File output
`Search`	Link will open the searched object
`Show`	Link will open a show page
`Submit`	Link will open the submit page
`Support`	Link will open a in-product support edit page
`Wizard`	Link will open wizard

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`AuditTrailCode`	The int returned from AuditTrail.getCodeEx().
`static int`	`CreateCode`	The int returned from Create.getCodeEx().
`static int`	`DiagramCode`	The int returned from Diagram.getCodeEx().
`static int`	`DocumentationCode`	The int returned from Documentation.getCodeEx().
`static int`	`EditCode`	The int returned from Edit.getCodeEx().
`static int`	`ExecuteCode`	The int returned from Execute.getCodeEx().
`static int`	`ListCode`	The int returned from List.getCodeEx().
`static int`	`OutputCode`	The int returned from Output.getCodeEx().
`static int`	`SearchCode`	The int returned from Search.getCodeEx().
`static int`	`ShowCode`	The int returned from Show.getCodeEx().
`static int`	`SubmitCode`	The int returned from Submit.getCodeEx().
`static int`	`SupportCode`	The int returned from Support.getCodeEx().
`static int`	`WizardCode`	The int returned from Wizard.getCodeEx().

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getCodeEx()`	Get the code that is used to represent this enumeration in the database.
`Integer`	`getCodeExInteger()`	Get the code that is used to represent this enumeration in the database.
`Integer`	`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`	`getStringValue()`
`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 PermaLinkPurpose`	`safeValueOf(String value)`	Helper function to return the PermaLinkPurpose represented by `value`.
`static PermaLinkPurpose`	`valueOf(int code)`	Helper function to return the PermaLinkPurpose represented by code.
`static PermaLinkPurpose`	`valueOf(Integer code)`	Helper function to return the PermaLinkPurpose represented by code.
`static PermaLinkPurpose`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static PermaLinkPurpose`	`valueOfCode(String code)`	Helper function to return the PermaLinkPurpose represented by code.
`static PermaLinkPurpose[]`	`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
  - Show
```
public static final PermaLinkPurpose Show
```
    Link will open a show page
  - Edit
```
public static final PermaLinkPurpose Edit
```
    Link will open an edit page
  - List
```
public static final PermaLinkPurpose List
```
    Link will open a overview page
  - Create
```
public static final PermaLinkPurpose Create
```
    Link will open a create page
  - Submit
```
public static final PermaLinkPurpose Submit
```
    Link will open the submit page
  - Output
```
public static final PermaLinkPurpose Output
```
    Link will open File output
  - Diagram
```
public static final PermaLinkPurpose Diagram
```
    Link will open diagram
  - Wizard
```
public static final PermaLinkPurpose Wizard
```
    Link will open wizard
  - Execute
```
public static final PermaLinkPurpose Execute
```
    Link will execute an action
  - Support
```
public static final PermaLinkPurpose Support
```
    Link will open a in-product support edit page
  - AuditTrail
```
public static final PermaLinkPurpose AuditTrail
```
    Link will open a show page with the audit trail visible
  - Documentation
```
public static final PermaLinkPurpose Documentation
```
    Link will open a page in the product documentation
  - Search
```
public static final PermaLinkPurpose Search
```
    Link will open the searched object
- Field Detail
  - ShowCode
```
public static final int ShowCode
```
    The int returned from Show.getCodeEx().
    
    See Also:
    
    Show, Constant Field Values
  - EditCode
```
public static final int EditCode
```
    The int returned from Edit.getCodeEx().
    
    See Also:
    
    Edit, Constant Field Values
  - ListCode
```
public static final int ListCode
```
    The int returned from List.getCodeEx().
    
    See Also:
    
    List, Constant Field Values
  - CreateCode
```
public static final int CreateCode
```
    The int returned from Create.getCodeEx().
    
    See Also:
    
    Create, Constant Field Values
  - SubmitCode
```
public static final int SubmitCode
```
    The int returned from Submit.getCodeEx().
    
    See Also:
    
    Submit, Constant Field Values
  - OutputCode
```
public static final int OutputCode
```
    The int returned from Output.getCodeEx().
    
    See Also:
    
    Output, Constant Field Values
  - DiagramCode
```
public static final int DiagramCode
```
    The int returned from Diagram.getCodeEx().
    
    See Also:
    
    Diagram, Constant Field Values
  - WizardCode
```
public static final int WizardCode
```
    The int returned from Wizard.getCodeEx().
    
    See Also:
    
    Wizard, Constant Field Values
  - ExecuteCode
```
public static final int ExecuteCode
```
    The int returned from Execute.getCodeEx().
    
    See Also:
    
    Execute, Constant Field Values
  - SupportCode
```
public static final int SupportCode
```
    The int returned from Support.getCodeEx().
    
    See Also:
    
    Support, Constant Field Values
  - AuditTrailCode
```
public static final int AuditTrailCode
```
    The int returned from AuditTrail.getCodeEx().
    
    See Also:
    
    AuditTrail, Constant Field Values
  - DocumentationCode
```
public static final int DocumentationCode
```
    The int returned from Documentation.getCodeEx().
    
    See Also:
    
    Documentation, Constant Field Values
  - SearchCode
```
public static final int SearchCode
```
    The int returned from Search.getCodeEx().
    
    See Also:
    
    Search, Constant Field Values
- Method Detail
  - values
```
public static PermaLinkPurpose[] 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 (PermaLinkPurpose c : PermaLinkPurpose.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PermaLinkPurpose 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
  - getStringValue
```
public String getStringValue()
```
  - valueOfCode
```
public static PermaLinkPurpose valueOfCode(String code)
```
    Helper function to return the PermaLinkPurpose represented by code. If code is null, empty, or not a valid code then this method will return null.
    
    Parameters:
    
    code - A string that is one of the codes for PermaLinkPurpose
    
    Returns:
    
    The PermaLinkPurpose corresponding to code, or null.
  - safeValueOf
```
public static PermaLinkPurpose safeValueOf(String value)
```
    Helper function to return the PermaLinkPurpose represented by value. If value is null, or not a valid PermaLinkPurpose 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 PermaLinkPurpose corresponding to value, or null, if value is null, or not a valid enumeration
    
    See Also:
    
    valueOf(String)
  - valueOf
```
public static PermaLinkPurpose valueOf(Integer code)
```
    Helper function to return the PermaLinkPurpose represented by code. If code is null, or not a valid PermaLinkPurpose code then this method will return null.
    
    Parameters:
    
    code - Integer that is one of the codes for HandlerAction
    
    Returns:
    
    The PermaLinkPurpose corresponding to code, or null, if code is null, or not a valid code
  - valueOf
```
public static PermaLinkPurpose valueOf(int code)
```
    Helper function to return the PermaLinkPurpose represented by code. If code is not a valid PermaLinkPurpose code then this method will return null.
    
    Parameters:
    
    code - char that is one of the codes for HandlerAction
    
    Returns:
    
    The PermaLinkPurpose corresponding to code, or null, if code is not a valid code
  - getCodeEx
```
public int getCodeEx()
```
    Description copied from interface: SchedulerIntegerEnumeration
    
    Get the code that is used to represent this enumeration in the database.
    
    Specified by:
    
    getCodeEx in interface SchedulerIntegerEnumeration<PermaLinkPurpose>
    
    Returns:
    
    the database code for the enumeration
  - getCodeExValue
```
public Integer 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<PermaLinkPurpose,Integer>
    
    Returns:
    
    the enumeration code
  - getCodeExInteger
```
public Integer getCodeExInteger()
```
    Description copied from interface: SchedulerIntegerEnumeration
    
    Get the code that is used to represent this enumeration in the database.
    
    Specified by:
    
    getCodeExInteger in interface SchedulerIntegerEnumeration<PermaLinkPurpose>
    
    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<PermaLinkPurpose,Integer>
    
    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<PermaLinkPurpose,Integer>
    
    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<PermaLinkPurpose,Integer>
    
    Returns:
    
    the key that can be passed to SchedulerSession.translateField(String) to retrieve the translated description.

Enum PermaLinkPurpose

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration

Methods inherited from interface java.lang.Comparable

Enum Constant Detail

Show

Edit

List

Create

Submit

Output

Diagram

Wizard

Execute

Support

AuditTrail

Documentation

Search

Field Detail

ShowCode

EditCode

ListCode

CreateCode

SubmitCode

OutputCode

DiagramCode

WizardCode

ExecuteCode

SupportCode

AuditTrailCode

DocumentationCode

SearchCode

Method Detail

values

valueOf

getStringValue

valueOfCode

safeValueOf

valueOf

valueOf

getCodeEx

getCodeExValue

getCodeExInteger

getTranslationKey

getTranslationEN

getDescriptionKey