NAME
JIRA::REST::Class::Iterator - A helper class for JIRA::REST::Class that represents a JIRA query as an object. Allows the user to iterate over the results and retrieve them one by one. Wraps JIRA::REST's set_search_iterator and next_issue methods to make them a bit more object-like.
VERSION
version 0.12
METHODS
issue_count
A count of the number of issues matched by the query.
next
The next issue returned by the query, as a JIRA::REST::Class::Issue object. If there are no more issues matched by the query, this method returns an undefined value.
If the "restart_if_lt_total" method is set to true and the number of issues fetched is less than the total number of issues matched by the query (see the "issue_count" method), this method will rerun the query and keep returning issues. This is particularly useful if you are transforming a number of issues through an iterator, and the transformation causes the issues to no longer match the query.
restart_if_lt_total
This getter/setter method tells the iterator whether to restart the search if the number of issues found is less than the issue count returned by the initial search.
INTERNAL METHODS
_get_next_unseen_issue
Method to consolidate code that fetches issues without duplication
set_search_iterator
Method that is used to restart a query that has run out of results prematurely.
RELATED CLASSES
AUTHOR
Packy Anderson <packy@cpan.org>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2017 by Packy Anderson.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)