API Changes in Structure 2.9

1. Minor Java API Release

With this release we add a few new methods to the Java API. The changes are backwards-compatible.

See Structure API Versions for full version information and downloads.

2. Compatible Changes in the Java API

Most of the API changes in this version support the new ability to archive structures. There also a few other changes as well.

2.1. New methods in Structure

• setArchived(boolean)

• isArchived()

2.2. New constant in StructureError

• ARCHIVED_STRUCTURE_EDIT_DENIED

2.3. New method in StructureFavoriteManager

We've added an overload to method getFavorites(User):

• getFavorites(User, boolean includeArchivedStructures)

Note that getFavorites(User) doesn't include archived structures in the result.

2.4. New methods in StructureManager

We've added overloads to some methods that return a list of structures by adding a flag to include archived structures in the result. Note that the original methods do not include archived structures in the result.

• getAllStructures(User, PermissionLevel, boolean, boolean includeArchived)

• getStructuresByName(String, User, PermissionLevel, boolean, boolean includeArchived)

• hasStructuresForUser(User user, PermissionLevel, boolean includeArchived)

Note that the existing method, getRecentlyUpdatedStructures(User, PermissionLevel, int), doesn't include archived structures in the result.

We have also added a new method:

• isArchived(Long)

2.5. New constant in StructurePage

To support viewing issue details on the structure board, we've added a new page type:

• STRUCTURE_BOARD_WITH_DETAILS

2.6. Changed constants in ViewSettings

Another change to support viewing issue details on the structure board — we've updated the following constants to include the new structure page type:

• ALL_PAGES

• PAGES_WITH_DEFAULT_VIEW