Package com.thingworx.navigation

Class Menu

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.navigation.Menu

All Implemented Interfaces:

ISupportsAccessModifier, IConfigurableObject, INotScriptFriendly, ISupportsDeprecation, IDiffableObject, IAvatar, IEntityLifeCycleEvent, IPersistable, IServiceProvider, ITaggableObject, IDependencyScannableObject, IEntityDefinition, IPersistableObject<String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, Serializable

@ThingworxExtensionApiClass(since={7,0,3},
                            canInstantiate=true)
public class Menu
extends ServiceProviderEntity
implements ISupportsAccessModifier

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LINKTYPE_HYPERLINK
static final String	LINKTYPE_MASHUP
static final String	LINKTYPE_MENU

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTY_DEFINITIONS, EXCLUDED_ENTITY_TYPES_IN_PROJECT

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
Menu()

Method Summary

Modifier and Type	Method	Description
EntityReferenceCollection	getAllGroupReferences()
InfoTable	GetEffectiveMenu()	Service Category: MenuItems Service Description: Get menu items for the current user.
RelationshipTypes.ThingworxRelationshipTypes	getEntityType()
EntityReferenceCollection	getGroups()
String	getImageURL()
MenuItemCollection	getMenuItems()
InfoTable	GetMenuItems()	Service Category: MenuItems Service Description: Get menu items for this menu.
String	getMenuLabel()
InfoTable	toInfoTable()
void	UpdateGroups(org.json.JSONObject groupReferences, org.json.JSONObject menuItems)

Methods inherited from class com.thingworx.entities.ServiceProviderEntity

getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, initializeEntity, preInitializeEntity, processAPIServiceRequest, processServiceRequest

Methods inherited from class com.thingworx.entities.RootEntity

AddConfigurationTableDefinition, AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, DeleteConfigurationTableRows, DeleteConfigurationTableRows, deleteDesignTimePermission, DeleteDesignTimePermission, deleteRunTimePermission, DeleteRunTimePermission, deleteVisibilityPermission, DeleteVisibilityPermission, dispose, getAspects, GetAvatar, getAvatarContent, GetAvatarURL, GetConfigurationChangeHistory, getConfigurationSetting, getConfigurationTable, GetConfigurationTable, GetConfigurationTableDefinition, GetConfigurationTableRow, GetConfigurationTables, GetDescription, getDesignTimePermissions, GetDesignTimePermissions, GetDesignTimePermissionsAsJSON, getDocumentationContent, getEntityTypeAsString, GetEventDefinition, GetEventDefinitions, GetHomeMashup, GetIncomingDependencies, GetIncomingDependenciesAsNetwork, GetInstanceMetadataAsJSON, GetInstanceMetadataWithPermissionsAsJSON, GetLastModifiedDate, GetMetadata, GetMetadataAsJSON, GetMetadataWithPermissionsAsJSON, GetOutgoingDependencies, GetOutgoingDependenciesAsNetwork, getOwner, GetOwner, GetPermissionsForCurrentUser, GetPermissionsForGroup, GetPermissionsForUser, GetProjectName, GetPropertyDefinition, GetPropertyDefinitions, getRunTimePermissions, GetRunTimePermissions, GetRunTimePermissionsAsJSON, GetServiceDefinition, GetServiceDefinitions, getStringConfigurationSetting, getStringConfigurationSettingWithDefault, GetSummaryInformation, getTags, GetTags, GetTagsAsInfoTable, getVisibilityPermissions, GetVisibilityPermissions, GetVisibilityPermissionsAsJSON, HasIncomingDependencies, HasOutgoingDependencies, isEditable, isEditableExtensionObject, isEditableSystemObject, isExtensionObject, IsMultiRowTable, isOwner, isSystemObject, isThemeObject, isVisible, isVisible, ListDeprecatedUsage, persistDesignTimePermissions, persistRunTimePermissions, persistVisibilityPermissions, RemoveTags, SaveConfigurationTables, SetAvatar, setConfigurationSetting, SetConfigurationTable, SetConfigurationTableRows, SetDescription, setDesignTimePermissions, SetDesignTimePermissionsAsJSON, setDocumentationContent, setExtensionObject, SetHomeMashup, setLastModifiedDate, SetMultiRowConfigurationTable, setOwner, SetOwner, SetProjectName, setRunTimePermissions, SetRunTimePermissionsAsJSON, setStringConfigurationSetting, SetTags, setVisibilityPermissions, SetVisibilityPermissionsAsJSON, toJSON, toJSONDefinition, UpdateProjectDependencies, validateConfiguration

Methods inherited from class com.thingworx.persistence.common.PersistableNamedObject

getID, hasID, isTransient

Methods inherited from class com.thingworx.types.NamedObject

getDescription, getName, setDescription, setName, toValueCollection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.thingworx.types.INamedObject

getDescription, getName

Methods inherited from interface com.thingworx.entities.interfaces.IPersistable

getID, hasID

Methods inherited from interface com.thingworx.security.permissions.ISecurable

getID, getName

Methods inherited from interface com.thingworx.accesscontrol.ISupportsAccessModifier

getAccessModifier, getAccessModifierScope, getExemptList, hasAccessModifier, isInternalAccess, isPrivateAccess, isRestrictedAccess

Methods inherited from interface com.thingworx.deprecation.ISupportsDeprecation

getDeprecated, isDeprecated, isDeprecatedBefore, since

Field Details

LINKTYPE_MENU

public static final String LINKTYPE_MENU

See Also:

• Constant Field Values

LINKTYPE_MASHUP

public static final String LINKTYPE_MASHUP

See Also:

• Constant Field Values

LINKTYPE_HYPERLINK

public static final String LINKTYPE_HYPERLINK

See Also:

• Constant Field Values

Constructor Details

Menu

public Menu()

Method Details

getMenuLabel

@ThingworxExtensionApiMethod(since={7,0,3})
public String getMenuLabel()

getImageURL

@ThingworxExtensionApiMethod(since={7,0,3})
public String getImageURL()

getGroups

@ThingworxExtensionApiMethod(since={7,0,3})
public EntityReferenceCollection getGroups()

getAllGroupReferences

@ThingworxExtensionApiMethod(since={7,0,3})
public EntityReferenceCollection getAllGroupReferences()

getMenuItems

@ThingworxExtensionApiMethod(since={7,0,3})
public MenuItemCollection getMenuItems()

GetMenuItems

@ThingworxExtensionApiMethod(since={7,0,3})
public InfoTable GetMenuItems()
                       throws Exception

Service Category:

MenuItems

Service Description:

Get menu items for this menu.

Returns:

MenuItems Menu items - INFOTABLE - Aspects {dataShape:MenuEntry}

Throws:

Exception - If an error occurs

GetEffectiveMenu

@ThingworxExtensionApiMethod(since={7,0,3})
public InfoTable GetEffectiveMenu()
                           throws Exception

Service Category:

MenuItems

Service Description:

Get menu items for the current user.

Returns:

MenuItems Menu items - INFOTABLE - Aspects {dataShape:MenuEntry}

Throws:

Exception - If an error occurs

UpdateGroups

@ThingworxExtensionApiMethod(since={7,0,3})
public void UpdateGroups(org.json.JSONObject groupReferences,
 org.json.JSONObject menuItems)
                  throws Exception

Parameters:

groupReferences - Group Associations - JSON

menuItems - Menu Items - JSON

Throws:

Exception - If an error occurs

toInfoTable

@ThingworxExtensionApiMethod(since={7,0,3})
public InfoTable toInfoTable()

getEntityType

@ThingworxExtensionApiMethod(since={7,0,3})
public RelationshipTypes.ThingworxRelationshipTypes getEntityType()

Description copied from class: RootEntity

Returns the type of this entity.

Specified by:

getEntityType in class RootEntity

Returns:

the entity type