AR System Java API

com.bmc.arsys.api
Class StructItemInfo

java.lang.Object
  extended by com.bmc.arsys.api.StructItemInfo
All Implemented Interfaces:
Serializable, Cloneable

public class StructItemInfo
extends Object
implements Cloneable, Serializable

The StructItemInfo class represents a particular object to export or import.

See Also:
Serialized Form

Field Summary
static int ACTIVE_LINK
          Active link definition
static int ADMIN_EXT
          No longer supported.
static int APPLICATION
          Definition of Applications.
static int CHAR_MENU
          Character menu definition
static int CONTAINER
          Container definition
static int DIST_MAP
          Mapping definition for Distributed Server Option
static int DIST_POOL
          Distributed pools definition.
static int ESCALATION
          Escalation definition
static int FIELD
           
static int FILTER
          Filter definition
static int IMAGE
          Image Definition
static int SCHEMA
          Form definition, including views, help text, and change diary information
static int SCHEMA_DATA
          Form data
static int SCHEMA_DEFN
          Structure definition for configuring Remedy User cache (special purpose export)
static int SCHEMA_MAIL
          Email template for submitting requests (special purpose export)
static int SCHEMA_VIEW
          Display definition for configuring Remedy User cache (special purpose export)
static int SCHEMA_VIEW_MIN
          Display definition without bitmaps for Remedy User
static int VUI
          Definition of single VUI.
static int VUI_2
          Definition of all VUIs instead of just one.
 
Constructor Summary
StructItemInfo()
           
StructItemInfo(IARPersistentObject obj)
           
StructItemInfo(IARPersistentObject obj, boolean asXml)
           
StructItemInfo(int type, String name)
           
StructItemInfo(int type, String name, String[] selectedElements)
           
StructItemInfo(int type, String name, String[] selectedElements, int exportOption)
           
 
Method Summary
 Object clone()
          Clone implementation that returns an Object with data cloned from self.
 boolean equals(Object obj)
          Use this method for checking equality between the current object and the provided one.
 int getExportOption()
          Returns export options associated with the AR System object.
 String getName()
          Returns name associated with the AR System object.
 String[] getSelectedElements()
          Returns list of selected elements.
 int getType()
          Returns integer value indicating the type of AR System object.
 int hashCode()
          Returns the hash code value for this instance of the current class.
 void setExportOption(int exportOption)
          Sets the export option of the AR System object
 void setName(String name)
          Sets the name of the AR System object
 void setSelectedElements(String[] elements)
          Sets the list of selected elements
 void setType(int type)
          Sets the type of the AR System object
 String toString()
          Returns a string description of the object.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

SCHEMA

public static final int SCHEMA
Form definition, including views, help text, and change diary information

See Also:
Constant Field Values

FIELD

public static final int FIELD
See Also:
Constant Field Values

SCHEMA_DEFN

public static final int SCHEMA_DEFN
Structure definition for configuring Remedy User cache (special purpose export)

See Also:
Constant Field Values

SCHEMA_VIEW

public static final int SCHEMA_VIEW
Display definition for configuring Remedy User cache (special purpose export)

See Also:
Constant Field Values

SCHEMA_DATA

public static final int SCHEMA_DATA
Form data

See Also:
Constant Field Values

SCHEMA_MAIL

public static final int SCHEMA_MAIL
Email template for submitting requests (special purpose export)

See Also:
Constant Field Values

FILTER

public static final int FILTER
Filter definition

See Also:
Constant Field Values

ACTIVE_LINK

public static final int ACTIVE_LINK
Active link definition

See Also:
Constant Field Values

ADMIN_EXT

public static final int ADMIN_EXT
No longer supported.

See Also:
Constant Field Values

CHAR_MENU

public static final int CHAR_MENU
Character menu definition

See Also:
Constant Field Values

ESCALATION

public static final int ESCALATION
Escalation definition

See Also:
Constant Field Values

DIST_MAP

public static final int DIST_MAP
Mapping definition for Distributed Server Option

See Also:
Constant Field Values

SCHEMA_VIEW_MIN

public static final int SCHEMA_VIEW_MIN
Display definition without bitmaps for Remedy User

See Also:
Constant Field Values

CONTAINER

public static final int CONTAINER
Container definition

See Also:
Constant Field Values

DIST_POOL

public static final int DIST_POOL
Distributed pools definition.

See Also:
Constant Field Values

VUI

public static final int VUI
Definition of single VUI.

See Also:
Constant Field Values

VUI_2

public static final int VUI_2
Definition of all VUIs instead of just one.

See Also:
Constant Field Values

IMAGE

public static final int IMAGE
Image Definition

See Also:
Constant Field Values

APPLICATION

public static final int APPLICATION
Definition of Applications.

See Also:
Constant Field Values
Constructor Detail

StructItemInfo

public StructItemInfo()

StructItemInfo

public StructItemInfo(IARPersistentObject obj)

StructItemInfo

public StructItemInfo(IARPersistentObject obj,
                      boolean asXml)

StructItemInfo

public StructItemInfo(int type,
                      String name)

StructItemInfo

public StructItemInfo(int type,
                      String name,
                      String[] selectedElements,
                      int exportOption)

StructItemInfo

public StructItemInfo(int type,
                      String name,
                      String[] selectedElements)
Method Detail

getType

public int getType()
Returns integer value indicating the type of AR System object. Types include the following:


getName

public String getName()
Returns name associated with the AR System object.


getExportOption

public int getExportOption()
Returns export options associated with the AR System object.


getSelectedElements

public String[] getSelectedElements()
Returns list of selected elements.


setName

public void setName(String name)
Sets the name of the AR System object

Parameters:
name - New name to use

setExportOption

public void setExportOption(int exportOption)
Sets the export option of the AR System object

Parameters:
exportOption - New export option to use

setSelectedElements

public void setSelectedElements(String[] elements)
Sets the list of selected elements

Parameters:
elements - List of elements

setType

public void setType(int type)
Sets the type of the AR System object

Parameters:
type - Type to set

toString

public String toString()
Returns a string description of the object.

Overrides:
toString in class Object

hashCode

public int hashCode()
Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:
hashCode in class Object
Returns:
returns the hash code for this instance

equals

public boolean equals(Object obj)
Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Overrides:
equals in class Object
Parameters:
obj - the object that we are comparing to
Returns:
returns a boolean that tells if the two objects equal

clone

public Object clone()
             throws CloneNotSupportedException
Clone implementation that returns an Object with data cloned from self.

Overrides:
clone in class Object
Throws:
CloneNotSupportedException

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.