com.bmc.arsys.api
Class ContainerOwner

java.lang.Object
  com.bmc.arsys.api.ContainerOwner

All Implemented Interfaces:

Serializable, Cloneable

public class ContainerOwner
extends Object
implements Cloneable, Serializable

The ContainerOwner class lets you set or get the container owner type, as well as the name of the form, if the owner type is a form.

See Also:

Serialized Form

Field Summary

static int	ALL All containers, owned and unowned ones.
static int	NONE containers globally owned (not owned by any object)
static int	SCHEMA containers owned by a form.

Constructor Summary

ContainerOwner()

ContainerOwner(int type)
construct a container owner object with the provided owner type.

ContainerOwner(int type, String name)
construct a container owner object with the provided owner type and name

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.
String	getName() Returns the name of the form that owns the container.
int	getType() Returns the container owner type.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setName(String name) Sets the name of the form that owns the container.
void	setType(int nType) Sets the owner type.
String	toString() Returns a string description of the object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

NONE

public static final int NONE

containers globally owned (not owned by any object)

See Also:

Constant Field Values

ALL

public static final int ALL

All containers, owned and unowned ones.

See Also:

Constant Field Values

SCHEMA

public static final int SCHEMA

containers owned by a form.

See Also:

Constant Field Values

Constructor Detail

ContainerOwner

public ContainerOwner(int type)

construct a container owner object with the provided owner type.

ContainerOwner

public ContainerOwner()

ContainerOwner

public ContainerOwner(int type,
                      String name)

construct a container owner object with the provided owner type and name

Parameters:

type - the owner type

name - the name of the form that owns the container

Method Detail

clone

public Object clone()
             throws CloneNotSupportedException

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

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getType

public int getType()

Returns the container owner type.

getName

public String getName()

Returns the name of the form that owns the container.

setName

public void setName(String name)

Sets the name of the form that owns the container.

setType

public void setType(int nType)

Sets the owner type.

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