com.bmc.arsys.api

Class FileMenu

java.lang.Object

com.bmc.arsys.api.ObjectBase

com.bmc.arsys.api.Menu

com.bmc.arsys.api.FileMenu

All Implemented Interfaces:

IARPersistentObject, Serializable, Cloneable

public class FileMenu
extends Menu
implements Cloneable, Serializable

The FileMenu class returns information for file menu based on formatted flat file.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileMenu()
FileMenu(int location, String name)

Method Summary

Modifier and Type	Method and Description
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	getFileName() Returns name of file.
int	getLocation() Returns whether file is located on client or server.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setFileName(String name)
void	setLocation(int location)
String	toString() Returns a string description of the object.

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

getContent, getKey, getMenuType, getProperties, getRefreshCode, setContent, setKey, setProperties, setRefreshCode

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

appendDiaryText, clear, 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

Constructor Detail

FileMenu

public FileMenu()

FileMenu

public FileMenu(int location,
                String name)

Method Detail

clone

public Object clone()
             throws CloneNotSupportedException

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

Overrides:

clone in class Menu

Throws:

CloneNotSupportedException

getLocation

public int getLocation()

Returns whether file is located on client or server. You can return the following constant values:

• Constants.AR_MENU_FILE_SERVER -- 1
• Constants.AR_MENU_FILE_CLIENT -- 2

getFileName

public String getFileName()

Returns name of file.

setFileName

public void setFileName(String name)

setLocation

public void setLocation(int location)

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 Menu

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 Menu

Returns:

returns the hash code for this instance

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Menu