wt.doc
Class WTDocumentMaster

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Master
          wt.doc.WTDocumentMaster

All Implemented Interfaces:

Externalizable, Serializable, Document, DocumentMaster, wt.fc.BusinessInformation, Identified, NetFactor, ObjectMappable, Persistable, UniquelyIdentified, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, wt.iba.value.IBAHolder, DisplayIdentification, WTContained, WTContainedIdentified, wt.org.electronicIdentity.ElectronicallySignable, OrganizationOwned, OrganizationOwnedImpl, OrganizationOwnedMaster, wt.recent.RecentlyVisited, wt.representation.RepresentableMaster, wt.representation.RepresentablesAndMasters, wt.ufid.Federatable, Mastered

Direct Known Subclasses:

ProxyDocumentMaster

public class WTDocumentMaster
extends Master
implements DocumentMaster, UniquelyIdentified, wt.ufid.Federatable, wt.iba.value.IBAHolder, WTContained, OrganizationOwnedMaster, WTContainedIdentified, wt.representation.RepresentableMaster, Externalizable

Reference implementation of DocumentMaster. Attributes defined on this object have the same value across all versions and iterations. In this case, all document versions have the same name and number. The document number must be unique amongst all WTDocuments. A WTDocumentMaster holds a type attribute based on the DocumentType enumeration. The type is constant for all versions.

Use the newWTDocumentMaster static factory method(s), not the WTDocumentMaster constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: true

See Also:

WTDocument, DocumentType, Serialized Form

Field Summary

static String	DOC_TYPE Label for the attribute.
static String	NAME Label for the attribute; A string representing the name of a document.
static String	NUMBER Label for the attribute; A string representing the number of a document.

Fields inherited from interface wt.org.OrganizationOwnedImpl

ORGANIZATION_REFERENCE

Fields inherited from interface wt.org.OrganizationOwned

ORGANIZATION, ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Method Summary

DocumentType	getDocType() Gets the object for the association that plays role: DOC_TYPE.
String	getName() Gets the value of the attribute: NAME.
String	getNumber() Gets the value of the attribute: NUMBER.
WTOrganization	getOrganization() Gets the value of the attribute: ORGANIZATION.
String	getOrganizationCodingSystem() Gets the value of the attribute: ORGANIZATION_CODING_SYSTEM.
String	getOrganizationName() Gets the value of the attribute: ORGANIZATION_NAME.
WTPrincipalReference	getOrganizationReference() Gets the value of the attribute: ORGANIZATION_REFERENCE.
String	getOrganizationUniqueIdentifier() Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER.
void	setDocType(DocumentType a_DocType) Sets the object for the association that plays role: DOC_TYPE.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setNumber(String a_Number) Sets the value of the attribute: NUMBER.
void	setOrganization(WTOrganization a_Organization) Sets the value of the attribute: ORGANIZATION.
void	setOrganizationReference(WTPrincipalReference a_OrganizationReference) Sets the value of the attribute: ORGANIZATION_REFERENCE.

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NAME

public static final String NAME

Label for the attribute; A string representing the name of a document.

Supported API: true

See Also:

Constant Field Values

NUMBER

public static final String NUMBER

Label for the attribute; A string representing the number of a document.

Supported API: true

See Also:

Constant Field Values

DOC_TYPE

public static final String DOC_TYPE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getName

public String getName()

Gets the value of the attribute: NAME. A string representing the name of a document.

Supported API: true

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. A string representing the name of a document.

Supported API: true

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getNumber

public String getNumber()

Gets the value of the attribute: NUMBER. A string representing the number of a document.

Supported API: true

Returns:

String

setNumber

public void setNumber(String a_Number)
               throws WTPropertyVetoException

Sets the value of the attribute: NUMBER. A string representing the number of a document.

Supported API: true

Parameters:

a_Number -

Throws:

WTPropertyVetoException

getDocType

public DocumentType getDocType()

Gets the object for the association that plays role: DOC_TYPE.

Supported API: true

Returns:

DocumentType

setDocType

public void setDocType(DocumentType a_DocType)
                throws WTPropertyVetoException

Sets the object for the association that plays role: DOC_TYPE.

Supported API: true

Parameters:

a_DocType -

Throws:

WTPropertyVetoException

getOrganizationReference

public WTPrincipalReference getOrganizationReference()

Gets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: true

Specified by:

getOrganizationReference in interface OrganizationOwned

Specified by:

getOrganizationReference in interface OrganizationOwnedImpl

Returns:

WTPrincipalReference

setOrganizationReference

public void setOrganizationReference(WTPrincipalReference a_OrganizationReference)
                              throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: true

Parameters:

a_OrganizationReference -

Throws:

WTPropertyVetoException

getOrganizationUniqueIdentifier

public String getOrganizationUniqueIdentifier()

Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER. The getter for this attribute delivers organization unique identifier.

Supported API: true

Specified by:

getOrganizationUniqueIdentifier in interface OrganizationOwned

Returns:

String

getOrganizationCodingSystem

public String getOrganizationCodingSystem()

Gets the value of the attribute: ORGANIZATION_CODING_SYSTEM. The getter for this attribute delivers organization coding system.

Supported API: true

Specified by:

getOrganizationCodingSystem in interface OrganizationOwned

Returns:

String

getOrganizationName

public String getOrganizationName()

Gets the value of the attribute: ORGANIZATION_NAME. The getter for this attribute delivers organization name.

Supported API: true

Specified by:

getOrganizationName in interface OrganizationOwned

Returns:

String

getOrganization

public WTOrganization getOrganization()

Gets the value of the attribute: ORGANIZATION.

Supported API: true

Specified by:

getOrganization in interface OrganizationOwned

Returns:

WTOrganization

setOrganization

public void setOrganization(WTOrganization a_Organization)
                     throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION.

Supported API: true

Parameters:

a_Organization -

Throws:

WTPropertyVetoException