Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

AipUtils

...

Panel
panelIconIdatlassian-info
panelIcon:info:
panelIconText:info:
bgColor#F4F5F7

This page is about Assets & Inventory Plugin for Jira DC. Using Cloud? Click here.

These are the utility functions to use during the post function execution. Please read Java Docs

Tip

For more information, read the Java documentation of the methods.

Code Block
languagejava
package inventoryplugin.workflow.function.tools;

import inventoryplugin.entity.JipInventory;
import inventoryplugin.entity.JipInventoryItem;

import java.util.List;

public interface AipUtils {
    /**
     * Get asset attribute by name
     * @param asset - current asset JipInventory object
     * @param attributeName - name of the attribute name to look for
     * @return attribute instance of JipInventoryItem type
     */
    JipInventoryItem getAssetAttributeByName(JipInventory asset, String attributeName);

    /**
     * Get asset attribute by id
     * @param asset - current asset JipInventory object
     * @param attributeId - name of the attribute id to look for
     * @return attribute instance of JipInventoryItem type
     */
    JipInventoryItem getAssetAttributeById(JipInventory asset, Integer attributeId);

    /**
     * Get attribute value as string by name
     * @param asset - current asset JipInventory object
     * @param attributeName - name of the attribute name to look for
     * @return attribute value as String
     */
    String getAttributeValueAsStringByName(JipInventory asset, String attributeName);

    /**
     * Get attribute value as string by id
     * @param asset - current asset JipInventory object
     * @param attributeId - name of the attribute id to look for
     * @return attribute value as String
     */
    String getAttributeValueAsStringById(JipInventory asset, Integer attributeId);

    /**
     * get multi attribute value as List by name
     * @param asset - current asset JipInventory object
     * @param attributeName - name of the attribute name to look for
     * @return List of String
     */
    List<String> getMultiAttributeValueAsListByName(JipInventory asset, String attributeName);

    /**
     * get multi attribute value as List by name
     * @param asset - current asset JipInventory object
     * @param attributeId - name of the attribute id to look for
     * @return List of String
     */
    List<String> getMultiAttributeValueAsListById(JipInventory asset, Integer attributeId);

    /**
     * get system field value by system field name
     * @param asset - current asset JipInventory object
     * @param systemFieldName - name of the system field look for
     * @return system field value as String
     */
    String getAssetSystemField(JipInventory asset, String systemFieldName);
}