diff --git a/app/models/hyrax/workflow_action_info.rb b/app/models/hyrax/workflow_action_info.rb index 26e94f832e..58236831ed 100644 --- a/app/models/hyrax/workflow_action_info.rb +++ b/app/models/hyrax/workflow_action_info.rb @@ -1,7 +1,23 @@ # frozen_string_literal: true module Hyrax + ## # A simple data object for holding a user, work and their workflow proxies + # + # this is a glorified Struct that resolves +Sipity::Enitity(work)+ + # and +Sipity::Agent(user)+ for the input given, then provides readers + # for its instance variables. + # + # @example + # info = WorkflowActionInfo.new(my_work, current_user) + # + # info.agent # => # + # info.entity # => # + # info.work == my_work # => true + # info.user == current_user # => true class WorkflowActionInfo + ## + # @param work [Object] + # @param user [::User] def initialize(work, user) @work = work @user = user