gran.app.adapter.kernel.udf
Interface UDFAdapter

All Superinterfaces:
Adapter, KernelAdapter
All Known Implementing Classes:
BaseUDFAdapter

public interface UDFAdapter
extends KernelAdapter

This adapter useful for UDF processing


Method Summary
 java.lang.String addUDFImpl(java.lang.String sourceid, java.lang.String caption, java.lang.String order, java.lang.String def, java.lang.String ul, java.lang.String required, java.lang.String type, java.lang.String visible, java.lang.String mail, java.lang.String formulaLongtext)
          create new UDF
 void addULImpl(java.lang.String udfid, java.lang.String val)
          Add value to list
 void deleteUDFsImpl(java.lang.String[] udfids)
          Delete UDF
 void deleteULsImpl(java.lang.String[] udfids)
          Delete one or more udflist item
 java.lang.String getUDFSourceImpl(java.lang.String id, int mode, java.lang.String result)
          select udfsource_id for task, workflow or user.
 java.util.HashMap getUDFValuesImpl(java.lang.String id, int mode, java.util.Collection udfs, java.util.HashMap result)
          Return HashMap of UDF values (key - UDF id)
 java.util.Collection listUDFImpl(java.lang.String idUDF, int modeUDF, java.util.Collection result)
          List all UDF for specified idUDF mode = 0 - id is sourceid mode = 1 - id is taskid, list all for this taskid and it's parents mode = 2 - id is userid, list all for this userid and it's managers mode =3 - id is taskid, list all for this taskid and it's parents.
 void setUDFValueImpl(java.lang.String udfid, java.lang.String sourceid, int mode, java.lang.String value, java.lang.Integer udftype)
          set value for selected udf and source.
 void updateUDFImpl(java.lang.String id, java.lang.String caption, java.lang.String order, java.lang.String def, java.lang.String required, java.lang.String visible, java.lang.String mail, java.lang.String formula)
          Update UDF description
 void updateULImpl(java.lang.String id, java.lang.String value)
          Update UDF list value
 
Methods inherited from interface gran.app.adapter.Adapter
getDescription, init
 

Method Detail

getUDFSourceImpl

public java.lang.String getUDFSourceImpl(java.lang.String id,
                                         int mode,
                                         java.lang.String result)
                                  throws gran.exception.GranException
select udfsource_id for task, workflow or user. If udfsource not exists - create it.

Parameters:
id - id of task or user
mode -
  • 1,3 - get udfsource for task
  • 2,4 - get udfsource for user
  • 5,6 - get udfsource for workflow
Throws:
gran.exception.GranException

addUDFImpl

public java.lang.String addUDFImpl(java.lang.String sourceid,
                                   java.lang.String caption,
                                   java.lang.String order,
                                   java.lang.String def,
                                   java.lang.String ul,
                                   java.lang.String required,
                                   java.lang.String type,
                                   java.lang.String visible,
                                   java.lang.String mail,
                                   java.lang.String formulaLongtext)
                            throws gran.exception.GranException
create new UDF

Parameters:
sourceid - -udfsource_id
caption - - name
order - - order.
def - -default value
ul - - id of list of available values
required - - required or not
type - - value type
visible - - visible or not
mail - - include field in email notification
Throws:
gran.exception.GranException

deleteUDFsImpl

public void deleteUDFsImpl(java.lang.String[] udfids)
                    throws gran.exception.GranException
Delete UDF

Throws:
gran.exception.GranException

setUDFValueImpl

public void setUDFValueImpl(java.lang.String udfid,
                            java.lang.String sourceid,
                            int mode,
                            java.lang.String value,
                            java.lang.Integer udftype)
                     throws gran.exception.GranException
set value for selected udf and source. Value will be converted from string to required type

Parameters:
udfid - - UDF identifier
sourceid - - UDFSource identifier
value - - value
udftype - - type of UDF value
Throws:
gran.exception.GranException

listUDFImpl

public java.util.Collection listUDFImpl(java.lang.String idUDF,
                                        int modeUDF,
                                        java.util.Collection result)
                                 throws gran.exception.GranException
List all UDF for specified idUDF

Throws:
gran.exception.GranException

getUDFValuesImpl

public java.util.HashMap getUDFValuesImpl(java.lang.String id,
                                          int mode,
                                          java.util.Collection udfs,
                                          java.util.HashMap result)
                                   throws gran.exception.GranException
Return HashMap of UDF values (key - UDF id)

Throws:
gran.exception.GranException

updateUDFImpl

public void updateUDFImpl(java.lang.String id,
                          java.lang.String caption,
                          java.lang.String order,
                          java.lang.String def,
                          java.lang.String required,
                          java.lang.String visible,
                          java.lang.String mail,
                          java.lang.String formula)
                   throws gran.exception.GranException
Update UDF description

Throws:
gran.exception.GranException

updateULImpl

public void updateULImpl(java.lang.String id,
                         java.lang.String value)
                  throws gran.exception.GranException
Update UDF list value

Throws:
gran.exception.GranException

deleteULsImpl

public void deleteULsImpl(java.lang.String[] udfids)
                   throws gran.exception.GranException
Delete one or more udflist item

Throws:
gran.exception.GranException

addULImpl

public void addULImpl(java.lang.String udfid,
                      java.lang.String val)
               throws gran.exception.GranException
Add value to list

Parameters:
udfid - - identifier of list UDF
val - - added value
Throws:
gran.exception.GranException


Copyright © 2002-2003 TrackStudio, Ltd. All Rights Reserved.