org.maverickdbms.basic
Interface File

All Superinterfaces:
Variable
All Known Subinterfaces:
DictionaryFile

public interface File
extends Variable

File provides arepresentation of a MV type file.


Field Summary
static int READ_ONLY
           
static ConstantString TYPE_DATA
           
static ConstantString TYPE_DICT
           
static ConstantString TYPE_DICT_DICT
           
 
Method Summary
 ConstantString CLEARFILE(Program program, mvString status, boolean locked)
           
 ConstantString CLOSE(Program program, mvString status)
           
 ConstantString DELETE(Program program, ConstantString record, mvString status, boolean locked)
           
 ConstantString DELETEU(Program program, ConstantString record, mvString status, boolean locked)
           
 mvString FILEINFO(mvString result, ConstantString code, mvString status)
           
 ConstantString MATREAD(Array var, ConstantString record, boolean overflowLast, mvString status)
          Read the item into the specified array
 ConstantString MATREADU(Program program, Array var, ConstantString record, boolean overflowLast, mvString status, boolean locked)
           
 ConstantString MATWRITE(Program program, Array var, ConstantString record, mvString status, boolean locked)
           
 ConstantString READ(mvString var, ConstantString record, mvString status)
           
 ConstantString READT(mvString var, ConstantString record)
           
 ConstantString READU(Program program, mvString var, ConstantString record, mvString status, boolean locked)
           
 ConstantString READV(mvString var, ConstantString record, ConstantString attribute, mvString status)
           
 ConstantString READVU(Program program, mvString status, ConstantString record, ConstantString attribute, mvString var, boolean locked)
           
 void RELEASE(Program program, ConstantString record, mvString status)
           
 void RELEASE(Program program, mvString status)
           
 void SELECT(Program program, mvString var, Key key)
           
 ConstantString WRITE(Program program, ConstantString var, ConstantString record, mvString status, boolean locked)
           
 ConstantString WRITET(ConstantString var, ConstantString record)
           
 ConstantString WRITEU(Program program, ConstantString var, ConstantString record, mvString status, boolean locked)
           
 ConstantString WRITEV(Program program, ConstantString var, ConstantString record, ConstantString attrib, mvString status, boolean locked)
           
 ConstantString WRITEVU(Program program, ConstantString var, ConstantString record, ConstantString attrib, mvString status, boolean locked)
           
 

Field Detail

TYPE_DATA

public static final ConstantString TYPE_DATA

TYPE_DICT

public static final ConstantString TYPE_DICT

TYPE_DICT_DICT

public static final ConstantString TYPE_DICT_DICT

READ_ONLY

public static final int READ_ONLY
See Also:
Constant Field Values
Method Detail

CLEARFILE

public ConstantString CLEARFILE(Program program,
                                mvString status,
                                boolean locked)
                         throws LockedException,
                                mvException
Throws:
LockedException
mvException

CLOSE

public ConstantString CLOSE(Program program,
                            mvString status)
                     throws mvException
Throws:
mvException

DELETE

public ConstantString DELETE(Program program,
                             ConstantString record,
                             mvString status,
                             boolean locked)
                      throws LockedException,
                             mvException
Throws:
LockedException
mvException

DELETEU

public ConstantString DELETEU(Program program,
                              ConstantString record,
                              mvString status,
                              boolean locked)
                       throws LockedException,
                              mvException
Throws:
LockedException
mvException

FILEINFO

public mvString FILEINFO(mvString result,
                         ConstantString code,
                         mvString status)
                  throws mvException
Throws:
mvException

MATREAD

public ConstantString MATREAD(Array var,
                              ConstantString record,
                              boolean overflowLast,
                              mvString status)
                       throws mvException
Read the item into the specified array

Parameters:
var - the array to read into
record - the record in the file
overflowLast - if the item is too large whether to overflow into the last record.
status - variable to store status of operation.
Returns:
whether the record was successfully read.
Throws:
mvException

MATREADU

public ConstantString MATREADU(Program program,
                               Array var,
                               ConstantString record,
                               boolean overflowLast,
                               mvString status,
                               boolean locked)
                        throws LockedException,
                               mvException
Throws:
LockedException
mvException

MATWRITE

public ConstantString MATWRITE(Program program,
                               Array var,
                               ConstantString record,
                               mvString status,
                               boolean locked)
                        throws LockedException,
                               mvException
Throws:
LockedException
mvException

READ

public ConstantString READ(mvString var,
                           ConstantString record,
                           mvString status)
                    throws mvException
Throws:
mvException

READT

public ConstantString READT(mvString var,
                            ConstantString record)
                     throws mvException
Throws:
mvException

READU

public ConstantString READU(Program program,
                            mvString var,
                            ConstantString record,
                            mvString status,
                            boolean locked)
                     throws LockedException,
                            mvException
Throws:
LockedException
mvException

READV

public ConstantString READV(mvString var,
                            ConstantString record,
                            ConstantString attribute,
                            mvString status)
                     throws mvException
Throws:
mvException

READVU

public ConstantString READVU(Program program,
                             mvString status,
                             ConstantString record,
                             ConstantString attribute,
                             mvString var,
                             boolean locked)
                      throws LockedException,
                             mvException
Throws:
LockedException
mvException

RELEASE

public void RELEASE(Program program,
                    mvString status)
             throws mvException
Throws:
mvException

RELEASE

public void RELEASE(Program program,
                    ConstantString record,
                    mvString status)
             throws mvException
Throws:
mvException

SELECT

public void SELECT(Program program,
                   mvString var,
                   Key key)
            throws mvException
Throws:
mvException

WRITE

public ConstantString WRITE(Program program,
                            ConstantString var,
                            ConstantString record,
                            mvString status,
                            boolean locked)
                     throws LockedException,
                            mvException
Throws:
LockedException
mvException

WRITET

public ConstantString WRITET(ConstantString var,
                             ConstantString record)
                      throws mvException
Throws:
mvException

WRITEU

public ConstantString WRITEU(Program program,
                             ConstantString var,
                             ConstantString record,
                             mvString status,
                             boolean locked)
                      throws LockedException,
                             mvException
Throws:
LockedException
mvException

WRITEV

public ConstantString WRITEV(Program program,
                             ConstantString var,
                             ConstantString record,
                             ConstantString attrib,
                             mvString status,
                             boolean locked)
                      throws LockedException,
                             mvException
Throws:
LockedException
mvException

WRITEVU

public ConstantString WRITEVU(Program program,
                              ConstantString var,
                              ConstantString record,
                              ConstantString attrib,
                              mvString status,
                              boolean locked)
                       throws LockedException,
                              mvException
Throws:
LockedException
mvException