All Superinterfaces:

BusinessKeyObject, NamedRootObject, NamedRootObjectComp, Readable, RegistryEntryComp, Root, SchedulerEntity, SchedulerEntityComp
```
public interface RegistryEntry
extends RegistryEntryComp, NamedRootObject, BusinessKeyObject, Readable
```
Registry entry storing product-specific configuration settings. A registry entry can have a value associated with it, as well as child entries.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ALLOW_SUN_IMPORT_REGISTRY_ENTRY`	If this entry is present and set to true, the import allows the classes that starts with sun.com or sun.
`static String`	`OBJECT_TYPE`	String that will be returned from `SchedulerEntity.getObjectType()` for "RegistryEntry" objects.
`static Long`	`P_A_MICROSOFT_WINDOWS_LOCAL_INTERPRETER_BITS_DEFAULT`	Whether the default CMD runs as 32 or as 64 bit process on a 64 bit server.
`static String`	`P_A_MICROSOFT_WINDOWS_LOCAL_INTERPRETER_BITS_PATH`	Whether the default CMD runs as 32 or as 64 bit process on a 64 bit server.
`static String`	`PATH_SEPARATOR`	Separator used to separate the hierarchical parts of the path; this character cannot be used in the name of a RegistryEntry.
`static String`	`SEC_PRIV_CREATE`	This privilege can be granted at a group level.
`static String`	`SEC_PRIV_CREATECHILDREN`	This privilege can be granted at an instance level.
`static String`	`SEC_PRIV_DELETE`	This privilege can be granted at a group level.
`static String`	`SEC_PRIV_EDIT`	This privilege can be granted at a group level.
`static String`	`SEC_PRIV_VIEW`	This privilege can be granted at a group level.
`static String`	`SEC_RANK_ALL`	This rank is made of the following privileges: view , create , createChildren , edit , delete
`static String`	`SEC_RANK_NONE`	This rank has no privileges assigned to it.
`static String`	`SEC_RANK_OWNER`	This rank is made of the following privileges: view , createChildren
`static String`	`SEC_RANK_VIEW`	This rank is made of the following privileges: view
`static String`	`SPOOL_RETRIEVAL_PROCESSSERVER_OPTION_PATH`	How should the spool retrieval process server option be treated.
`static QueryObjectType<RegistryEntry>`	`TYPE`	Type that can be used in `SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...)`.

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity
ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`RequiredPermission`	`checkCreateChildrenPrivilege()`	Check whether or not the createChildren action can be performed on this object.
`RequiredPermission`	`checkCreatePrivilege()`	Check whether or not the create action can be performed on this object.
`RequiredPermission`	`checkDeletePrivilege()`	Check whether or not the delete action can be performed on this object.
`RequiredPermission`	`checkEditPrivilege()`	Check whether or not the edit action can be performed on this object.
`RequiredPermission`	`checkViewPrivilege()`	Check whether or not the view action can be performed on this object.
`RWIterable<RegistryEntry>`	`getChildRegistryEntries()`	Get an `RWIterable` over a collection of `ChildRegistryEntries`, the collection will be ordered by Name.
`RegistryEntry`	`getChildRegistryEntryByName(String name)`	Get the RegistryEntry by NameParent.
`String`	`getFullParentPath()`	Query full path to this registry entry.
`Long`	`getNumExtraValueLines()`	Get the value for NumExtraValueLines.
`RegistryEntry`	`getParentRegistryEntry()`	Get the ParentRegistryEntry.
`String`	`getValue()`	Get the value for Value.
`boolean`	`isOverrideAllowed()`	Get the value for OverrideAllowed.
`void`	`setOverrideAllowed(boolean newOverrideAllowed)`	Set the value for OverrideAllowed.
`void`	`setParentRegistryEntry(RegistryEntry newParentRegistryEntry)`	Set the value for ParentRegistryEntry.
`void`	`setValue(String newValue)`	Set the value for Value.

Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject
getBusinessKey

Methods inherited from interface com.redwood.scheduler.api.model.NamedRootObject
createObjectReference, getComment, getDescription, getLinkedObjectReferenceByLinkedObject, getLinkedObjectReferenceByName, getLinkedObjectReferences, getName, getSearchName, getSourceObjectReferences, isHidden, setComment, setDescription, setName

Methods inherited from interface com.redwood.scheduler.api.model.Root
getCreationTime, getLastModificationTime, getLastModifierSubject

- Field Detail
  - OBJECT_TYPE
```
static final String OBJECT_TYPE
```
    String that will be returned from SchedulerEntity.getObjectType() for "RegistryEntry" objects.
    
    See Also:
    
    Constant Field Values
  - TYPE
```
static final QueryObjectType<RegistryEntry> TYPE
```
    Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
  - PATH_SEPARATOR
```
static final String PATH_SEPARATOR
```
    Separator used to separate the hierarchical parts of the path; this character cannot be used in the name of a RegistryEntry.
    
    See Also:
    
    Constant Field Values
  - P_A_MICROSOFT_WINDOWS_LOCAL_INTERPRETER_BITS_PATH
```
static final String P_A_MICROSOFT_WINDOWS_LOCAL_INTERPRETER_BITS_PATH
```
    Whether the default CMD runs as 32 or as 64 bit process on a 64 bit server.
    
    See Also:
    
    Constant Field Values
  - P_A_MICROSOFT_WINDOWS_LOCAL_INTERPRETER_BITS_DEFAULT
```
static final Long P_A_MICROSOFT_WINDOWS_LOCAL_INTERPRETER_BITS_DEFAULT
```
    Whether the default CMD runs as 32 or as 64 bit process on a 64 bit server.
  - SPOOL_RETRIEVAL_PROCESSSERVER_OPTION_PATH
```
static final String SPOOL_RETRIEVAL_PROCESSSERVER_OPTION_PATH
```
    How should the spool retrieval process server option be treated.
    
    See Also:
    
    Constant Field Values
  - ALLOW_SUN_IMPORT_REGISTRY_ENTRY
```
static final String ALLOW_SUN_IMPORT_REGISTRY_ENTRY
```
    If this entry is present and set to true, the import allows the classes that starts with sun.com or sun.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_VIEW
```
static final String SEC_PRIV_VIEW
```
    This privilege can be granted at a group level. This privilege can be granted at an instance level.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_CREATE
```
static final String SEC_PRIV_CREATE
```
    This privilege can be granted at a group level.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_CREATECHILDREN
```
static final String SEC_PRIV_CREATECHILDREN
```
    This privilege can be granted at an instance level.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_EDIT
```
static final String SEC_PRIV_EDIT
```
    This privilege can be granted at a group level. This privilege can be granted at an instance level.
    
    See Also:
    
    Constant Field Values
  - SEC_PRIV_DELETE
```
static final String SEC_PRIV_DELETE
```
    This privilege can be granted at a group level. This privilege can be granted at an instance level.
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_NONE
```
static final String SEC_RANK_NONE
```
    This rank has no privileges assigned to it.
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_VIEW
```
static final String SEC_RANK_VIEW
```
    This rank is made of the following privileges: view
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_OWNER
```
static final String SEC_RANK_OWNER
```
    This rank is made of the following privileges: view , createChildren
    
    See Also:
    
    Constant Field Values
  - SEC_RANK_ALL
```
static final String SEC_RANK_ALL
```
    This rank is made of the following privileges: view , create , createChildren , edit , delete
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isOverrideAllowed
```
boolean isOverrideAllowed()
```
    Get the value for OverrideAllowed. (Whether users can modify the value of this entry themselves.)
    
    Returns:
    
    the field
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - getValue
```
String getValue()
```
    Get the value for Value. (Value of this key stored as textual data.)
    
    Returns:
    
    the field
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - getNumExtraValueLines
```
Long getNumExtraValueLines()
```
    Get the value for NumExtraValueLines. (The number of additional lines that are present for the value attribute.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
    
    Returns:
    
    the field
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - setOverrideAllowed
```
void setOverrideAllowed(boolean newOverrideAllowed)
```
    Set the value for OverrideAllowed. (Whether users can modify the value of this entry themselves.)
    
    Parameters:
    
    newOverrideAllowed - the new value for OverrideAllowed.
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - setValue
```
void setValue(String newValue)
```
    Set the value for Value. (Value of this key stored as textual data.) This value is optional.
    
    Parameters:
    
    newValue - the new value for Value.
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
  - getFullParentPath
```
String getFullParentPath()
```
    Query full path to this registry entry. This builds the full registry path that points to this entry by traversing the parent links.
    
    Returns:
    
    String containing the full registry path to this entry. Each registry key is seperated by the '/' character.
  - getParentRegistryEntry
```
RegistryEntry getParentRegistryEntry()
```
    Get the ParentRegistryEntry.
    
    Returns:
    
    ParentRegistryEntry
    
    Throws:
    
    com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
    
    com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.
  - setParentRegistryEntry
```
void setParentRegistryEntry(RegistryEntry newParentRegistryEntry)
```
    Set the value for ParentRegistryEntry. This value is optional.
    
    Parameters:
    
    newParentRegistryEntry - is the object to set ParentRegistryEntry to. Parent-child relationship for registry entries.
  - getChildRegistryEntries
```
RWIterable<RegistryEntry> getChildRegistryEntries()
```
    Get an RWIterable over a collection of ChildRegistryEntries, the collection will be ordered by Name. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Parent-child relationship for registry entries.
    
    Specified by:
    
    getChildRegistryEntries in interface RegistryEntryComp
    
    Returns:
    
    An RWIterable over a collection of RegistryEntry objects , the collection will be ordered by Name.
  - getChildRegistryEntryByName
```
RegistryEntry getChildRegistryEntryByName(String name)
```
    Get the RegistryEntry by NameParent.
    
    Parameters:
    
    name -
    
    Returns:
    
    the RegistryEntry, or null if it could not be found
  - checkViewPrivilege
```
RequiredPermission checkViewPrivilege()
```
    Check whether or not the view action can be performed on this object.
    
    Returns:
    
    a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
  - checkCreatePrivilege
```
RequiredPermission checkCreatePrivilege()
```
    Check whether or not the create action can be performed on this object.
    
    Returns:
    
    a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
  - checkCreateChildrenPrivilege
```
RequiredPermission checkCreateChildrenPrivilege()
```
    Check whether or not the createChildren action can be performed on this object.
    
    Returns:
    
    a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
  - checkEditPrivilege
```
RequiredPermission checkEditPrivilege()
```
    Check whether or not the edit action can be performed on this object.
    
    Returns:
    
    a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
  - checkDeletePrivilege
```
RequiredPermission checkDeletePrivilege()
```
    Check whether or not the delete action can be performed on this object.
    
    Returns:
    
    a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

Interface RegistryEntry

Field Summary

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

Method Summary

Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject

Methods inherited from interface com.redwood.scheduler.api.model.NamedRootObject

Methods inherited from interface com.redwood.scheduler.api.model.Root

Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

Field Detail

OBJECT_TYPE

TYPE

PATH_SEPARATOR

P_A_MICROSOFT_WINDOWS_LOCAL_INTERPRETER_BITS_PATH

P_A_MICROSOFT_WINDOWS_LOCAL_INTERPRETER_BITS_DEFAULT

SPOOL_RETRIEVAL_PROCESSSERVER_OPTION_PATH

ALLOW_SUN_IMPORT_REGISTRY_ENTRY

SEC_PRIV_VIEW

SEC_PRIV_CREATE

SEC_PRIV_CREATECHILDREN

SEC_PRIV_EDIT

SEC_PRIV_DELETE

SEC_RANK_NONE

SEC_RANK_VIEW

SEC_RANK_OWNER

SEC_RANK_ALL

Method Detail

isOverrideAllowed

getValue

getNumExtraValueLines

setOverrideAllowed

setValue

getFullParentPath

getParentRegistryEntry

setParentRegistryEntry

getChildRegistryEntries

getChildRegistryEntryByName

checkViewPrivilege

checkCreatePrivilege

checkCreateChildrenPrivilege

checkEditPrivilege

checkDeletePrivilege