com.bmc.arsys.api
Class AttachmentFieldLimit

java.lang.Object
  com.bmc.arsys.api.FieldLimit
      com.bmc.arsys.api.AttachmentFieldLimit

All Implemented Interfaces:

Serializable, Cloneable

public class AttachmentFieldLimit
extends FieldLimit
implements Cloneable, Serializable

The AttachmentFieldLimit class defines the value limits for an attachment field (DataType.ATTACHMENT).

See Also:

Serialized Form

Constructor Summary

AttachmentFieldLimit()

AttachmentFieldLimit(int max, int type)
Constructs a new AttachmentLimitInfo object, defaulting the full text option to none (Constants.AR_FULLTEXT_OPTIONS_NONE).

AttachmentFieldLimit(int max, int type, int option)
Constructs a new AttachmentLimitInfo object, allowing the specification of a full text option.

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	getAttachType() Returns the attachment type
int	getFullTextOption() Returns the full text option
int	getMaxSize() Returns the maximum attachment size
int	hashCode() Returns the hash code value for this instance of the current class.
void	setAttachType(int type) Sets the attachment type
void	setFullTextOption(int option) Sets the full text option
void	setMaxSize(int max) Sets the maximum attachment size
String	toString() Returns a string description of the object.

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

getDataType

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AttachmentFieldLimit

public AttachmentFieldLimit()

AttachmentFieldLimit

public AttachmentFieldLimit(int max,
                            int type)

Constructs a new AttachmentLimitInfo object, defaulting the full text option to none (Constants.AR_FULLTEXT_OPTIONS_NONE).

Parameters:

max - Maximum size of the attachment.

type - Type of the attachment -- embedded (Constants.AR_ATTACH_FIELD_TYPE_EMBED) is the only type supported at this time.

AttachmentFieldLimit

public AttachmentFieldLimit(int max,
                            int type,
                            int option)

Constructs a new AttachmentLimitInfo object, allowing the specification of a full text option.

Parameters:

max - Maximum size of the attachment.

type - Type of the attachment -- embedded (Constants.AR_ATTACH_FIELD_TYPE_EMBED) is the only type supported at this time.

option - Full text option -- none Constants.AR_FULLTEXT_OPTIONS_NONE or indexed (Constants.AR_FULLTEXT_OPTIONS_INDEXED)

Method Detail

setMaxSize

public void setMaxSize(int max)

Sets the maximum attachment size

setAttachType

public void setAttachType(int type)

Sets the attachment type

setFullTextOption

public void setFullTextOption(int option)

Sets the full text option

getMaxSize

public int getMaxSize()

Returns the maximum attachment size

getAttachType

public int getAttachType()

Returns the attachment type

getFullTextOption

public int getFullTextOption()

Returns the full text option

clone

public Object clone()
             throws CloneNotSupportedException

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

Overrides:

clone in class FieldLimit

Throws:

CloneNotSupportedException

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class FieldLimit

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 FieldLimit

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 FieldLimit

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal