Package com.dassault_systemes.catweb.documents

   
Class DocumentV4

 
Class Hierarchy
java.lang.Object
  |
  +-com.dassault_systemes.catweb.documents.Document
        |
        +-com.dassault_systemes.catweb.documents.DocumentV4
Class Location

Framework : PortalBase

Module : PLBdocuments

Class Description

public class DocumentV4

This class represents a V4 document. Such documents can represent any kind of V4 data (model, session).
They are defined by a pathName.
an UUID
a mnum setted when the model is loaded into memory
a jmodelo also setted when loaded
DocumentV4 extends @see com.dassault_systemes.catweb.documents.Document

Field Summary
protected int jmodelo
The jmodelo of the V4 document.
protected int mnum
The mnum of the V4 document.
protected DocumentV4 session
The session of this V4 document.

Constructor Summary
DocumentV4()
The default constructor.
DocumentV4(byte[] _uuid, String _name, int _mnum, int _jmodelo)
Constructor with specific V4 document parameters.
DocumentV4(DocumentV4 d)
Copy Constructor
DocumentV4(String name)
Constructor with the document V4 name
DocumentV4(byte[] uuid, String name)
Constructor with the documenat uuid and the name.

Method Summary
public void copy(DocumentV4 d)
Copy the specify document in the current instance document.
public Document duplicate()
a copy of this object.
public int getJmodelo()
Returns the jmodelo of the document
public int getMnum()
Returns the mnum of the document
public DocumentV4 getSession()
Returns the associated session.
public boolean isASession()
public boolean isInASession()
public boolean isLoaded()
Test if the document is loaded.
public void setJmodelo(int jmodelo)
Sets the jmodelo of the document
public void setMnum(int mnum)
Sets the mnum of the document
public void setSession(DocumentV4 _session)
Sets the associated session.


Field Detail

jmodelo

    protected int jmodelo
The jmodelo of the V4 document.


mnum

    protected int mnum
The mnum of the V4 document.


session

    protected DocumentV4 session
The session of this V4 document.


Constructor Detail

DocumentV4

    DocumentV4()

The default constructor.


DocumentV4

    DocumentV4(byte[] _uuid, String _name, int _mnum, int _jmodelo)

Constructor with specific V4 document parameters.

Parameters:
_uuid
- the uuid of the document.
_name
- the name of the document.
_mnum
- the mnum of the document.
_jmodelo
- the jmodelo of the document.

DocumentV4

    DocumentV4(DocumentV4 d)

Copy Constructor

Parameters:
d
- the DocumentV4 to copy.

DocumentV4

    DocumentV4(String name)

Constructor with the document V4 name

Parameters:
name
- the name of the document.

DocumentV4

    DocumentV4(byte[] uuid, String name)

Constructor with the documenat uuid and the name.

Parameters:
uuid
- the uuid of the document.
name
- the name of the document.

Method Detail

copy

    public void copy(DocumentV4 d)

Copy the specify document in the current instance document.


duplicate

    public Document duplicate()

a copy of this object.


getJmodelo

    public int getJmodelo()

Returns the jmodelo of the document


getMnum

    public int getMnum()

Returns the mnum of the document


getSession

    public DocumentV4 getSession()

Returns the associated session.


isASession

    public boolean isASession()


isInASession

    public boolean isInASession()


isLoaded

    public boolean isLoaded()

Test if the document is loaded. Returns false if the mnum and the jmodelo are equals to 0, otherwise returns true.


setJmodelo

    public void setJmodelo(int jmodelo)

Sets the jmodelo of the document


setMnum

    public void setMnum(int mnum)

Sets the mnum of the document


setSession

    public void setSession(DocumentV4 _session)

Sets the associated session.



Copyright © 2000, Dassault Systèmes. All rights reserved