Package com.redwood.scheduler.api.model

Interface NavigationBarItem

All Superinterfaces:

BusinessKeyObject, Detail, NavigationBarItemComp, Readable, SchedulerEntity, SchedulerEntityComp

public interface NavigationBarItem
extends NavigationBarItemComp, Detail, BusinessKeyObject, Readable

An item that is part of the navigation bar A NavigationBarItem is shown in the navigation bar.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "NavigationBarItem" objects.
static String	SEC_RANK_ALL	This rank is made of the following privileges:
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static QueryObjectType<NavigationBarItem>	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

Modifier and Type	Method	Description
NavigationBarItem	getChildNavigationBarItemByNavigationBarDisplayOrder(NavigationBar navigationBar, Long displayOrder)	Get the NavigationBarItem by NameParent.
RWIterable<NavigationBarItem>	getChildNavigationBarItems()	Get an RWIterable over a collection of ChildNavigationBarItems, the collection will be ordered by DisplayOrder.
Long	getDisplayOrder()	Get the value for DisplayOrder.
String	getIconURL()	Get the value for IconURL.
String	getLinkData()	Get the value for LinkData.
String	getName()	Get the value for Name.
NavigationBar	getNavigationBar()	Get the NavigationBar.
Long	getNumItems()	Get the value for NumItems.
NavigationBarItem	getParentNavigationBarItem()	Get the ParentNavigationBarItem.
String	getSearchName()	Get the value for SearchName.
NavigationBarItemType	getType()	Get the value for Type.
void	setDisplayOrder(Long newDisplayOrder)	Set the value for DisplayOrder.
void	setIconURL(String newIconURL)	Set the value for IconURL.
void	setLinkData(String newLinkData)	Set the value for LinkData.
void	setName(String newName)	Set the value for Name.
void	setParentNavigationBarItem(NavigationBarItem newParentNavigationBarItem)	Set the value for ParentNavigationBarItem.
void	setType(NavigationBarItemType newType)	Set the value for Type.

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

getBusinessKey

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

canPerform, createSubjectObjectPrivilegeGrant, deleteObject, getAuditTrail, getAuditTrailSize, getBehavior, getEffectiveBehavior, getErrorNameEN, getErrorNameKey, getLLPVersion, getLOV, getLOVSupport, getObjectType, getParentSchedulerEntities, getRuntime, getSubjectObjectPrivilegeGrantBySubject, getSubjectObjectPrivilegeGrants, getUniqueId, getUrl, getUrl, isCreated, isDeletable, isDeleted, isModifiable, isModified, isSelectVersioned, processRelatedObjects, processRelatedObjects, processRelatedObjects, refreshObject, resetObject, resetObject, resetValuesToDefault, selectForRead

Field Detail

OBJECT_TYPE

static final String OBJECT_TYPE

String that will be returned from SchedulerEntity.getObjectType() for "NavigationBarItem" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<NavigationBarItem> TYPE

Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges:

See Also:

Constant Field Values

Method Detail

getName

String getName()

Get the value for Name. (Defines the name of the navigation bar item)

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.

getType

NavigationBarItemType getType()

Get the value for Type. (Defines the type of the navigation bar item) 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.

getIconURL

String getIconURL()

Get the value for IconURL. (Defines the icon URL of the navigation bar item)

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.

getLinkData

String getLinkData()

Get the value for LinkData. (Defines the data for creating the action which will be performed when clicked)

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.

getDisplayOrder

Long getDisplayOrder()

Get the value for DisplayOrder. (Defines the order of the item in the group or the order of the group in the group list) 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.

getSearchName

String getSearchName()

Get the value for SearchName. (The internal name, normalized to allow for convenient database searching.)

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.

getNumItems

Long getNumItems()

Get the value for NumItems. (Number of child items.) 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.

setName

void setName(String newName)

Set the value for Name. (Defines the name of the navigation bar item) This value is optional.

Parameters:

newName - the new value for Name.

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.

setType

void setType(NavigationBarItemType newType)

Set the value for Type. (Defines the type of the navigation bar item) This value is mandatory.

Parameters:

newType - the new value for Type. If this is null, then the object cannot be persisted.

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.

setIconURL

void setIconURL(String newIconURL)

Set the value for IconURL. (Defines the icon URL of the navigation bar item) This value is optional.

Parameters:

newIconURL - the new value for IconURL.

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.

setLinkData

void setLinkData(String newLinkData)

Set the value for LinkData. (Defines the data for creating the action which will be performed when clicked) This value is optional.

Parameters:

newLinkData - the new value for LinkData.

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.

setDisplayOrder

void setDisplayOrder(Long newDisplayOrder)

Set the value for DisplayOrder. (Defines the order of the item in the group or the order of the group in the group list) This value is mandatory.

Parameters:

newDisplayOrder - the new value for DisplayOrder. If this is null, then the object cannot be persisted.

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.

getNavigationBar

NavigationBar getNavigationBar()

Get the NavigationBar.

Returns:

NavigationBar

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.

getParentNavigationBarItem

NavigationBarItem getParentNavigationBarItem()

Get the ParentNavigationBarItem.

Returns:

ParentNavigationBarItem

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.

setParentNavigationBarItem

void setParentNavigationBarItem(NavigationBarItem newParentNavigationBarItem)

Set the value for ParentNavigationBarItem. This value is optional.

Parameters:

newParentNavigationBarItem - is the object to set ParentNavigationBarItem to. Parent-child relationship for navigation bar items.

getChildNavigationBarItems

RWIterable<NavigationBarItem> getChildNavigationBarItems()

Get an RWIterable over a collection of ChildNavigationBarItems, the collection will be ordered by DisplayOrder. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Parent-child relationship for navigation bar items.

Specified by:

getChildNavigationBarItems in interface NavigationBarItemComp

Returns:

An RWIterable over a collection of NavigationBarItem objects , the collection will be ordered by DisplayOrder.

getChildNavigationBarItemByNavigationBarDisplayOrder

NavigationBarItem getChildNavigationBarItemByNavigationBarDisplayOrder(NavigationBar navigationBar,
                                                                       Long displayOrder)

Get the NavigationBarItem by NameParent.

Parameters:

navigationBar -

displayOrder -

Returns:

the NavigationBarItem, or null if it could not be found