Uses of Interface
com.almworks.jira.structure.api.structure.Structure

Packages that use Structure

Package	Description
com.almworks.jira.structure.api	This package and subpackages contain Structure API, which can be used to integrate with and extend Structure add-on for JIRA.
com.almworks.jira.structure.api.structure	This package features StructureManager service, which is used to create structures and change their properties (but not the forest), and Structure interface, which represents structures.
com.almworks.jira.structure.api.structure.favorite
com.almworks.jira.structure.api.template
com.almworks.jira.structure.api.view

Uses of Structure in com.almworks.jira.structure.api

Methods in com.almworks.jira.structure.api that return types with arguments of type Structure

Modifier and Type	Method	Description
Comparator<Structure>	StructurePluginHelper.getStructureComparator(ApplicationUser user)	Returns comparator for sorting structures by name, according to the given user's locale.

Uses of Structure in com.almworks.jira.structure.api.structure

Methods in com.almworks.jira.structure.api.structure that return Structure

Modifier and Type	Method	Description
Structure	StructureManager.copyStructure(Long structureId, ApplicationUser newOwner, boolean copyPermissions)	Copies the structure and the forest it contains into a new structure.
Structure	StructureManager.copyStructureWithoutForest(Long structureId, ApplicationUser newOwner, boolean copyPermissions)	Copies the structure into a new structure - only the properties (such as name, description, permissions) are copied, not the forest.
Structure	StructureManager.createStructure()	Creates an empty new structure.
Structure	StructureManager.getStructure(Long structureId, PermissionLevel requiredLevel)	Retrieves a structure given structure ID.
Structure	Structure.saveChanges()	Call this method to save the changes made with set... methods and update the database.
Structure	Structure.setArchived(boolean archived)	Changes the archived flag.
Structure	Structure.setDescription(String description)	Sets the description of the structure.
Structure	Structure.setEditRequiresParentIssuePermission(boolean flag)	Changes the security flag that requires the user to have Edit Issue permission on parent issues of the issues being moved, added or deleted from structure.
Structure	Structure.setName(String name)	Sets the name of the structure.
default Structure	Structure.setOwner(ApplicationUser owner)	Sets the owner of the structure.
Structure	Structure.setOwnerUserKey(String ownerUserKey)	Sets the owner of the structure.
Structure	Structure.setPermissions(Collection<? extends PermissionRule> permissions)	Sets the permission rules for this structure.

Methods in com.almworks.jira.structure.api.structure that return types with arguments of type Structure

Modifier and Type	Method	Description
List<Structure>	StructureManager.getAllStructures(PermissionLevel requiredLevel)	Retrieves a list of all unarchived structures that are accessible to the current user at the specified permission level.
List<Structure>	StructureManager.getAllStructures(PermissionLevel requiredLevel, boolean includeArchived)	Retrieves a list of all structures that are visible to the current user at the specified permission level.
List<Structure>	StructureManager.getArchivedStructures(PermissionLevel requiredLevel)	Retrieves a list of all archived structures that are visible to the current user at the specified permission level.
List<Structure>	StructureManager.getStructuresByName(String name, PermissionLevel requiredLevel)	Convenience method to search for unarchived structures with the specified name.
List<Structure>	StructureManager.getStructuresByName(String name, PermissionLevel requiredLevel, boolean searchArchivedStructures)	Convenience method that searches for structures with the specified name.
List<Structure>	StructureManager.getStructuresOwnedBy(ApplicationUser user)	Retrieves a list of all structures visible to the current user, for which the specified user is the owner.
List<Structure>	StructureManager.getViewableStructuresWithIssue(Long issueId)	Retrieves all structures that contain the specified issue.

Uses of Structure in com.almworks.jira.structure.api.structure.favorite

Methods in com.almworks.jira.structure.api.structure.favorite that return types with arguments of type Structure

Modifier and Type	Method	Description
List<Structure>	StructureFavoriteManager.filterByPopularity(List<Structure> structures, int minPopularity, int maxPopularity)	Filters a list of structures, producing another list with structures that match popularity criteria, defined by minimum and maximum popularity.
List<Structure>	StructureFavoriteManager.getFavorites(ApplicationUser user)	Returns a list of unarchived structures that are the user's favorite and that the user is allowed to see.
List<Structure>	StructureFavoriteManager.getFavorites(ApplicationUser user, boolean includeArchivedStructures)	Returns a list of structures that are the user's favorite and that the user is allowed to see.

Method parameters in com.almworks.jira.structure.api.structure.favorite with type arguments of type Structure

Modifier and Type	Method	Description
List<Structure>	StructureFavoriteManager.filterByPopularity(List<Structure> structures, int minPopularity, int maxPopularity)	Filters a list of structures, producing another list with structures that match popularity criteria, defined by minimum and maximum popularity.
void	StructureFavoriteManager.sortByPopularity(List<Structure> structures, ApplicationUser user)	Sorts a list of structures by their popularity (descending).

Uses of Structure in com.almworks.jira.structure.api.template

Methods in com.almworks.jira.structure.api.template with parameters of type Structure

Modifier and Type	Method	Description
void	EmptyTemplate.configureNewStructure(Structure structure, Map<String,Object> params)
void	NewStructureTemplate.configureNewStructure(Structure structure, Map<String,Object> params)
default String	NewStructureTemplate.prepareNewStructureUrl(Structure structure)

Uses of Structure in com.almworks.jira.structure.api.view

Methods in com.almworks.jira.structure.api.view that return types with arguments of type Structure

Modifier and Type	Method	Description
List<Structure>	StructureViewManager.getAssociatedStructures(Long viewId)	Retrieves all structures that are "associated" with the specified view, i.e.