com.bmc.arsys.api

Class Reference

java.lang.Object

com.bmc.arsys.api.Reference

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ExternalReference

public class Reference
extends Object
implements Serializable, Cloneable

Reference is used to set and return the objects referenced by a container.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Reference()
Reference(String label, String description, ReferenceType refType, String name)

Method Summary

Modifier and Type	Method and Description
Object	clone() Makes a deep copy of the object.
boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
String	getDescription() Returns a string specifying a display-only description for the reference.
String	getLabel() Returns a string specifying a display-only label for the reference.
String	getName() Returns name of object.
ReferenceType	getReferenceType() Returns union that defines either an internal or external reference depending on its datatype,which is either 0 (Constants.ARREF_DATA_ARSREF) or 1 (Constants.ARREF_DATA_EXTREF).
int	hashCode() Returns the hash code value for this instance of the current class.
void	setDescription(String desc) Sets a character string specifying a display-only description for the reference.
void	setLabel(String label) Sets a character string specifying a display-only label for the reference.
void	setName(String name) Sets name of object.
void	setReferenceType(ReferenceType type)
String	toString() Returns a string description of the object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Reference

public Reference()

Reference

public Reference(String label,
                 String description,
                 ReferenceType refType,
                 String name)

Method Detail

clone

public Object clone()
             throws CloneNotSupportedException

Makes a deep copy of the object.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getLabel

public String getLabel()

Returns a string specifying a display-only label for the reference.

setLabel

public void setLabel(String label)

Sets a character string specifying a display-only label for the reference. Its length is limited by Constants.ARMAX_CON_LABEL_LEN (255 bytes).

getDescription

public String getDescription()

Returns a string specifying a display-only description for the reference.

setDescription

public void setDescription(String desc)

Sets a character string specifying a display-only description for the reference. Its length is limited by Constants.ARMAX_CON_DESCRIPTION_LEN (2000 bytes).

getReferenceType

public ReferenceType getReferenceType()

Returns union that defines either an internal or external reference depending on its datatype,which is either 0 (Constants.ARREF_DATA_ARSREF) or 1 (Constants.ARREF_DATA_EXTREF).

setReferenceType

public void setReferenceType(ReferenceType type)

getName

public String getName()

Returns name of object.

setName

public void setName(String name)

Sets name of object.

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

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

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Object