##############################################################################
#
# Copyright (c) 2007-2008 Nexedi SA and Contributors. All Rights Reserved.
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

from AccessControl import ClassSecurityInfo
from Products.ERP5Type.Globals import InitializeClass
from DocumentationHelper import DocumentationHelper
from Products.ERP5Type import Permissions

class DCWorkflowTransitionDocumentationHelper(DocumentationHelper):
  """
    Provides documentation about a workflow transition
  """
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

  security.declareProtected(Permissions.AccessContentsInformation, 'getType')
  def getType(self):
    """
    Returns the type of the documentation helper
    """
    return "Workflow Transition"

  security.declareProtected(Permissions.AccessContentsInformation, 'getTitle')
  def getTitle(self):
    """
    Returns the title of the documentation helper
    """
    return DocumentationHelper.getTitle(self) or getattr(self.getDocumentedObject(), 'actbox_name')

  security.declareProtected(Permissions.AccessContentsInformation, 'getNewState')
  def getNewState(self):
    """
    """
    new_state_id = self.getDocumentedObject().new_state_id
    if new_state_id:
      uri = '%s/states/%s' % (self.uri.rsplit('/',2)[0], new_state_id)
      return self.getDocumentationHelper('DCWorkflowStateDocumentationHelper', uri)


  security.declareProtected(Permissions.AccessContentsInformation, 'getTriggerType')
  def getTriggerType(self):
    """
    Returns the trigger type for de workflow transition
    """
    trigger_type_list = ['Automatic','Initiated by user action','Initiated by WorkflowMethod']
    trigger_type_id = getattr(self.getDocumentedObject(), "trigger_type")
    return trigger_type_list[trigger_type_id]

  security.declareProtected(Permissions.AccessContentsInformation, 'getScriptName')
  def getScriptName(self):
    """
    Returns the name of the script for de workflow transition
    """
    return getattr(self.getDocumentedObject(), "script_name")

  security.declareProtected(Permissions.AccessContentsInformation, 'getAfterScriptName')
  def getAfterScriptName(self):
    """
    Returns the name of the script for de workflow transition
    """
    return getattr(self.getDocumentedObject(), "after_script_name")

  security.declareProtected(Permissions.AccessContentsInformation, 'getRoleColumnList')
  def getRoleColumnList(self):
    """
    """
    return self.getDocumentationHelper('DCWorkflowDocumentationHelper',
                                       self.uri.rsplit('/',2)[0]) \
               .getRoleColumnList()

  security.declareProtected(Permissions.AccessContentsInformation, 'getAvailableStateIds')
  def getStateItemList(self, **kw):
    """
    Returns available states in the workflow
    """
    workflow_uri, transitions, transition_id = self.uri.rsplit('/',2)
    helper = self.getDocumentationHelper('DCWorkflowDocumentationHelper', workflow_uri)
    return [state for state in helper.getStateItemList(**kw)
                  if transition_id in state.getDocumentedObject().transitions]

  security.declareProtected(Permissions.AccessContentsInformation, 'getGuardRoles')
  def getGuardRoles(self):
    """
    Returns roles to pass this transition
    """
    guard = getattr(self.getDocumentedObject(), 'guard', None)
    if guard is not None:
      return ', '.join(sorted(guard.roles))

InitializeClass(DCWorkflowTransitionDocumentationHelper)
