com.bmc.arsys.api
Class Image

java.lang.Object
  com.bmc.arsys.api.ObjectBase
      com.bmc.arsys.api.Image

All Implemented Interfaces:

IARPersistentObject, Serializable, Cloneable

public class Image
extends ObjectBase
implements IARPersistentObject, Cloneable, Serializable

The Image class and methods are used to represent the properties of AR image objects.

Note: All the constants used in the Escalation class are found in the Constants class.

See Also:

Serialized Form

Constructor Summary

Image()

Image(String name)

Image(String name, String helpText, int lastUpdateTime, String owner, String lastChangedBy, String diaryStr, String imageType, ImageData data, String description, String checkSum, ObjectPropertyMap objPropList)

Method Summary

void	clear() Clears all of the references to member objects.
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.
String	getCheckSum() Returns checkSum for image.
String	getDescription() Returns image description.
ImageData	getImageData() Returns image type.
String	getKey() Returns unique identifier for image.
ObjectPropertyMap	getProperties() Returns list of server object property tags.
String	getType() Returns image type.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setCheckSum(String checkSum) Sets the image checkSum.
void	setDescription(String description) Sets image description.
void	setImageData(ImageData data) Sets the image data.
void	setKey(String key) Sets unique identifier for image.
void	setProperties(ObjectPropertyMap objPropList) Sets list of server object property tags you can specify.
void	setType(String type) Sets the image type.
String	toString() Returns a string description of the object.

Methods inherited from class com.bmc.arsys.api.ObjectBase

appendDiaryText, getChangeFlags, getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, setChangeFlags, setDiary, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner, setPermissions

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.bmc.arsys.api.IARPersistentObject

appendDiaryText, getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner, setPermissions

Constructor Detail

Image

public Image()

Image

public Image(String name)

Image

public Image(String name,
             String helpText,
             int lastUpdateTime,
             String owner,
             String lastChangedBy,
             String diaryStr,
             String imageType,
             ImageData data,
             String description,
             String checkSum,
             ObjectPropertyMap objPropList)

Method Detail

clear

public void clear()

Description copied from class: ObjectBase

Clears all of the references to member objects.

Overrides:

clear in class ObjectBase

getType

public String getType()

Returns image type.

setType

public void setType(String type)

Sets the image type.

getImageData

public ImageData getImageData()

Returns image type.

getCheckSum

public String getCheckSum()

Returns checkSum for image.

setCheckSum

public void setCheckSum(String checkSum)

Sets the image checkSum.

setDescription

public void setDescription(String description)

Sets image description.

getProperties

public ObjectPropertyMap getProperties()

Returns list of server object property tags.

setImageData

public void setImageData(ImageData data)

Sets the image data.

getDescription

public String getDescription()

Returns image description.

setProperties

public void setProperties(ObjectPropertyMap objPropList)

Sets list of server object property tags you can specify. The constant values listed below are defined by AR System:

• Constants.AR_OPROP_VENDOR_NAME: (CHAR): Indicates the vendor name. For example, " BMC Software."
• Constants.AR_OPROP_VENDOR_PRODUCT: (CHAR): Indicates the product name. For example, " AR System."
• Constants.AR_OPROP_VENDOR_VERSION: (CHAR): Indicates the vendor version. For example, " 6.0"
• Constants.AR_OPROP_GUID: (CHAR): Indicates the globally unique identifier for the object.
• Constants.AR_OPROP_COPYRIGHT: (CHAR): Indicates the copyright string.
• Constants.AR_OPROP_SCC_LOCKED_BY:(CHAR): Indicates the name of user who has locked the object.
• Constants.AR_OPROP_SCC_VERSION: (CHAR): Indicates the version of the Source Code Control (SCC) system.
• Constants.AR_OPROP_SCC_TIMESTAMP: (TIME): Indicates the SCC timestamp.
• Constants.AR_OPROP_SCC_USER: (CHAR): Indicates the SCC username.
• Constants.AR_OPROP_SCC_LOCATION: (CHAR): Indicates the location within the SCC system where the object may be found.
• Constants.AR_OPROP_SCC_DATA_LOCKED_BY: (CHAR): Indicates the name of the user who has "locked" the data or entries stored in a form under revision control. The AR System server does not enforce this lock and thus it is to be considered an advisory lock only.
• Constants.AR_OPROP_SCC_DATA_VERSION: (CHAR): Indicates the SCC version of the data or entries stored in a form under revision control.
• Constants.AR_OPROP_SCC_DATA_TIMESTAMP: (CHAR): Indicates the SCC timestamp of the data or entries stored in a form under revision control.
• Constants.AR_OPROP_SCC_DATA_USER: (TIME): Indicates the SCC username for the data or entries stored in a form under revision control.
• Constants.AR_OPROP_SCC_DATA_LOCATION: (CHAR): Indicates the location within the SCC system where the data or entries stored in a form under revision control.

getKey

public String getKey()

Returns unique identifier for image.

setKey

public void setKey(String key)

Sets unique identifier for image.

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self.

Overrides:

clone in class ObjectBase

Throws:

CloneNotSupportedException

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 ObjectBase

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal

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 ObjectBase

Returns:

returns the hash code for this instance

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class ObjectBase