AIP related objects

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

This document describes the data model entities used to represent assets and their associated attributes within AIP.

On this page: 1 Core entities 1.1 JipInventory 1.2 JipInventoryItem 1.3 JipAttribute 1.4 JipFormAttribute 1.5 JipAttributeValue 1.6 JipForm

On this page: 1 Core entities 1.1 JipInventory 1.2 JipInventoryItem 1.3 JipAttribute 1.4 JipFormAttribute 1.5 JipAttributeValue 1.6 JipForm

Core entities

JipInventory

The main class of asset object. Related classes are listed on this page. The asset object is injected into the Groovy script.

package inventoryplugin.entity;

import net.java.ao.Entity;
import net.java.ao.Implementation;
import net.java.ao.OneToMany;
import net.java.ao.Preload;
import net.java.ao.schema.Indexed;
import net.java.ao.schema.StringLength;

import java.util.Date;

@Preload
@Implementation(JipInventoryImpl.class)
public interface JipInventory extends Entity {
   @Indexed
   JipForm getForm();
   @Indexed
   void setForm(JipForm form);
   
   int getSortOrder();
   void setSortOrder(int value);
   
   @Indexed
   String getName();
   @Indexed
   void setName(String name);
   
   @Indexed
   String getCustomfieldId();
   @Indexed
   void setCustomfieldId(String customfieldId);
   
   @Indexed
   Long getOptionId();
   @Indexed
   void setOptionId(Long optionId);

   @Indexed
   Date getCreated();
   @Indexed
   void setCreated(Date created);

   String getCreator();
   void setCreator(String creator);

   @StringLength(StringLength.UNLIMITED)
   String getAttachments();
   @StringLength(StringLength.UNLIMITED)
   void setAttachments(String value);

   @OneToMany
   public JipInventoryItem[] getInventoryItems();
}

JipInventoryItem

Attribute values of an asset.

package inventoryplugin.entity;

import net.java.ao.Entity;
import net.java.ao.Preload;
import net.java.ao.schema.StringLength;

@Preload
public interface JipInventoryItem extends Entity {
   JipFormAttribute getFormAttribute();
   void setFormAttribute(JipFormAttribute formAttribute);

   @StringLength(StringLength.UNLIMITED)
   String getValue();
   @StringLength(StringLength.UNLIMITED)
   void setValue(String value);

   void setInventory(JipInventory inventory);
   JipInventory getInventory();
}

JipAttribute

Attribute definition class.

Attribute Type Names: DropdownList, ListBox, ListBoxMultiple, Text, TextArea, RadioButtonList, CheckboxList, DatePicker, DatetimePicker, UserPicker, InventoryList, InventoryListByForm, IP, IPv6, URL.

package inventoryplugin.entity;

import net.java.ao.Entity;
import net.java.ao.Implementation;
import net.java.ao.OneToMany;
import net.java.ao.Preload;
import net.java.ao.schema.Indexed;

@Preload
@Implementation(JipAttributeImpl.class)
public interface JipAttribute extends Entity {
   @Indexed
   String getAttributeName();
   @Indexed
   void setAttributeName(String name);
   
   String getAttributeType();
   void setAttributeType(String value);
   
   String getPattern();
   void setPattern(String pattern);
   
   @OneToMany//(reverse = "getAttribute") comes with 0.22.1 version
   public JipAttributeValue[] getAttributeValues(); 
}

JipFormAttribute

Attributes of a form.

JipAttributeValue

Values (options) of an attribute.

JipForm

Main form class.